@zthun/helpful-web 6.2.0 → 6.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/icons.js +1 -1
- package/dist/assets/icons.svg +1 -1
- package/dist/assets/main.js +1 -1
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +66 -21
- package/dist/classes/_zthun_helpful_brands.ZBrandBuilder.html +44 -44
- package/dist/classes/_zthun_helpful_fn.ZAssert.html +6 -6
- package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +5 -5
- package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +5 -5
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +12 -12
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +14 -14
- package/dist/classes/_zthun_helpful_fn.ZRectangle.html +26 -17
- package/dist/classes/_zthun_helpful_fn.ZSerializeJson.html +3 -3
- package/dist/classes/_zthun_helpful_internet.ZCookieBuilder.html +17 -17
- package/dist/classes/_zthun_helpful_internet.ZEmailBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_internet.ZEmailContactAddressBuilder.html +6 -6
- package/dist/classes/_zthun_helpful_internet.ZEmailContactBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_internet.ZEmailEnvelopeBuilder.html +13 -13
- package/dist/classes/_zthun_helpful_internet.ZServerBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataMatchAlways.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZDataRequestBuilder.html +11 -11
- package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZDataSearchText.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +15 -15
- package/dist/classes/_zthun_helpful_query.ZFilterCollectionBuilder.html +11 -11
- package/dist/classes/_zthun_helpful_query.ZFilterDeserialize.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZFilterLogicBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZFilterSerialize.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZFilterUnaryBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_query.ZMetadataBuilder.html +23 -23
- package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZSortBuilder.html +8 -8
- package/dist/classes/_zthun_helpful_query.ZSortDeserialize.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZSorterSingle.html +6 -6
- package/dist/classes/_zthun_helpful_query.ZWellKnownIconClasses.html +11 -11
- package/dist/classes/_zthun_helpful_react.ZFileSelect.html +4 -4
- package/dist/classes/_zthun_helpful_validation.EqualsOtherPropertyValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.IsDataURILimitValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.IsNotWhiteSpaceValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.RequiresOtherPropertyValidator.html +3 -3
- package/dist/enums/_zthun_helpful_fn.ZHorizontalAnchor.html +6 -6
- package/dist/enums/_zthun_helpful_fn.ZOrientation.html +5 -5
- package/dist/enums/_zthun_helpful_fn.ZVerticalAnchor.html +6 -6
- package/dist/enums/_zthun_helpful_query.ZMetadataType.html +9 -9
- package/dist/enums/_zthun_helpful_query.ZOperatorBinary.html +10 -10
- package/dist/enums/_zthun_helpful_query.ZOperatorCollection.html +5 -5
- package/dist/enums/_zthun_helpful_query.ZOperatorLogic.html +5 -5
- package/dist/enums/_zthun_helpful_query.ZOperatorUnary.html +5 -5
- package/dist/enums/_zthun_helpful_query.ZSortDirection.html +5 -5
- package/dist/functions/_zthun_helpful_fn.bash.html +3 -3
- package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.countBuckets.html +3 -3
- package/dist/functions/_zthun_helpful_fn.createError.html +3 -3
- package/dist/functions/_zthun_helpful_fn.createGuid.html +4 -4
- package/dist/functions/_zthun_helpful_fn.css.html +3 -3
- package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.firstDefined.html +3 -3
- package/dist/functions/_zthun_helpful_fn.firstTruthy.html +3 -3
- package/dist/functions/_zthun_helpful_fn.firstWhere.html +2 -2
- package/dist/functions/_zthun_helpful_fn.html.html +3 -3
- package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +9 -0
- package/dist/functions/_zthun_helpful_fn.javascript.html +3 -3
- package/dist/functions/_zthun_helpful_fn.joinDefined.html +3 -3
- package/dist/functions/_zthun_helpful_fn.js.html +3 -3
- package/dist/functions/_zthun_helpful_fn.markdown.html +3 -3
- package/dist/functions/_zthun_helpful_fn.md.html +3 -3
- package/dist/functions/_zthun_helpful_fn.optional.html +8 -8
- package/dist/functions/_zthun_helpful_fn.peel.html +2 -2
- package/dist/functions/_zthun_helpful_fn.peelBetween.html +3 -3
- package/dist/functions/_zthun_helpful_fn.pickBy.html +7 -0
- package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +5 -0
- package/dist/functions/_zthun_helpful_fn.pickDefined.html +5 -0
- package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.required.html +3 -3
- package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.setFirst.html +3 -3
- package/dist/functions/_zthun_helpful_fn.sh.html +3 -3
- package/dist/functions/_zthun_helpful_fn.sleep.html +7 -7
- package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.tag.html +3 -3
- package/dist/functions/_zthun_helpful_fn.tryFallback.html +7 -7
- package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +7 -7
- package/dist/functions/_zthun_helpful_fn.ts.html +3 -3
- package/dist/functions/_zthun_helpful_fn.typescript.html +3 -3
- package/dist/functions/_zthun_helpful_fn.zsh.html +3 -3
- package/dist/functions/_zthun_helpful_node.walk.html +3 -3
- package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isLogicFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isLogicOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful_react.asStateData.html +8 -8
- package/dist/functions/_zthun_helpful_react.asStateError.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateErrored.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateLoaded.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateLoading.html +2 -2
- package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +9 -9
- package/dist/functions/_zthun_helpful_react.useAsyncState.html +2 -2
- package/dist/functions/_zthun_helpful_react.useFileSelect.html +2 -2
- package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +2 -2
- package/dist/functions/_zthun_helpful_react.useMoreViewState.html +2 -2
- package/dist/functions/_zthun_helpful_react.usePageViewState.html +2 -2
- package/dist/functions/_zthun_helpful_react.useStateAsArray.html +2 -2
- package/dist/functions/_zthun_helpful_react.useWindowService.html +2 -2
- package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +2 -2
- package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +2 -2
- package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +2 -2
- package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +2 -2
- package/dist/hierarchy.html +1 -1
- package/dist/index.html +2 -2
- package/dist/interfaces/_zthun_helpful_brands.IZBrand.html +7 -7
- package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +4 -4
- package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +4 -4
- package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +5 -5
- package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateral.html +6 -6
- package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +3 -3
- package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +3 -3
- package/dist/interfaces/_zthun_helpful_internet.IZCookie.html +9 -9
- package/dist/interfaces/_zthun_helpful_internet.IZEmail.html +5 -5
- package/dist/interfaces/_zthun_helpful_internet.IZEmailContact.html +5 -5
- package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +6 -6
- package/dist/interfaces/_zthun_helpful_internet.IZServer.html +6 -6
- package/dist/interfaces/_zthun_helpful_node.ZWalkOptions.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +3 -3
- package/dist/interfaces/_zthun_helpful_query.IZDataRequest.html +10 -10
- package/dist/interfaces/_zthun_helpful_query.IZDataRequestQuery.html +7 -7
- package/dist/interfaces/_zthun_helpful_query.IZDataSource.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZDataSourceStaticOptions.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZFilterBinary.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZFilterCollection.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZFilterLogic.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +3 -3
- package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZMetadata.html +13 -13
- package/dist/interfaces/_zthun_helpful_query.IZPage.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZSort.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZSorter.html +5 -5
- package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +3 -3
- package/dist/interfaces/_zthun_helpful_react.IZKeyboardInteraction.html +4 -4
- package/dist/modules/_zthun_helpful_brands.html +3 -3
- package/dist/modules/_zthun_helpful_fn.html +8 -2
- package/dist/modules/_zthun_helpful_internet.html +2 -2
- package/dist/modules/_zthun_helpful_node.html +2 -2
- package/dist/modules/_zthun_helpful_proxy.html +5 -5
- package/dist/modules/_zthun_helpful_query.html +3 -3
- package/dist/modules/_zthun_helpful_react.html +2 -2
- package/dist/modules/_zthun_helpful_validation.html +3 -3
- package/dist/modules.html +2 -0
- package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +2 -2
- package/dist/types/_zthun_helpful_fn.PickPredicate.html +2 -0
- package/dist/types/_zthun_helpful_fn.PickResult.html +2 -0
- package/dist/types/_zthun_helpful_fn.RequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful_fn.RequiredPick.html +1 -1
- package/dist/types/_zthun_helpful_fn.ZAnchor.html +4 -4
- package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +2 -2
- package/dist/types/_zthun_helpful_query.IZFilter.html +2 -2
- package/dist/types/_zthun_helpful_query.IZFilterUnary.html +2 -2
- package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +2 -2
- package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +1 -1
- package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +1 -1
- package/dist/variables/_zthun_helpful_brands.ZBrands.html +2 -2
- package/dist/variables/_zthun_helpful_fn._global.html +1 -1
- package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZSortDirections.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZFileSelectContext.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZWindowServiceContext.html +2 -2
- package/package.json +12 -12
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useAmbassadorState | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useAmbassadorState.html">useAmbassadorState</a></li></ul><h1>Function useAmbassadorState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A type of state where the value is used from the props in the case of them being set.</p>
|
|
3
3
|
<p>Otherwise, an internal set of properties are used. This is useful in the case that you
|
|
4
4
|
want to allow properties to control the state of the component, but this functionality is
|
|
5
5
|
to be optional.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: current" class="tsd-anchor"></a>Param: current<a href="#Param: current" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The current value from the props. If this is
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: current"><h4 class="tsd-anchor-link"><a id="Param: current" class="tsd-anchor"></a>Param: current<a href="#Param: current" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The current value from the props. If this is
|
|
7
7
|
undefined, then the internal state is used.</p>
|
|
8
|
-
|
|
8
|
+
</div><div class="tsd-tag-Param: setCurrent"><h4 class="tsd-anchor-link"><a id="Param: setCurrent" class="tsd-anchor"></a>Param: setCurrent<a href="#Param: setCurrent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The mutator method to set the current value. This can
|
|
9
9
|
be undefined, but if it is set, both the internal value and
|
|
10
10
|
the prop value are set.</p>
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
</div><div class="tsd-tag-Param: initial"><h4 class="tsd-anchor-link"><a id="Param: initial" class="tsd-anchor"></a>Param: initial<a href="#Param: initial" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The initial value to set if current is undefined.</p>
|
|
12
|
+
</div><div class="tsd-tag-Param: T"><h4 class="tsd-anchor-link"><a id="Param: T" class="tsd-anchor"></a>Param: T<a href="#Param: T" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The type of data for the state.</p>
|
|
13
|
+
</div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A tuple where the first item is the current state and the 2nd item is a mutator
|
|
14
14
|
method to modify the state.</p>
|
|
15
|
-
</div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useAmbassadorState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Ambassador<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">current</span>, <span class="tsd-kind-parameter">setCurrent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><a href="../types/_zthun_helpful_react.ZAmbassadorReducer.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorReducer</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useAmbassadorState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A type of state where the value is used from the props in the case of them being set.</p>
|
|
15
|
+
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useAmbassadorState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Ambassador<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">current</span>, <span class="tsd-kind-parameter">setCurrent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><a href="../types/_zthun_helpful_react.ZAmbassadorReducer.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorReducer</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useAmbassadorState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A type of state where the value is used from the props in the case of them being set.</p>
|
|
16
16
|
<p>Otherwise, an internal set of properties are used. This is useful in the case that you
|
|
17
17
|
want to allow properties to control the state of the component, but this functionality is
|
|
18
18
|
to be optional.</p>
|
|
@@ -24,7 +24,7 @@ be undefined, but if it is set, both the internal value and
|
|
|
24
24
|
the prop value are set.</p>
|
|
25
25
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol"> | </span><a href="../types/_zthun_helpful_react.ZAmbassadorReducer.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorReducer</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><p>A tuple where the first item is the current state and the 2nd item is a mutator
|
|
26
26
|
method to modify the state.</p>
|
|
27
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
27
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/ambassador-state/use-ambassador-state.mts#L41">ambassador-state/use-ambassador-state.mts:41</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="useAmbassadorState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Ambassador<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">current</span>, <span class="tsd-kind-parameter">setCurrent</span>, <span class="tsd-kind-parameter">initial</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol"> | </span><a href="../types/_zthun_helpful_react.ZAmbassadorReducerRequired.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorReducerRequired</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useAmbassadorState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A type of state where the value is used from the props in the case of them being set.</p>
|
|
28
28
|
<p>Otherwise, an internal set of properties are used. This is useful in the case that you
|
|
29
29
|
want to allow properties to control the state of the component, but this functionality is
|
|
30
30
|
to be optional.</p>
|
|
@@ -36,4 +36,4 @@ the prop value are set.</p>
|
|
|
36
36
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">initial</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The initial value to set if current is undefined.</p>
|
|
37
37
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol"> | </span><a href="../types/_zthun_helpful_react.ZAmbassadorReducerRequired.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorReducerRequired</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAmbassadorState.html#useAmbassadorState-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><p>A tuple where the first item is the current state and the 2nd item is a mutator
|
|
38
38
|
method to modify the state.</p>
|
|
39
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
39
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/ambassador-state/use-ambassador-state.mts#L67">ambassador-state/use-ambassador-state.mts:67</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useAsyncState | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useAsyncState.html">useAsyncState</a></li></ul><h1>Function useAsyncState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useAsyncState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Async<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">load</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataTuple.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataTuple</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span><a href="#useAsyncState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Represents a hook to use async data.</p>
|
|
3
3
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useAsyncState.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will eventually be given.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">load</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The load method for the data.</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The dependencies to force a refresh of the data.</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_zthun_helpful_react.ZAsyncDataTuple.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataTuple</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useAsyncState.html#useAsyncState.T">T</a><span class="tsd-signature-symbol">></span></h4><p>A tuple where the first item is the current state of the data and
|
|
7
7
|
the 2nd argument is a refresh function to refresh the data.</p>
|
|
8
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
8
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/async-state/use-async-state.mts#L51">async-state/use-async-state.mts:51</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFileSelect | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useFileSelect.html">useFileSelect</a></li></ul><h1>Function useFileSelect</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFileSelect" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>File<wbr/>Select</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><a href="#useFileSelect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the global file select object.</p>
|
|
3
3
|
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a></h4><p>The global file select object.</p>
|
|
4
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/file-select/file-select.mts#L114">file-select/file-select.mts:114</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useKeyboardActivate | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useKeyboardActivate.html">useKeyboardActivate</a></li></ul><h1>Function useKeyboardActivate</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useKeyboardActivate" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Keyboard<wbr/>Activate</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useKeyboardActivate.html#useKeyboardActivate.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">codes</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_react.IZKeyboardInteraction.html" class="tsd-signature-type tsd-kind-interface">IZKeyboardInteraction</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useKeyboardActivate.html#useKeyboardActivate.T">T</a><span class="tsd-signature-symbol">></span><a href="#useKeyboardActivate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Represents a hook that generates a keyboard event that can
|
|
3
3
|
forward to another event as long as a specific key
|
|
4
4
|
is pressed. This will also output the best value for the
|
|
5
5
|
tabIndex property.</p>
|
|
@@ -10,4 +10,4 @@ are pressed. If this is undefined, then it will never be invoked</p>
|
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">codes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = DefaultActivateCodes</span></span><div class="tsd-comment tsd-typography"><p>The list of key codes that will fire the event handler. The default
|
|
11
11
|
value will be <a href="../variables/_zthun_helpful_react.DefaultActivateCodes.html" class="tsd-kind-variable">DefaultActivateCodes</a>.</p>
|
|
12
12
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_react.IZKeyboardInteraction.html" class="tsd-signature-type tsd-kind-interface">IZKeyboardInteraction</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useKeyboardActivate.html#useKeyboardActivate.T">T</a><span class="tsd-signature-symbol">></span></h4><p>An object that contains the equivalent keydown event</p>
|
|
13
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/keyboard-activate/use-keyboard-activate.mts#L56">keyboard-activate/use-keyboard-activate.mts:56</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useMoreViewState | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useMoreViewState.html">useMoreViewState</a></li></ul><h1>Function useMoreViewState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useMoreViewState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>More<wbr/>View<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">template</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">last</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">more</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#useMoreViewState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A type of view that loads the next set of data in batches.</p>
|
|
3
3
|
<p>This kind of state is useful for views that don't need the total
|
|
4
4
|
count and instead load more data when requested. You can use this
|
|
5
5
|
to implement infinite scrolling.</p>
|
|
@@ -10,4 +10,4 @@ the batch size. The page to load will be ignored and
|
|
|
10
10
|
will instead be controlled by this hook.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">last</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">more</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>The current view, last result, page number, and batch size.
|
|
12
12
|
Also returns the method to load the next batch.</p>
|
|
13
|
-
<ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">last</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">more</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useMoreViewState.__type.more.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useMoreViewState.__type.reset.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
<ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">complete</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">last</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">more</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useMoreViewState.__type.more.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">reset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useMoreViewState.__type.reset.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useMoreViewState.html#useMoreViewState.T">T</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/view-state/use-more-view-state.mts#L34">view-state/use-more-view-state.mts:34</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>usePageViewState | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.usePageViewState.html">usePageViewState</a></li></ul><h1>Function usePageViewState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="usePageViewState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Page<wbr/>View<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.usePageViewState.html#usePageViewState.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dataSource</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pages</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.usePageViewState.html#usePageViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#usePageViewState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a page view that calculates the necessary information for doing pagination.</p>
|
|
3
3
|
<p>This specific state is for viewing one page at a time. The actual count and view
|
|
4
4
|
are independent of one another.</p>
|
|
5
5
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="usePageViewState.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of data the source will return.</p>
|
|
@@ -8,4 +8,4 @@ are independent of one another.</p>
|
|
|
8
8
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pages</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.usePageViewState.html#usePageViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>The view, count, size, page number, and page count.
|
|
9
9
|
If the size in the request is not specified, then Infinity is returned for it.
|
|
10
10
|
If the page in the request is not specified, then 1 is returned for it.</p>
|
|
11
|
-
<ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pages</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.usePageViewState.html#usePageViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
11
|
+
<ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pages</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">view</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.usePageViewState.html#usePageViewState.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/view-state/use-page-view-state.mts#L24">view-state/use-page-view-state.mts:24</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useStateAsArray | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_react.html">@zthun/helpful-react</a></li><li><a href="_zthun_helpful_react.useStateAsArray.html">useStateAsArray</a></li></ul><h1>Function useStateAsArray</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useStateAsArray" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>State<wbr/>As<wbr/>Array</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">initial</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../types/_zthun_helpful_react.ZSetStateAsArray.html" class="tsd-signature-type tsd-kind-type-alias">ZSetStateAsArray</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">]</span><a href="#useStateAsArray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A helpful hook for when you can have a single value or array value and
|
|
3
3
|
you always need an array value.</p>
|
|
4
4
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useStateAsArray.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">initial</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The initial value. Note that the default for undefined
|
|
5
5
|
values is the empty array.</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../types/_zthun_helpful_react.ZSetStateAsArray.html" class="tsd-signature-type tsd-kind-type-alias">ZSetStateAsArray</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_react.useStateAsArray.html#useStateAsArray.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">]</span></h4><p>A state tuple where the first item is the current value
|
|
7
7
|
cast to an array, and the second item is the setter for
|
|
8
8
|
the value.</p>
|
|
9
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
9
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e6fe31120de790d74cfe9b7a4f9bb2307a82e742/packages/helpful-react/src/state-as-array/use-state-as-array.mts#L23">state-as-array/use-state-as-array.mts:23</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|