@zthun/helpful-web 6.7.1 → 7.0.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.
Files changed (319) hide show
  1. package/dist/assets/hierarchy.js +1 -0
  2. package/dist/assets/highlight.css +0 -14
  3. package/dist/assets/icons.js +1 -1
  4. package/dist/assets/icons.svg +1 -1
  5. package/dist/assets/main.js +5 -5
  6. package/dist/assets/navigation.js +1 -1
  7. package/dist/assets/search.js +1 -1
  8. package/dist/assets/style.css +1405 -1288
  9. package/dist/classes/{_zthun_helpful_brands.ZBrandBuilder.html → _zthun_helpful-brands.ZBrandBuilder.html} +87 -88
  10. package/dist/classes/{_zthun_helpful_fn.ZAssert.html → _zthun_helpful-fn.ZAssert.html} +11 -12
  11. package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +10 -0
  12. package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +18 -0
  13. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +43 -0
  14. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +48 -0
  15. package/dist/classes/_zthun_helpful-fn.ZRectangle.html +64 -0
  16. package/dist/classes/{_zthun_helpful_fn.ZSerializeJson.html → _zthun_helpful-fn.ZSerializeJson.html} +6 -7
  17. package/dist/classes/{_zthun_helpful_internet.ZCookieBuilder.html → _zthun_helpful-internet.ZCookieBuilder.html} +40 -41
  18. package/dist/classes/{_zthun_helpful_internet.ZEmailBuilder.html → _zthun_helpful-internet.ZEmailBuilder.html} +21 -22
  19. package/dist/classes/{_zthun_helpful_internet.ZEmailContactAddressBuilder.html → _zthun_helpful-internet.ZEmailContactAddressBuilder.html} +14 -15
  20. package/dist/classes/{_zthun_helpful_internet.ZEmailContactBuilder.html → _zthun_helpful-internet.ZEmailContactBuilder.html} +20 -21
  21. package/dist/classes/{_zthun_helpful_internet.ZEmailEnvelopeBuilder.html → _zthun_helpful-internet.ZEmailEnvelopeBuilder.html} +43 -44
  22. package/dist/classes/{_zthun_helpful_internet.ZServerBuilder.html → _zthun_helpful-internet.ZServerBuilder.html} +21 -22
  23. package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +11 -0
  24. package/dist/classes/{_zthun_helpful_query.ZDataMatchAlways.html → _zthun_helpful-query.ZDataMatchAlways.html} +5 -6
  25. package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +15 -0
  26. package/dist/classes/{_zthun_helpful_query.ZDataRequestBuilder.html → _zthun_helpful-query.ZDataRequestBuilder.html} +27 -28
  27. package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +10 -0
  28. package/dist/classes/{_zthun_helpful_query.ZDataSearchText.html → _zthun_helpful-query.ZDataSearchText.html} +5 -6
  29. package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +57 -0
  30. package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +22 -0
  31. package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +42 -0
  32. package/dist/classes/{_zthun_helpful_query.ZFilterCollectionBuilder.html → _zthun_helpful-query.ZFilterCollectionBuilder.html} +25 -26
  33. package/dist/classes/{_zthun_helpful_query.ZFilterDeserialize.html → _zthun_helpful-query.ZFilterDeserialize.html} +7 -8
  34. package/dist/classes/{_zthun_helpful_query.ZFilterLogicBuilder.html → _zthun_helpful-query.ZFilterLogicBuilder.html} +25 -26
  35. package/dist/classes/{_zthun_helpful_query.ZFilterSerialize.html → _zthun_helpful-query.ZFilterSerialize.html} +7 -8
  36. package/dist/classes/{_zthun_helpful_query.ZFilterUnaryBuilder.html → _zthun_helpful-query.ZFilterUnaryBuilder.html} +20 -21
  37. package/dist/classes/{_zthun_helpful_query.ZMetadataBuilder.html → _zthun_helpful-query.ZMetadataBuilder.html} +55 -56
  38. package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +30 -0
  39. package/dist/classes/{_zthun_helpful_query.ZSortBuilder.html → _zthun_helpful-query.ZSortBuilder.html} +17 -18
  40. package/dist/classes/{_zthun_helpful_query.ZSortDeserialize.html → _zthun_helpful-query.ZSortDeserialize.html} +7 -8
  41. package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +8 -0
  42. package/dist/classes/{_zthun_helpful_query.ZSorterSingle.html → _zthun_helpful-query.ZSorterSingle.html} +12 -13
  43. package/dist/classes/{_zthun_helpful_query.ZWellKnownIconClasses.html → _zthun_helpful-query.ZWellKnownIconClasses.html} +15 -16
  44. package/dist/classes/{_zthun_helpful_react.ZFileSelect.html → _zthun_helpful-react.ZFileSelect.html} +7 -8
  45. package/dist/classes/{_zthun_helpful_validation.EqualsOtherPropertyValidator.html → _zthun_helpful-validation.EqualsOtherPropertyValidator.html} +5 -6
  46. package/dist/classes/{_zthun_helpful_validation.IsDataURILimitValidator.html → _zthun_helpful-validation.IsDataURILimitValidator.html} +5 -6
  47. package/dist/classes/{_zthun_helpful_validation.IsNotWhiteSpaceValidator.html → _zthun_helpful-validation.IsNotWhiteSpaceValidator.html} +5 -6
  48. package/dist/classes/{_zthun_helpful_validation.RequiresOtherPropertyValidator.html → _zthun_helpful-validation.RequiresOtherPropertyValidator.html} +5 -6
  49. package/dist/enums/{_zthun_helpful_fn.ZHorizontalAnchor.html → _zthun_helpful-fn.ZHorizontalAnchor.html} +8 -9
  50. package/dist/enums/{_zthun_helpful_fn.ZOrientation.html → _zthun_helpful-fn.ZOrientation.html} +6 -7
  51. package/dist/enums/{_zthun_helpful_fn.ZVerticalAnchor.html → _zthun_helpful-fn.ZVerticalAnchor.html} +8 -9
  52. package/dist/enums/{_zthun_helpful_query.ZMetadataType.html → _zthun_helpful-query.ZMetadataType.html} +14 -15
  53. package/dist/enums/{_zthun_helpful_query.ZOperatorBinary.html → _zthun_helpful-query.ZOperatorBinary.html} +16 -17
  54. package/dist/enums/{_zthun_helpful_query.ZOperatorCollection.html → _zthun_helpful-query.ZOperatorCollection.html} +6 -7
  55. package/dist/enums/{_zthun_helpful_query.ZOperatorLogic.html → _zthun_helpful-query.ZOperatorLogic.html} +6 -7
  56. package/dist/enums/{_zthun_helpful_query.ZOperatorUnary.html → _zthun_helpful-query.ZOperatorUnary.html} +6 -7
  57. package/dist/enums/{_zthun_helpful_query.ZSortDirection.html → _zthun_helpful-query.ZSortDirection.html} +6 -7
  58. package/dist/functions/{_zthun_helpful_fn.bash.html → _zthun_helpful-fn.bash.html} +5 -6
  59. package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +5 -0
  60. package/dist/functions/{_zthun_helpful_fn.countBuckets.html → _zthun_helpful-fn.countBuckets.html} +3 -4
  61. package/dist/functions/{_zthun_helpful_fn.createError.html → _zthun_helpful-fn.createError.html} +3 -4
  62. package/dist/functions/{_zthun_helpful_fn.createGuid.html → _zthun_helpful-fn.createGuid.html} +4 -5
  63. package/dist/functions/{_zthun_helpful_fn.css.html → _zthun_helpful-fn.css.html} +5 -6
  64. package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +5 -0
  65. package/dist/functions/_zthun_helpful-fn.firstDefined.html +12 -0
  66. package/dist/functions/_zthun_helpful-fn.firstTruthy.html +12 -0
  67. package/dist/functions/_zthun_helpful-fn.firstWhere.html +10 -0
  68. package/dist/functions/{_zthun_helpful_fn.html.html → _zthun_helpful-fn.html.html} +5 -6
  69. package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +8 -0
  70. package/dist/functions/{_zthun_helpful_fn.javascript.html → _zthun_helpful-fn.javascript.html} +5 -6
  71. package/dist/functions/_zthun_helpful-fn.joinDefined.html +9 -0
  72. package/dist/functions/{_zthun_helpful_fn.js.html → _zthun_helpful-fn.js.html} +5 -6
  73. package/dist/functions/{_zthun_helpful_fn.markdown.html → _zthun_helpful-fn.markdown.html} +5 -6
  74. package/dist/functions/{_zthun_helpful_fn.md.html → _zthun_helpful-fn.md.html} +5 -6
  75. package/dist/functions/_zthun_helpful-fn.optional.html +32 -0
  76. package/dist/functions/_zthun_helpful-fn.peel.html +8 -0
  77. package/dist/functions/{_zthun_helpful_fn.peelBetween.html → _zthun_helpful-fn.peelBetween.html} +4 -5
  78. package/dist/functions/_zthun_helpful-fn.pickBy.html +6 -0
  79. package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -0
  80. package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -0
  81. package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
  82. package/dist/functions/_zthun_helpful-fn.required.html +9 -0
  83. package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
  84. package/dist/functions/_zthun_helpful-fn.setFirst.html +16 -0
  85. package/dist/functions/{_zthun_helpful_fn.sh.html → _zthun_helpful-fn.sh.html} +5 -6
  86. package/dist/functions/_zthun_helpful-fn.sleep.html +13 -0
  87. package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
  88. package/dist/functions/{_zthun_helpful_fn.tag.html → _zthun_helpful-fn.tag.html} +4 -5
  89. package/dist/functions/_zthun_helpful-fn.tryFallback.html +13 -0
  90. package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +16 -0
  91. package/dist/functions/{_zthun_helpful_fn.ts.html → _zthun_helpful-fn.ts.html} +5 -6
  92. package/dist/functions/{_zthun_helpful_fn.typescript.html → _zthun_helpful-fn.typescript.html} +5 -6
  93. package/dist/functions/{_zthun_helpful_fn.zsh.html → _zthun_helpful-fn.zsh.html} +5 -6
  94. package/dist/functions/{_zthun_helpful_node.walk.html → _zthun_helpful-node.walk.html} +5 -6
  95. package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +4 -0
  96. package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +4 -0
  97. package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +4 -0
  98. package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +4 -0
  99. package/dist/functions/_zthun_helpful-query.isLogicFilter.html +4 -0
  100. package/dist/functions/_zthun_helpful-query.isLogicOperator.html +4 -0
  101. package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +4 -0
  102. package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +4 -0
  103. package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +10 -0
  104. package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +10 -0
  105. package/dist/functions/_zthun_helpful-react.asStateData.html +18 -0
  106. package/dist/functions/_zthun_helpful-react.asStateError.html +6 -0
  107. package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +7 -0
  108. package/dist/functions/_zthun_helpful-react.isStateErrored.html +5 -0
  109. package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -0
  110. package/dist/functions/_zthun_helpful-react.isStateLoading.html +5 -0
  111. package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +38 -0
  112. package/dist/functions/_zthun_helpful-react.useAsyncState.html +7 -0
  113. package/dist/functions/_zthun_helpful-react.useFileSelect.html +3 -0
  114. package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +12 -0
  115. package/dist/functions/_zthun_helpful-react.useMoreViewState.html +12 -0
  116. package/dist/functions/_zthun_helpful-react.usePageViewState.html +10 -0
  117. package/dist/functions/_zthun_helpful-react.useStateAsArray.html +8 -0
  118. package/dist/functions/_zthun_helpful-react.useWindowService.html +3 -0
  119. package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +5 -0
  120. package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +6 -0
  121. package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +4 -0
  122. package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +5 -0
  123. package/dist/hierarchy.html +1 -2
  124. package/dist/index.html +2 -3
  125. package/dist/interfaces/{_zthun_helpful_brands.IZBrand.html → _zthun_helpful-brands.IZBrand.html} +10 -11
  126. package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +11 -0
  127. package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -0
  128. package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -0
  129. package/dist/interfaces/{_zthun_helpful_fn.IZQuadrilateral.html → _zthun_helpful-fn.IZQuadrilateral.html} +11 -12
  130. package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +9 -0
  131. package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +9 -0
  132. package/dist/interfaces/{_zthun_helpful_internet.IZCookie.html → _zthun_helpful-internet.IZCookie.html} +15 -16
  133. package/dist/interfaces/{_zthun_helpful_internet.IZEmail.html → _zthun_helpful-internet.IZEmail.html} +8 -9
  134. package/dist/interfaces/{_zthun_helpful_internet.IZEmailContact.html → _zthun_helpful-internet.IZEmailContact.html} +7 -8
  135. package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +13 -0
  136. package/dist/interfaces/{_zthun_helpful_internet.IZServer.html → _zthun_helpful-internet.IZServer.html} +9 -10
  137. package/dist/interfaces/{_zthun_helpful_node.ZWalkOptions.html → _zthun_helpful-node.ZWalkOptions.html} +8 -9
  138. package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +9 -0
  139. package/dist/interfaces/{_zthun_helpful_query.IZDataRequest.html → _zthun_helpful-query.IZDataRequest.html} +15 -16
  140. package/dist/interfaces/{_zthun_helpful_query.IZDataRequestQuery.html → _zthun_helpful-query.IZDataRequestQuery.html} +11 -12
  141. package/dist/interfaces/{_zthun_helpful_query.IZDataSource.html → _zthun_helpful-query.IZDataSource.html} +10 -11
  142. package/dist/interfaces/{_zthun_helpful_query.IZDataSourceStaticOptions.html → _zthun_helpful-query.IZDataSourceStaticOptions.html} +7 -8
  143. package/dist/interfaces/{_zthun_helpful_query.IZFilterBinary.html → _zthun_helpful-query.IZFilterBinary.html} +9 -10
  144. package/dist/interfaces/{_zthun_helpful_query.IZFilterCollection.html → _zthun_helpful-query.IZFilterCollection.html} +9 -10
  145. package/dist/interfaces/{_zthun_helpful_query.IZFilterLogic.html → _zthun_helpful-query.IZFilterLogic.html} +8 -9
  146. package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +6 -0
  147. package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -0
  148. package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -0
  149. package/dist/interfaces/{_zthun_helpful_query.IZMetadata.html → _zthun_helpful-query.IZMetadata.html} +23 -24
  150. package/dist/interfaces/{_zthun_helpful_query.IZPage.html → _zthun_helpful-query.IZPage.html} +6 -7
  151. package/dist/interfaces/{_zthun_helpful_query.IZSort.html → _zthun_helpful-query.IZSort.html} +6 -7
  152. package/dist/interfaces/_zthun_helpful-query.IZSorter.html +27 -0
  153. package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +10 -0
  154. package/dist/interfaces/{_zthun_helpful_react.IZKeyboardInteraction.html → _zthun_helpful-react.IZKeyboardInteraction.html} +8 -9
  155. package/dist/modules/_zthun_helpful-brands.html +18 -0
  156. package/dist/modules/_zthun_helpful-fn.html +7 -0
  157. package/dist/modules/_zthun_helpful-internet.html +6 -0
  158. package/dist/modules/_zthun_helpful-node.html +10 -0
  159. package/dist/modules/_zthun_helpful-query.html +32 -0
  160. package/dist/modules/_zthun_helpful-react.html +6 -0
  161. package/dist/modules/_zthun_helpful-validation.html +7 -0
  162. package/dist/modules.html +1 -2
  163. package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -0
  164. package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +6 -0
  165. package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -0
  166. package/dist/types/_zthun_helpful-fn.PickResult.html +1 -0
  167. package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -0
  168. package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -0
  169. package/dist/types/_zthun_helpful-fn.ZAnchor.html +11 -0
  170. package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +2 -0
  171. package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -0
  172. package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -0
  173. package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -0
  174. package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +5 -0
  175. package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -0
  176. package/dist/types/_zthun_helpful-query.IZFilter.html +2 -0
  177. package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -0
  178. package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -0
  179. package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -0
  180. package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -0
  181. package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -0
  182. package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +8 -0
  183. package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +5 -0
  184. package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -0
  185. package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -0
  186. package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -0
  187. package/dist/variables/_zthun_helpful-brands.ZBrands.html +5 -0
  188. package/dist/variables/_zthun_helpful-fn._global.html +1 -0
  189. package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -0
  190. package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -0
  191. package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -0
  192. package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -0
  193. package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -0
  194. package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -0
  195. package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -0
  196. package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -0
  197. package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -0
  198. package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +4 -0
  199. package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -0
  200. package/package.json +11 -13
  201. package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +0 -11
  202. package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +0 -19
  203. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +0 -44
  204. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +0 -49
  205. package/dist/classes/_zthun_helpful_fn.ZRectangle.html +0 -65
  206. package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +0 -12
  207. package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +0 -16
  208. package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +0 -11
  209. package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +0 -58
  210. package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +0 -23
  211. package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +0 -43
  212. package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +0 -31
  213. package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +0 -9
  214. package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +0 -6
  215. package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +0 -6
  216. package/dist/functions/_zthun_helpful_fn.firstDefined.html +0 -13
  217. package/dist/functions/_zthun_helpful_fn.firstTruthy.html +0 -13
  218. package/dist/functions/_zthun_helpful_fn.firstWhere.html +0 -11
  219. package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +0 -9
  220. package/dist/functions/_zthun_helpful_fn.joinDefined.html +0 -10
  221. package/dist/functions/_zthun_helpful_fn.optional.html +0 -33
  222. package/dist/functions/_zthun_helpful_fn.peel.html +0 -9
  223. package/dist/functions/_zthun_helpful_fn.pickBy.html +0 -7
  224. package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +0 -5
  225. package/dist/functions/_zthun_helpful_fn.pickDefined.html +0 -5
  226. package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +0 -6
  227. package/dist/functions/_zthun_helpful_fn.required.html +0 -10
  228. package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +0 -6
  229. package/dist/functions/_zthun_helpful_fn.setFirst.html +0 -17
  230. package/dist/functions/_zthun_helpful_fn.sleep.html +0 -14
  231. package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +0 -6
  232. package/dist/functions/_zthun_helpful_fn.tryFallback.html +0 -14
  233. package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +0 -17
  234. package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +0 -5
  235. package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +0 -5
  236. package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +0 -5
  237. package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +0 -5
  238. package/dist/functions/_zthun_helpful_query.isLogicFilter.html +0 -5
  239. package/dist/functions/_zthun_helpful_query.isLogicOperator.html +0 -5
  240. package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +0 -5
  241. package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +0 -5
  242. package/dist/functions/_zthun_helpful_react.ZFileSelectContext.html +0 -11
  243. package/dist/functions/_zthun_helpful_react.ZWindowServiceContext.html +0 -11
  244. package/dist/functions/_zthun_helpful_react.asStateData.html +0 -19
  245. package/dist/functions/_zthun_helpful_react.asStateError.html +0 -7
  246. package/dist/functions/_zthun_helpful_react.createKeyboardActivate.html +0 -8
  247. package/dist/functions/_zthun_helpful_react.isStateErrored.html +0 -6
  248. package/dist/functions/_zthun_helpful_react.isStateLoaded.html +0 -6
  249. package/dist/functions/_zthun_helpful_react.isStateLoading.html +0 -6
  250. package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +0 -39
  251. package/dist/functions/_zthun_helpful_react.useAsyncState.html +0 -8
  252. package/dist/functions/_zthun_helpful_react.useFileSelect.html +0 -4
  253. package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +0 -13
  254. package/dist/functions/_zthun_helpful_react.useMoreViewState.html +0 -13
  255. package/dist/functions/_zthun_helpful_react.usePageViewState.html +0 -11
  256. package/dist/functions/_zthun_helpful_react.useStateAsArray.html +0 -9
  257. package/dist/functions/_zthun_helpful_react.useWindowService.html +0 -4
  258. package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +0 -6
  259. package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +0 -7
  260. package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +0 -5
  261. package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +0 -6
  262. package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +0 -12
  263. package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +0 -7
  264. package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +0 -9
  265. package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +0 -10
  266. package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +0 -10
  267. package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +0 -14
  268. package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +0 -10
  269. package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +0 -7
  270. package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +0 -8
  271. package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +0 -9
  272. package/dist/interfaces/_zthun_helpful_query.IZSorter.html +0 -28
  273. package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +0 -11
  274. package/dist/modules/_zthun_helpful_brands.html +0 -22
  275. package/dist/modules/_zthun_helpful_fn.html +0 -74
  276. package/dist/modules/_zthun_helpful_internet.html +0 -18
  277. package/dist/modules/_zthun_helpful_node.html +0 -13
  278. package/dist/modules/_zthun_helpful_proxy.html +0 -60
  279. package/dist/modules/_zthun_helpful_query.html +0 -95
  280. package/dist/modules/_zthun_helpful_react.html +0 -36
  281. package/dist/modules/_zthun_helpful_validation.html +0 -16
  282. package/dist/types/_zthun_helpful_fn.DeepPartial.html +0 -2
  283. package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +0 -7
  284. package/dist/types/_zthun_helpful_fn.PickPredicate.html +0 -2
  285. package/dist/types/_zthun_helpful_fn.PickResult.html +0 -2
  286. package/dist/types/_zthun_helpful_fn.RequiredDeep.html +0 -2
  287. package/dist/types/_zthun_helpful_fn.RequiredPick.html +0 -2
  288. package/dist/types/_zthun_helpful_fn.ZAnchor.html +0 -12
  289. package/dist/types/_zthun_helpful_fn.ZCornersHorizontal.html +0 -3
  290. package/dist/types/_zthun_helpful_fn.ZCornersVertical.html +0 -3
  291. package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +0 -4
  292. package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +0 -3
  293. package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +0 -6
  294. package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +0 -3
  295. package/dist/types/_zthun_helpful_query.IZFilter.html +0 -3
  296. package/dist/types/_zthun_helpful_query.IZFilterUnary.html +0 -3
  297. package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +0 -3
  298. package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +0 -3
  299. package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +0 -3
  300. package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +0 -3
  301. package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +0 -9
  302. package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +0 -6
  303. package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +0 -3
  304. package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +0 -2
  305. package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +0 -2
  306. package/dist/variables/_zthun_helpful_brands.ZBrands.html +0 -6
  307. package/dist/variables/_zthun_helpful_fn._global.html +0 -2
  308. package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +0 -3
  309. package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +0 -3
  310. package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +0 -3
  311. package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +0 -3
  312. package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +0 -3
  313. package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +0 -3
  314. package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +0 -3
  315. package/dist/variables/_zthun_helpful_query.ZSortDirections.html +0 -3
  316. package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +0 -3
  317. package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +0 -5
  318. package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +0 -3
  319. /package/dist/{helpful.svg → assets/favicon.svg} +0 -0
package/dist/functions/_zthun_helpful-query.isUnaryOperator.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isUnaryOperator | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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-query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful-query.isUnaryOperator.html">isUnaryOperator</a></li></ul><h1>Function isUnaryOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isunaryoperator" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isUnaryOperator</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">candidate</span> <span class="tsd-signature-keyword">is</span> <a href="../enums/_zthun_helpful-query.ZOperatorUnary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorUnary</a><a href="#isunaryoperator" 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>Gets whether a candidate string represents a unary operator.</p>
2
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">candidate</span> <span class="tsd-signature-keyword">is</span> <a href="../enums/_zthun_helpful-query.ZOperatorUnary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorUnary</a></h4><p>Type guard true if candidate is a unary operator, false
3
+ otherwise.</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/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-query/src/filter/filter-unary.mts#L128">packages/helpful-query/src/filter/filter-unary.mts:128</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html ADDED
@@ -0,0 +1,10 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZFileSelectContext | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.ZFileSelectContext.html">ZFileSelectContext</a></li></ul><h1>Function ZFileSelectContext</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the context for using a file select object.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="zfileselectcontext" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ZFileSelectContext</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactNode</span><a href="#zfileselectcontext" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/file-select/file-select.mts#L104">packages/helpful-react/src/file-select/file-select.mts:104</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful-react.ZFileSelectContext.html#typeof" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>$$typeof</span></a>
3
+ <a href="_zthun_helpful-react.ZFileSelectContext.html#consumer" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Consumer</span></a>
4
+ <a href="_zthun_helpful-react.ZFileSelectContext.html#displayname" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
5
+ <a href="_zthun_helpful-react.ZFileSelectContext.html#provider" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Provider</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><a id="typeof" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>$$typeof</span><a href="#typeof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">$$typeof</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:562</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="consumer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Consumer</span><a href="#consumer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Consumer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Consumer</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:670</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="displayname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>display<wbr/>Name</span><a href="#displayname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">displayName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Used in debugging messages. You might want to set it
7
+ explicitly if you want to display a different name for
8
+ debugging purposes.</p>
9
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" 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 href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
10
+ </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:678</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="provider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Provider</span><a href="#provider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Provider</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:669</li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#typeof" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>$$typeof</span></a><a href="#consumer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Consumer</span></a><a href="#displayname" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name</span></a><a href="#provider" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Provider</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html ADDED
@@ -0,0 +1,10 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZWindowServiceContext | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.ZWindowServiceContext.html">ZWindowServiceContext</a></li></ul><h1>Function ZWindowServiceContext</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the window context.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="zwindowservicecontext" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ZWindowServiceContext</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactNode</span><a href="#zwindowservicecontext" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactNode</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/window/window-service.mts#L7">packages/helpful-react/src/window/window-service.mts:7</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful-react.ZWindowServiceContext.html#typeof" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>$$typeof</span></a>
3
+ <a href="_zthun_helpful-react.ZWindowServiceContext.html#consumer" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Consumer</span></a>
4
+ <a href="_zthun_helpful-react.ZWindowServiceContext.html#displayname" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
5
+ <a href="_zthun_helpful-react.ZWindowServiceContext.html#provider" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Provider</span></a>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><a id="typeof" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>$$typeof</span><a href="#typeof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">$$typeof</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:562</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="consumer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Consumer</span><a href="#consumer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Consumer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Consumer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:670</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="displayname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>display<wbr/>Name</span><a href="#displayname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">displayName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Used in debugging messages. You might want to set it
7
+ explicitly if you want to display a different name for
8
+ debugging purposes.</p>
9
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" 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 href="https://legacy.reactjs.org/docs/react-component.html#displayname">Legacy React Docs</a></p>
10
+ </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:678</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="provider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Provider</span><a href="#provider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Provider</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/react/index.d.ts:669</li></ul></aside></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#typeof" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>$$typeof</span></a><a href="#consumer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Consumer</span></a><a href="#displayname" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name</span></a><a href="#provider" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Provider</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.asStateData.html ADDED
@@ -0,0 +1,18 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>asStateData | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.asStateData.html">asStateData</a></li></ul><h1>Function asStateData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Returns the loaded data.</p>
2
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-data" class="tsd-anchor"></a>Param: data<a href="#param-data" 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 data to retrieve.</p>
3
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-fallback" class="tsd-anchor"></a>Param: fallback<a href="#param-fallback" 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 fallback to return in the case that data has not yet been loaded.</p>
4
+ </div><div class="tsd-tag-param"><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 of the loaded state.</p>
5
+ </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>This method returns data if it is loaded, or fallback
6
+ if it is not.</p>
7
+ </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="asstatedata" class="tsd-anchor"></a><span class="tsd-kind-call-signature">asStateData</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat">T</a><span class="tsd-signature-symbol">&gt;</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.asStateData.html#asstatedatat">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#asstatedata" 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 the loaded data.</p>
8
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asstatedatat" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
9
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to retrieve.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>This method returns data if it is loaded, or undefined
11
+ if it is not.</p>
12
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L143">packages/helpful-react/src/async-state/use-async-state.mts:143</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="asstatedata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">asStateData</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a><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.asStateData.html#asstatedatat-1">T</a><a href="#asstatedata-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>Returns the loaded data.</p>
13
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asstatedatat-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
14
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to retrieve.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback to return in the case that data has not yet been loaded.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateData.html#asstatedatat-1">T</a></h4><p>This method returns data if it is loaded, or fallback
17
+ if it is not.</p>
18
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L158">packages/helpful-react/src/async-state/use-async-state.mts:158</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.asStateError.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>asStateError | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.asStateError.html">asStateError</a></li></ul><h1>Function asStateError</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="asstateerror" class="tsd-anchor"></a><span class="tsd-kind-call-signature">asStateError</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateError.html#asstateerrort">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateError.html#asstateerrort">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#asstateerror" 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 the data error.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asstateerrort" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
3
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.asStateError.html#asstateerrort">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data that has possibly errored.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The error that occurred or undefined if the data is
5
+ loading or successful.</p>
6
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L192">packages/helpful-react/src/async-state/use-async-state.mts:192</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createKeyboardActivate | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.createKeyboardActivate.html">createKeyboardActivate</a></li></ul><h1>Function createKeyboardActivate</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createkeyboardactivate" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createKeyboardActivate</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.createKeyboardActivate.html#createkeyboardactivatet">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">KeyboardEventHandler</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.createKeyboardActivate.html#createkeyboardactivatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">codes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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-kind-parameter">e</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">KeyboardEvent</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.createKeyboardActivate.html#createkeyboardactivatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><a href="#createkeyboardactivate" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createkeyboardactivatet" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">Element</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">handler</span>: <span class="tsd-signature-type">KeyboardEventHandler</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.createKeyboardActivate.html#createkeyboardactivatet">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The callback handler to invoke when any of the key codes
2
+ are pressed. If this is undefined, then it will never be invoked</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">codes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of key codes that will fire the event handler. The default
4
+ value will be <a href="../variables/_zthun_helpful-react.DefaultActivateCodes.html" class="tsd-kind-variable">DefaultActivateCodes</a>.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">e</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">KeyboardEvent</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.createKeyboardActivate.html#createkeyboardactivatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h4><p>An object that contains the equivalent keydown event</p>
6
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" 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 href="_zthun_helpful-react.useKeyboardActivate.html" class="tsd-kind-function">useKeyboardActivate</a></p>
7
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/keyboard-activate/use-keyboard-activate.mts#L51">packages/helpful-react/src/keyboard-activate/use-keyboard-activate.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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.isStateErrored.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isStateErrored | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.isStateErrored.html">isStateErrored</a></li></ul><h1>Function isStateErrored</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isstateerrored" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isStateErrored</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateErrored.html#isstateerroredt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateErrored.html#isstateerroredt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Error</span><a href="#isstateerrored" 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>Gets whether data has errored.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="isstateerroredt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
3
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateErrored.html#isstateerroredt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Error</span></h4><p>True if the data is in an error state.</p>
5
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L127">packages/helpful-react/src/async-state/use-async-state.mts:127</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.isStateLoaded.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isStateLoaded | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.isStateLoaded.html">isStateLoaded</a></li></ul><h1>Function isStateLoaded</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isstateloaded" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isStateLoaded</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoaded.html#isstateloadedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoaded.html#isstateloadedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoaded.html#isstateloadedt">T</a><a href="#isstateloaded" 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>Gets whether data has been loaded.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="isstateloadedt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
3
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoaded.html#isstateloadedt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoaded.html#isstateloadedt">T</a></h4><p>True if the data is loaded.</p>
5
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L112">packages/helpful-react/src/async-state/use-async-state.mts:112</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.isStateLoading.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isStateLoading | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.isStateLoading.html">isStateLoading</a></li></ul><h1>Function isStateLoading</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isstateloading" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isStateLoading</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoading.html#isstateloadingt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoading.html#isstateloadingt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">symbol</span><a href="#isstateloading" 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>Gets whether data is loading.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="isstateloadingt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data of the loaded state.</p>
3
+ </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">data</span>: <a href="../types/_zthun_helpful-react.ZAsyncDataState.html" class="tsd-signature-type tsd-kind-type-alias">ZAsyncDataState</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.isStateLoading.html#isstateloadingt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">data</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">symbol</span></h4><p>True if the data is in a loading state.</p>
5
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L97">packages/helpful-react/src/async-state/use-async-state.mts:97</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.useAmbassadorState.html ADDED
@@ -0,0 +1,38 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useAmbassadorState | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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>
2
+ <p>Otherwise, an internal set of properties are used. This is useful in the case that you
3
+ want to allow properties to control the state of the component, but this functionality is
4
+ to be optional.</p>
5
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><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
+ undefined, then the internal state is used.</p>
7
+ </div><div class="tsd-tag-param"><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
8
+ be undefined, but if it is set, both the internal value and
9
+ the prop value are set.</p>
10
+ </div><div class="tsd-tag-param"><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>
11
+ </div><div class="tsd-tag-param"><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>
12
+ </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
13
+ method to modify the state.</p>
14
+ </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">useAmbassadorState</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">current</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">setCurrent</span><span class="tsd-signature-symbol">:</span> <a href="../types/_zthun_helpful-react.ZAmbassadorSetCurrent.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorSetCurrent</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><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#useambassadorstatet">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-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#useambassadorstatet">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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</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
+ <p>Otherwise, an internal set of properties are used. This is useful in the case that you
16
+ want to allow properties to control the state of the component, but this functionality is
17
+ to be optional.</p>
18
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useambassadorstatet" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data for the state.</p>
19
+ </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">current</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a></span><div class="tsd-comment tsd-typography"><p>The current value from the props. If this is
20
+ undefined, then the internal state is used.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">setCurrent</span>: <a href="../types/_zthun_helpful-react.ZAmbassadorSetCurrent.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorSetCurrent</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The mutator method to set the current value. This can
22
+ be undefined, but if it is set, both the internal value and
23
+ the prop value are set.</p>
24
+ </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#useambassadorstatet">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-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#useambassadorstatet">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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</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
25
+ method to modify the state.</p>
26
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/ambassador-state/use-ambassador-state.mts#L41">packages/helpful-react/src/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">useAmbassadorState</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">current</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">setCurrent</span><span class="tsd-signature-symbol">:</span> <a href="../types/_zthun_helpful-react.ZAmbassadorSetCurrent.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorSetCurrent</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">initial</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">,</span><br/><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#useambassadorstatet-1">T</a><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#useambassadorstatet-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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</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>
27
+ <p>Otherwise, an internal set of properties are used. This is useful in the case that you
28
+ want to allow properties to control the state of the component, but this functionality is
29
+ to be optional.</p>
30
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useambassadorstatet-1" 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><span class="tsd-kind-parameter">current</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a></span><div class="tsd-comment tsd-typography"><p>The current value from the props. If this is
31
+ undefined, then the internal state is used.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">setCurrent</span>: <a href="../types/_zthun_helpful-react.ZAmbassadorSetCurrent.html" class="tsd-signature-type tsd-kind-type-alias">ZAmbassadorSetCurrent</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The mutator method to set the current value. This can
33
+ be undefined, but if it is set, both the internal value and
34
+ the prop value are set.</p>
35
+ </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#useambassadorstatet-1">T</a></span><div class="tsd-comment tsd-typography"><p>The initial value to set if current is undefined.</p>
36
+ </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#useambassadorstatet-1">T</a><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#useambassadorstatet-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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAmbassadorState.html#useambassadorstatet-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</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
37
+ method to modify the state.</p>
38
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/ambassador-state/use-ambassador-state.mts#L67">packages/helpful-react/src/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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.useAsyncState.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useAsyncState | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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">useAsyncState</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAsyncState.html#useasyncstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">load</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAsyncState.html#useasyncstatet">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">,</span><br/><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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAsyncState.html#useasyncstatet">T</a><span class="tsd-signature-symbol">&gt;</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>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useasyncstatet" 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>
3
+ </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">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAsyncState.html#useasyncstatet">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The load method for the data.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></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>
5
+ </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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-react.useAsyncState.html#useasyncstatet">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A tuple where the first item is the current state of the data and
6
+ the 2nd argument is a refresh function to refresh the data.</p>
7
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/async-state/use-async-state.mts#L51">packages/helpful-react/src/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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
package/dist/functions/_zthun_helpful-react.useFileSelect.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFileSelect | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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">useFileSelect</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>
2
+ </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>
3
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/71171ac1a219127dda0683a73489950c75771a1a/packages/helpful-react/src/file-select/file-select.mts#L114">packages/helpful-react/src/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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>