Skip to content

Commit

Permalink
📝: update api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
junerver committed Mar 7, 2024
1 parent 7e5a031 commit cfb6249
Show file tree
Hide file tree
Showing 15 changed files with 808 additions and 107 deletions.
9 changes: 9 additions & 0 deletions docs/api/hooks/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@ $dokka.location:xyz.junerver.compose.hooks.utils//depsAreSame/#kotlin.Array[kotl
$dokka.location:xyz.junerver.compose.hooks////PointingToDeclaration/hooks/xyz.junerver.compose.hooks/index.html
$dokka.location:xyz.junerver.compose.hooks//LaunchedDebounceEffect/#kotlin.Array[kotlin.Any?]#xyz.junerver.compose.hooks.DebounceOptions#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-launched-debounce-effect.html
$dokka.location:xyz.junerver.compose.hooks//LaunchedThrottleEffect/#kotlin.Array[kotlin.Any?]#xyz.junerver.compose.hooks.ThrottleOptions#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-launched-throttle-effect.html
$dokka.location:xyz.junerver.compose.hooks//_useState/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/_use-state.html
$dokka.location:xyz.junerver.compose.hooks//asAction/kotlin.Any#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/as-action.html
$dokka.location:xyz.junerver.compose.hooks//asAction/kotlin.Pair[kotlin.Any,kotlin.Any?]#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/as-action.html
$dokka.location:xyz.junerver.compose.hooks//asNoopFn/kotlin.reflect.KFunction[TypeParam(bounds=[kotlin.Any?])?]#kotlin.Any?/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/as-noop-fn.html
Expand Down Expand Up @@ -281,13 +282,21 @@ $dokka.location:xyz.junerver.compose.hooks//useCreation/#kotlin.Array[kotlin.Any
$dokka.location:xyz.junerver.compose.hooks//useDebounce/#TypeParam(bounds=[kotlin.Any?])#xyz.junerver.compose.hooks.DebounceOptions/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-debounce.html
$dokka.location:xyz.junerver.compose.hooks//useDebounceEffect/#kotlin.Array[kotlin.Any?]#xyz.junerver.compose.hooks.DebounceOptions#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-debounce-effect.html
$dokka.location:xyz.junerver.compose.hooks//useDebounceFn/#kotlin.Function1[kotlin.Array[kotlin.Any?],kotlin.Unit]#xyz.junerver.compose.hooks.DebounceOptions/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-debounce-fn.html
$dokka.location:xyz.junerver.compose.hooks//useDouble/#kotlin.Double/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-double.html
$dokka.location:xyz.junerver.compose.hooks//useEffect/#kotlin.Array[kotlin.Any]#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-effect.html
$dokka.location:xyz.junerver.compose.hooks//useFloat/#kotlin.Float/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-float.html
$dokka.location:xyz.junerver.compose.hooks//useInt/#kotlin.Int/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-int.html
$dokka.location:xyz.junerver.compose.hooks//useIntState/#kotlin.Int/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-int-state.html
$dokka.location:xyz.junerver.compose.hooks//useInterval/#kotlin.Function0[kotlin.Unit]#xyz.junerver.compose.hooks.IntervalOptions/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-interval.html
$dokka.location:xyz.junerver.compose.hooks//useLatestRef/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-latest-ref.html
$dokka.location:xyz.junerver.compose.hooks//useLatestState/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-latest-state.html
$dokka.location:xyz.junerver.compose.hooks//useList/#kotlin.Array[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-list.html
$dokka.location:xyz.junerver.compose.hooks//useList/#kotlin.collections.Collection[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-list.html
$dokka.location:xyz.junerver.compose.hooks//useListState/#kotlin.Array[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-list-state.html
$dokka.location:xyz.junerver.compose.hooks//useListState/#kotlin.collections.Collection[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-list-state.html
$dokka.location:xyz.junerver.compose.hooks//useLong/#kotlin.Long/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-long.html
$dokka.location:xyz.junerver.compose.hooks//useMap/#kotlin.Array[kotlin.Pair[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-map.html
$dokka.location:xyz.junerver.compose.hooks//useMap/#kotlin.collections.Iterable[kotlin.Pair[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-map.html
$dokka.location:xyz.junerver.compose.hooks//useMapState/#kotlin.Array[kotlin.Pair[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-map-state.html
$dokka.location:xyz.junerver.compose.hooks//useMapState/#kotlin.collections.Iterable[kotlin.Pair[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-map-state.html
$dokka.location:xyz.junerver.compose.hooks//useMount/#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/use-mount.html
Expand Down
80 changes: 80 additions & 0 deletions docs/api/hooks/xyz.junerver.compose.hooks/_use-state.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>_useState</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../index.html">
hooks
</a>
</div>
<div class="library-version">
</div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":hooks:dokkaHtml/release">androidJvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="hooks::xyz.junerver.compose.hooks//_useState/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration//1917587792">
<div class="breadcrumbs"><a href="../../index.html">hooks</a><span class="delimiter">/</span><a href="index.html">xyz.junerver.compose.hooks</a><span class="delimiter">/</span><span class="current">_useState</span></div>
<div class="cover ">
<h1 class="cover"><span>_use</span><wbr></wbr><span><span>State</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="_use-state.html">T</a><span class="token operator">&gt; </span><a href="_use-state.html"><span class="token function">_useState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">default<span class="token operator">: </span><a href="_use-state.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="xyz.junerver.kotlin/Tuple2///PointingToDeclaration/">Tuple2</span><span class="token operator">&lt;</span><a href="_use-state.html">T</a><span class="token punctuation">, </span><span class="token punctuation">(</span><a href="_use-state.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">&gt;</span></div><p class="paragraph">这是一个可空的<a href="use-state.html">useState</a>,如果对象的状态可能为空,应该使用它</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>
Loading

0 comments on commit cfb6249

Please sign in to comment.