From ad9c003546b83365b91f0d9daa65fe33b8a82d87 Mon Sep 17 00:00:00 2001 From: arunvishnun <1584121+arunvishnun@users.noreply.github.com> Date: Thu, 7 Sep 2023 15:14:04 -0700 Subject: [PATCH] chore: minor change to force publish to publish esm bundles and docs update --- .../release-08-29-2023_2023-08-29-22-10.json | 10 - .../release-08-29-2023_2023-08-29-22-10.json | 10 - .../release-08-29-2023_2023-08-29-22-10.json | 10 - .../release-08-29-2023_2023-08-29-22-10.json | 10 - .../release-08-29-2023_2023-08-29-22-10.json | 10 - common/config/rush/pnpm-lock.yaml | 20 +- packages/xarc-create-app/package.json | 2 +- packages/xarc-react-query/CHANGELOG.json | 12 + packages/xarc-react-query/CHANGELOG.md | 9 +- packages/xarc-react-query/docs/.nojekyll | 1 + .../xarc-react-query/docs/assets/css/main.css | 2660 ----------------- .../docs/assets/highlight.css | 71 + .../xarc-react-query/docs/assets/icons.css | 1043 +++++++ .../docs/assets/{images => }/icons.png | Bin .../docs/assets/{images => }/icons@2x.png | Bin .../xarc-react-query/docs/assets/js/main.js | 248 -- .../xarc-react-query/docs/assets/js/search.js | 1 - packages/xarc-react-query/docs/assets/main.js | 52 + .../xarc-react-query/docs/assets/search.js | 1 + .../xarc-react-query/docs/assets/style.css | 1414 +++++++++ .../docs/assets/{images => }/widgets.png | Bin .../docs/assets/{images => }/widgets@2x.png | Bin .../docs/classes/browser.Mutation.html | 1 + .../docs/classes/browser.cancellederror.html | 213 +- .../browser.infinitequeryobserver.html | 885 +----- .../docs/classes/browser.mutationcache.html | 665 +---- .../classes/browser.mutationobserver.html | 600 +--- .../docs/classes/browser.queriesobserver.html | 548 +--- .../docs/classes/browser.query.html | 927 +----- .../docs/classes/browser.querycache.html | 722 +---- .../docs/classes/browser.queryclient.html | 1644 +--------- .../docs/classes/browser.queryobserver.html | 1097 +------ packages/xarc-react-query/docs/index.html | 118 +- .../interfaces/browser.CancelOptions.html | 1 + .../interfaces/browser.DehydrateOptions.html | 1 + .../interfaces/browser.DehydratedState.html | 1 + .../interfaces/browser.HydrateOptions.html | 1 + .../docs/interfaces/browser.HydrateProps.html | 1 + .../browser.MutationObserverBaseResult.html | 1 + .../browser.MutationObserverErrorResult.html | 1 + .../browser.MutationObserverIdleResult.html | 1 + ...browser.MutationObserverLoadingResult.html | 1 + ...browser.MutationObserverSuccessResult.html | 1 + .../interfaces/browser.QueryClientConfig.html | 1 + .../browser.RefetchPageFilters.html | 1 + .../browser.RefetchQueryFilters.html | 15 + .../interfaces/browser.ResetQueryFilters.html | 15 + .../interfaces/browser.SetDataOptions.html | 1 + .../interfaces/browser.defaultoptions.html | 186 +- .../browser.fetchinfinitequeryoptions.html | 488 +-- .../browser.fetchnextpageoptions.html | 184 +- .../browser.fetchpreviouspageoptions.html | 184 +- .../interfaces/browser.fetchqueryoptions.html | 492 +-- .../docs/interfaces/browser.infinitedata.html | 186 +- ...owser.infinitequeryobserverbaseresult.html | 645 +--- ...owser.infinitequeryobserveridleresult.html | 634 +--- ...finitequeryobserverloadingerrorresult.html | 634 +--- ...er.infinitequeryobserverloadingresult.html | 634 +--- .../browser.infinitequeryobserveroptions.html | 1030 +------ ...finitequeryobserverrefetcherrorresult.html | 634 +--- ...er.infinitequeryobserversuccessresult.html | 634 +--- .../interfaces/browser.invalidateoptions.html | 164 +- .../browser.invalidatequeryfilters.html | 358 +-- .../docs/interfaces/browser.logger.html | 192 +- .../interfaces/browser.mutateoptions.html | 293 +- .../browser.mutationobserveroptions.html | 441 +-- .../browser.mutationobserverresult.html | 375 --- .../interfaces/browser.mutationoptions.html | 417 +-- .../browser.queryclientproviderprops.html | 178 +- .../browser.queryerrorresetboundaryprops.html | 164 +- .../browser.queryfunctioncontext.html | 189 +- .../browser.queryobserverbaseresult.html | 497 +-- .../browser.queryobserveridleresult.html | 502 +--- ...owser.queryobserverloadingerrorresult.html | 502 +--- .../browser.queryobserverloadingresult.html | 502 +--- .../browser.queryobserveroptions.html | 1014 +------ ...owser.queryobserverrefetcherrorresult.html | 502 +--- .../browser.queryobserversuccessresult.html | 502 +--- .../docs/interfaces/browser.queryoptions.html | 452 +-- .../interfaces/browser.refetchoptions.html | 184 +- .../docs/interfaces/browser.resetoptions.html | 164 +- .../interfaces/browser.resultoptions.html | 175 +- .../browser.usebasequeryoptions.html | 1030 +------ .../browser.useinfinitequeryoptions.html | 1025 +------ .../browser.usemutationoptions.html | 384 +-- .../interfaces/browser.usemutationresult.html | 377 --- .../interfaces/browser.usequeryoptions.html | 1022 +------ packages/xarc-react-query/docs/modules.html | 123 +- .../docs/modules/browser.html | 1814 +---------- .../xarc-react-query/docs/modules/common.html | 1107 +------ .../docs/modules/common_feature_info.html | 158 +- .../xarc-react-query/docs/modules/node.html | 993 +----- packages/xarc-react-query/package.json | 2 +- .../xarc-react-query/src/browser/index.tsx | 1 - packages/xarc-react-recoil/CHANGELOG.json | 12 + packages/xarc-react-recoil/CHANGELOG.md | 9 +- packages/xarc-react-recoil/docs/.nojekyll | 1 + .../docs/assets/css/main.css | 2660 ----------------- .../docs/assets/highlight.css | 22 + .../xarc-react-recoil/docs/assets/icons.css | 1043 +++++++ .../docs/assets/{images => }/icons.png | Bin .../docs/assets/{images => }/icons@2x.png | Bin .../xarc-react-recoil/docs/assets/js/main.js | 248 -- .../docs/assets/js/search.js | 1 - .../xarc-react-recoil/docs/assets/main.js | 52 + .../xarc-react-recoil/docs/assets/search.js | 1 + .../xarc-react-recoil/docs/assets/style.css | 1414 +++++++++ .../docs/assets/{images => }/widgets.png | Bin .../docs/assets/{images => }/widgets@2x.png | Bin .../classes/browser.recoil.defaultvalue.html | 180 +- .../browser.recoil.mutablesnapshot.html | 485 +-- .../classes/browser.recoil.recoilstate.html | 261 +- .../browser.recoil.recoilvaluereadonly.html | 225 +- .../docs/classes/browser.recoil.snapshot.html | 441 +-- packages/xarc-react-recoil/docs/index.html | 114 +- .../browser.Recoil.CallbackInterface.html | 1 + .../interfaces/browser.Recoil.RecoilEnv.html | 1 + ...wser.Recoil.SelectorCallbackInterface.html | 1 + .../interfaces/browser.Recoil.StoreID.html | 1 + ....Recoil.TransactionInterface_UNSTABLE.html | 1 + .../browser.Recoil.WrappedValue.html | 1 + .../browser.recoil.atomfamilyoptions.html | 206 -- .../browser.recoil.atomoptions.html | 203 -- ....recoil.readonlyselectorfamilyoptions.html | 237 +- ...rowser.recoil.readonlyselectoroptions.html | 221 +- ...recoil.readwriteselectorfamilyoptions.html | 304 +- ...owser.recoil.readwriteselectoroptions.html | 273 +- .../browser.recoil.recoilrootprops.html | 174 -- .../interfaces/browser.recoil.snapshotid.html | 154 +- packages/xarc-react-recoil/docs/modules.html | 118 +- .../browser.Recoil.RecoilLoadable.html | 15 + .../docs/modules/browser.Recoil.atom.html | 1 + .../docs/modules/browser.Recoil.selector.html | 1 + .../docs/modules/browser.html | 159 +- .../docs/modules/browser.recoil.html | 1829 +----------- .../docs/modules/common.html | 291 +- .../xarc-react-recoil/docs/modules/node.html | 162 +- packages/xarc-react-recoil/package.json | 2 +- .../xarc-react-recoil/src/common/index.tsx | 1 - .../CHANGELOG.json | 12 + .../xarc-react-redux-observable/CHANGELOG.md | 9 +- .../docs/modules/common.html | 4 +- .../xarc-react-redux-observable/package.json | 2 +- .../src/common/index.tsx | 1 + packages/xarc-react-redux-saga/CHANGELOG.json | 12 + packages/xarc-react-redux-saga/CHANGELOG.md | 9 +- .../docs/modules/common.html | 4 +- packages/xarc-react-redux-saga/package.json | 2 +- .../src/common/index.tsx | 1 - packages/xarc-react-router/CHANGELOG.json | 12 + packages/xarc-react-router/CHANGELOG.md | 9 +- packages/xarc-react-router/docs/.nojekyll | 1 + .../docs/assets/css/main.css | 2660 ----------------- .../docs/assets/highlight.css | 22 + .../xarc-react-router/docs/assets/icons.css | 1043 +++++++ .../docs/assets/{images => }/icons.png | Bin .../docs/assets/{images => }/icons@2x.png | Bin .../xarc-react-router/docs/assets/js/main.js | 248 -- .../docs/assets/js/search.js | 1 - .../xarc-react-router/docs/assets/main.js | 52 + .../xarc-react-router/docs/assets/search.js | 1 + .../xarc-react-router/docs/assets/style.css | 1414 +++++++++ .../docs/assets/{images => }/widgets.png | Bin .../docs/assets/{images => }/widgets@2x.png | Bin ...r.ReactRouterDom.AbortedDeferredError.html | 6 + ...browser.ReactRouterDom.NavigationType.html | 15 + packages/xarc-react-router/docs/index.html | 181 +- .../browser.BrowserRouterProps.html | 1 + .../interfaces/browser.FetcherFormProps.html | 164 + .../browser.FetcherSubmitFunction.html | 3 + .../docs/interfaces/browser.FormProps.html | 172 ++ .../interfaces/browser.HashRouterProps.html | 1 + .../browser.HistoryRouterProps.html | 1 + .../docs/interfaces/browser.LinkProps.html | 146 + .../docs/interfaces/browser.NavLinkProps.html | 146 + .../browser.ReactRouter.FutureConfig.html | 1 + ...browser.ReactRouterDom.ActionFunction.html | 3 + ...ser.ReactRouterDom.ActionFunctionArgs.html | 3 + .../browser.ReactRouterDom.AwaitProps.html | 1 + ...ser.ReactRouterDom.BrowserRouterProps.html | 1 + ...browser.ReactRouterDom.DataRouteMatch.html | 9 + ...owser.ReactRouterDom.FetcherFormProps.html | 164 + ....ReactRouterDom.FetcherSubmitFunction.html | 3 + .../browser.ReactRouterDom.FormProps.html | 172 ++ ...erDom.GetScrollRestorationKeyFunction.html | 4 + ...rowser.ReactRouterDom.HashRouterProps.html | 1 + ...ser.ReactRouterDom.HistoryRouterProps.html | 1 + ...owser.ReactRouterDom.IndexRouteObject.html | 1 + ...rowser.ReactRouterDom.IndexRouteProps.html | 1 + ...owser.ReactRouterDom.LayoutRouteProps.html | 1 + ...wser.ReactRouterDom.LazyRouteFunction.html | 4 + .../browser.ReactRouterDom.LinkProps.html | 146 + ...browser.ReactRouterDom.LoaderFunction.html | 3 + ...ser.ReactRouterDom.LoaderFunctionArgs.html | 3 + .../browser.ReactRouterDom.Location.html | 16 + ...wser.ReactRouterDom.MemoryRouterProps.html | 1 + .../browser.ReactRouterDom.NavLinkProps.html | 146 + ...owser.ReactRouterDom.NavigateFunction.html | 5 + ...rowser.ReactRouterDom.NavigateOptions.html | 1 + .../browser.ReactRouterDom.NavigateProps.html | 1 + .../browser.ReactRouterDom.Navigator.html | 24 + ...er.ReactRouterDom.NonIndexRouteObject.html | 1 + .../browser.ReactRouterDom.OutletProps.html | 1 + .../browser.ReactRouterDom.Path.html | 9 + .../browser.ReactRouterDom.PathMatch.html | 11 + .../browser.ReactRouterDom.PathPattern.html | 12 + ...browser.ReactRouterDom.PathRouteProps.html | 1 + .../browser.ReactRouterDom.RouteMatch.html | 9 + .../browser.ReactRouterDom.RouterProps.html | 1 + ...er.ReactRouterDom.RouterProviderProps.html | 1 + .../browser.ReactRouterDom.RoutesProps.html | 1 + ...ReactRouterDom.ScrollRestorationProps.html | 1 + ...actRouterDom.ShouldRevalidateFunction.html | 7 + ...browser.ReactRouterDom.SubmitFunction.html | 3 + .../browser.ReactRouterDom.SubmitOptions.html | 23 + .../browser.ScrollRestorationProps.html | 1 + .../interfaces/browser.SubmitFunction.html | 3 + .../interfaces/common.BrowserRouterProps.html | 1 + .../interfaces/common.FetcherFormProps.html | 164 + .../common.FetcherSubmitFunction.html | 3 + .../docs/interfaces/common.FormProps.html | 172 ++ .../interfaces/common.HashRouterProps.html | 1 + .../interfaces/common.HistoryRouterProps.html | 1 + .../docs/interfaces/common.LinkProps.html | 146 + .../docs/interfaces/common.NavLinkProps.html | 146 + .../common.ScrollRestorationProps.html | 1 + .../interfaces/common.SubmitFunction.html | 3 + .../interfaces/node.BrowserRouterProps.html | 1 + .../interfaces/node.FetcherFormProps.html | 164 + .../node.FetcherSubmitFunction.html | 3 + .../docs/interfaces/node.FormProps.html | 172 ++ .../docs/interfaces/node.HashRouterProps.html | 1 + .../interfaces/node.HistoryRouterProps.html | 1 + .../docs/interfaces/node.LinkProps.html | 146 + .../docs/interfaces/node.NavLinkProps.html | 146 + .../node.ScrollRestorationProps.html | 1 + .../docs/interfaces/node.SubmitFunction.html | 3 + packages/xarc-react-router/docs/modules.html | 127 +- .../docs/modules/browser.ReactRouter.html | 1 + ...wser.ReactRouterDom.ScrollRestoration.html | 1 + .../docs/modules/browser.ReactRouterDom.html | 229 ++ ...ReactRouterDom.unstable_HistoryRouter.html | 1 + .../modules/browser.ScrollRestoration.html | 1 + .../docs/modules/browser.html | 240 +- .../modules/browser_react_router_browser.html | 178 +- .../modules/common.ScrollRestoration.html | 1 + .../docs/modules/common.html | 297 +- .../docs/modules/node.ScrollRestoration.html | 1 + .../xarc-react-router/docs/modules/node.html | 230 +- .../docs/modules/node_react_router_node.html | 178 +- packages/xarc-react-router/package.json | 2 +- .../xarc-react-router/src/browser/index.ts | 1 + samples/subapp2-basic/package.json | 4 +- samples/subapp2-poc/package.json | 6 +- 254 files changed, 11738 insertions(+), 45133 deletions(-) delete mode 100644 common/changes/@xarc/react-query/release-08-29-2023_2023-08-29-22-10.json delete mode 100644 common/changes/@xarc/react-recoil/release-08-29-2023_2023-08-29-22-10.json delete mode 100644 common/changes/@xarc/react-redux-observable/release-08-29-2023_2023-08-29-22-10.json delete mode 100644 common/changes/@xarc/react-redux-saga/release-08-29-2023_2023-08-29-22-10.json delete mode 100644 common/changes/@xarc/react-router/release-08-29-2023_2023-08-29-22-10.json create mode 100644 packages/xarc-react-query/docs/.nojekyll delete mode 100644 packages/xarc-react-query/docs/assets/css/main.css create mode 100644 packages/xarc-react-query/docs/assets/highlight.css create mode 100644 packages/xarc-react-query/docs/assets/icons.css rename packages/xarc-react-query/docs/assets/{images => }/icons.png (100%) rename packages/xarc-react-query/docs/assets/{images => }/icons@2x.png (100%) delete mode 100644 packages/xarc-react-query/docs/assets/js/main.js delete mode 100644 packages/xarc-react-query/docs/assets/js/search.js create mode 100644 packages/xarc-react-query/docs/assets/main.js create mode 100644 packages/xarc-react-query/docs/assets/search.js create mode 100644 packages/xarc-react-query/docs/assets/style.css rename packages/xarc-react-query/docs/assets/{images => }/widgets.png (100%) rename packages/xarc-react-query/docs/assets/{images => }/widgets@2x.png (100%) create mode 100644 packages/xarc-react-query/docs/classes/browser.Mutation.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.CancelOptions.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.DehydrateOptions.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.DehydratedState.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.HydrateOptions.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.HydrateProps.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.MutationObserverBaseResult.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.MutationObserverErrorResult.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.MutationObserverIdleResult.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.MutationObserverLoadingResult.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.MutationObserverSuccessResult.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.QueryClientConfig.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.RefetchPageFilters.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.RefetchQueryFilters.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.ResetQueryFilters.html create mode 100644 packages/xarc-react-query/docs/interfaces/browser.SetDataOptions.html delete mode 100644 packages/xarc-react-query/docs/interfaces/browser.mutationobserverresult.html delete mode 100644 packages/xarc-react-query/docs/interfaces/browser.usemutationresult.html create mode 100644 packages/xarc-react-recoil/docs/.nojekyll delete mode 100644 packages/xarc-react-recoil/docs/assets/css/main.css create mode 100644 packages/xarc-react-recoil/docs/assets/highlight.css create mode 100644 packages/xarc-react-recoil/docs/assets/icons.css rename packages/xarc-react-recoil/docs/assets/{images => }/icons.png (100%) rename packages/xarc-react-recoil/docs/assets/{images => }/icons@2x.png (100%) delete mode 100644 packages/xarc-react-recoil/docs/assets/js/main.js delete mode 100644 packages/xarc-react-recoil/docs/assets/js/search.js create mode 100644 packages/xarc-react-recoil/docs/assets/main.js create mode 100644 packages/xarc-react-recoil/docs/assets/search.js create mode 100644 packages/xarc-react-recoil/docs/assets/style.css rename packages/xarc-react-recoil/docs/assets/{images => }/widgets.png (100%) rename packages/xarc-react-recoil/docs/assets/{images => }/widgets@2x.png (100%) create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.CallbackInterface.html create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.RecoilEnv.html create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.SelectorCallbackInterface.html create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.StoreID.html create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.TransactionInterface_UNSTABLE.html create mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.Recoil.WrappedValue.html delete mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomfamilyoptions.html delete mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomoptions.html delete mode 100644 packages/xarc-react-recoil/docs/interfaces/browser.recoil.recoilrootprops.html create mode 100644 packages/xarc-react-recoil/docs/modules/browser.Recoil.RecoilLoadable.html create mode 100644 packages/xarc-react-recoil/docs/modules/browser.Recoil.atom.html create mode 100644 packages/xarc-react-recoil/docs/modules/browser.Recoil.selector.html create mode 100644 packages/xarc-react-router/docs/.nojekyll delete mode 100644 packages/xarc-react-router/docs/assets/css/main.css create mode 100644 packages/xarc-react-router/docs/assets/highlight.css create mode 100644 packages/xarc-react-router/docs/assets/icons.css rename packages/xarc-react-router/docs/assets/{images => }/icons.png (100%) rename packages/xarc-react-router/docs/assets/{images => }/icons@2x.png (100%) delete mode 100644 packages/xarc-react-router/docs/assets/js/main.js delete mode 100644 packages/xarc-react-router/docs/assets/js/search.js create mode 100644 packages/xarc-react-router/docs/assets/main.js create mode 100644 packages/xarc-react-router/docs/assets/search.js create mode 100644 packages/xarc-react-router/docs/assets/style.css rename packages/xarc-react-router/docs/assets/{images => }/widgets.png (100%) rename packages/xarc-react-router/docs/assets/{images => }/widgets@2x.png (100%) create mode 100644 packages/xarc-react-router/docs/classes/browser.ReactRouterDom.AbortedDeferredError.html create mode 100644 packages/xarc-react-router/docs/enums/browser.ReactRouterDom.NavigationType.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.BrowserRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.FetcherFormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.FetcherSubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.FormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.HashRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.HistoryRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.LinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.NavLinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouter.FutureConfig.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunctionArgs.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.AwaitProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.BrowserRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.DataRouteMatch.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherFormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherSubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.GetScrollRestorationKeyFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HashRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HistoryRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteObject.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LayoutRouteProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LazyRouteFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunctionArgs.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Location.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.MemoryRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavLinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateOptions.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Navigator.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NonIndexRouteObject.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.OutletProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Path.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathMatch.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathPattern.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathRouteProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouteMatch.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProviderProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RoutesProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ScrollRestorationProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ShouldRevalidateFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitOptions.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.ScrollRestorationProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/browser.SubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.BrowserRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.FetcherFormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.FetcherSubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.FormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.HashRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.HistoryRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.LinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.NavLinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.ScrollRestorationProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/common.SubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.BrowserRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.FetcherFormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.FetcherSubmitFunction.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.FormProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.HashRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.HistoryRouterProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.LinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.NavLinkProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.ScrollRestorationProps.html create mode 100644 packages/xarc-react-router/docs/interfaces/node.SubmitFunction.html create mode 100644 packages/xarc-react-router/docs/modules/browser.ReactRouter.html create mode 100644 packages/xarc-react-router/docs/modules/browser.ReactRouterDom.ScrollRestoration.html create mode 100644 packages/xarc-react-router/docs/modules/browser.ReactRouterDom.html create mode 100644 packages/xarc-react-router/docs/modules/browser.ReactRouterDom.unstable_HistoryRouter.html create mode 100644 packages/xarc-react-router/docs/modules/browser.ScrollRestoration.html create mode 100644 packages/xarc-react-router/docs/modules/common.ScrollRestoration.html create mode 100644 packages/xarc-react-router/docs/modules/node.ScrollRestoration.html diff --git a/common/changes/@xarc/react-query/release-08-29-2023_2023-08-29-22-10.json b/common/changes/@xarc/react-query/release-08-29-2023_2023-08-29-22-10.json deleted file mode 100644 index c76a04506..000000000 --- a/common/changes/@xarc/react-query/release-08-29-2023_2023-08-29-22-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@xarc/react-query", - "comment": "", - "type": "none" - } - ], - "packageName": "@xarc/react-query" -} \ No newline at end of file diff --git a/common/changes/@xarc/react-recoil/release-08-29-2023_2023-08-29-22-10.json b/common/changes/@xarc/react-recoil/release-08-29-2023_2023-08-29-22-10.json deleted file mode 100644 index 4f1fbb32d..000000000 --- a/common/changes/@xarc/react-recoil/release-08-29-2023_2023-08-29-22-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@xarc/react-recoil", - "comment": "", - "type": "none" - } - ], - "packageName": "@xarc/react-recoil" -} \ No newline at end of file diff --git a/common/changes/@xarc/react-redux-observable/release-08-29-2023_2023-08-29-22-10.json b/common/changes/@xarc/react-redux-observable/release-08-29-2023_2023-08-29-22-10.json deleted file mode 100644 index c9eade913..000000000 --- a/common/changes/@xarc/react-redux-observable/release-08-29-2023_2023-08-29-22-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@xarc/react-redux-observable", - "comment": "", - "type": "none" - } - ], - "packageName": "@xarc/react-redux-observable" -} \ No newline at end of file diff --git a/common/changes/@xarc/react-redux-saga/release-08-29-2023_2023-08-29-22-10.json b/common/changes/@xarc/react-redux-saga/release-08-29-2023_2023-08-29-22-10.json deleted file mode 100644 index b2633ec48..000000000 --- a/common/changes/@xarc/react-redux-saga/release-08-29-2023_2023-08-29-22-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@xarc/react-redux-saga", - "comment": "", - "type": "none" - } - ], - "packageName": "@xarc/react-redux-saga" -} \ No newline at end of file diff --git a/common/changes/@xarc/react-router/release-08-29-2023_2023-08-29-22-10.json b/common/changes/@xarc/react-router/release-08-29-2023_2023-08-29-22-10.json deleted file mode 100644 index ee52b24bf..000000000 --- a/common/changes/@xarc/react-router/release-08-29-2023_2023-08-29-22-10.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@xarc/react-router", - "comment": "", - "type": "none" - } - ], - "packageName": "@xarc/react-router" -} \ No newline at end of file diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 19bee545c..62aeddc85 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -3414,7 +3414,7 @@ packages: resolution: {integrity: sha512-/19t63pFYU0ikrdbXKBWj9PCdnKyTd0Qkz0X91Ta081cYsq90OxYdcWwK/dwEoDa6dtXgj2HJfmzgq+QZTHdmQ==} dependencies: '@types/chai': 4.3.6 - '@types/sinon': 10.0.16 + '@types/sinon': 9.0.11 dev: false /@types/sinon/10.0.16: @@ -6533,7 +6533,7 @@ packages: hasBin: true dependencies: caniuse-lite: 1.0.30001528 - electron-to-chromium: 1.4.510 + electron-to-chromium: 1.4.511 dev: false /browserslist/4.21.10: @@ -6542,7 +6542,7 @@ packages: hasBin: true dependencies: caniuse-lite: 1.0.30001528 - electron-to-chromium: 1.4.510 + electron-to-chromium: 1.4.511 node-releases: 2.0.13 update-browserslist-db: 1.0.11_browserslist@4.21.10 dev: false @@ -8326,8 +8326,8 @@ packages: xaa: 1.7.3 dev: false - /electron-to-chromium/1.4.510: - resolution: {integrity: sha512-xPfLIPFcN/WLXBpQ/K4UgE98oUBO5Tia6BD4rkSR0wE7ep/PwBVlgvPJQrIBpmJGVAmUzwPKuDbVt9XV6+uC2g==} + /electron-to-chromium/1.4.511: + resolution: {integrity: sha512-udHyLfdy390CObLy3uFQitCBvK+WxWu6WZWQMBzO/npNiRy6tanDKR1c/F6OImfAiSt1ylgNszPJBxix2c0w3w==} dev: false /emittery/0.7.2: @@ -20379,7 +20379,7 @@ packages: dev: false file:projects/create-app.tgz_uglify-js@2.8.29: - resolution: {integrity: sha512-T0nJBISoCdo8W6c3FrfQ7gUXx3eL41EH9xn1wRKbB8WzfSoFpImamAoZf8xaBX07w32oSfjijTsH0IlQh6JbdA==, tarball: file:projects/create-app.tgz} + resolution: {integrity: sha512-8iK3svduLZaRTYBp8YR1fNmTtJjfSy968Vb4rbBQbtnAa643kHl2AlHTGxWiuzBUZOf9FlOvJoXbhHVbotKKhw==, tarball: file:projects/create-app.tgz} id: file:projects/create-app.tgz name: '@rush-temp/create-app' version: 0.0.0 @@ -21083,7 +21083,7 @@ packages: dev: false file:projects/react-redux-observable.tgz: - resolution: {integrity: sha512-qQElYVpD9bBZTNCxYuLhS3fhyt7MhE9yFI/0S0WphCPL/LIbvi6zBQ28mjHE3/AEH1d7UjOaLe3qOk8jH5tyUA==, tarball: file:projects/react-redux-observable.tgz} + resolution: {integrity: sha512-eQ8FV70GN6//F1SBLY7uWASSGdW2weOMjRsuuFtRlKZ7+1eSgTzR6S88H2ek1LZyU/bP220A6p41kLedD8pbkA==, tarball: file:projects/react-redux-observable.tgz} name: '@rush-temp/react-redux-observable' version: 0.0.0 dependencies: @@ -21126,7 +21126,7 @@ packages: dev: false file:projects/react-redux-saga.tgz: - resolution: {integrity: sha512-wcm85tAm2weP+BTr6tHYel3JGE/inp61WE6UDHdtbwofQgDluN4iEbfXwMchPZp+OsVT7UjWZpk0Jd+bCBuWsg==, tarball: file:projects/react-redux-saga.tgz} + resolution: {integrity: sha512-xzZXpoYxad99VQt0Vxj377AwpGOwnKJS9+em2KHtGMKJC3Qil44ECt4oW/CLM8+PoWLzRb84difqtMPFxZ0/AA==, tarball: file:projects/react-redux-saga.tgz} name: '@rush-temp/react-redux-saga' version: 0.0.0 dependencies: @@ -21580,7 +21580,7 @@ packages: dev: false file:projects/subapp2-basic.tgz: - resolution: {integrity: sha512-qQlGWuA7nuAKHpHvCCJnEOTZkt5dmh+K+M5YWu7Ydy3g3zZ9ypUQguKeo6nCW0BMpCEM7I5fWFLi0+zwXJy4LQ==, tarball: file:projects/subapp2-basic.tgz} + resolution: {integrity: sha512-YV7vjvhwzErpALnINZrbHOgl1TmOlKh6rO4o0yrB75CD4xxMNB2bbzhBJbjL5NdQuN2Tx7W6SAkuQ0pEGZg0hQ==, tarball: file:projects/subapp2-basic.tgz} name: '@rush-temp/subapp2-basic' version: 0.0.0 dependencies: @@ -21600,7 +21600,7 @@ packages: dev: false file:projects/subapp2-poc.tgz: - resolution: {integrity: sha512-OfArntiAgLqz9oN5tEGQttYRbjnXJp7DNKqdM5PsyIwx5qRGNhg15RJGfrovrKAJ/uk6oUSJcrlzxeiw4y3rHQ==, tarball: file:projects/subapp2-poc.tgz} + resolution: {integrity: sha512-JMZHKNRmg6lRWtXzFF//nR5lA1C1RDce5yl5CAD3EA233+mWgWL314y0LQWBnhoLxIzCwR4FOxEpbNnaFYXYdQ==, tarball: file:projects/subapp2-poc.tgz} name: '@rush-temp/subapp2-poc' version: 0.0.0 dependencies: diff --git a/packages/xarc-create-app/package.json b/packages/xarc-create-app/package.json index 6c6c072c2..db9e4bc18 100644 --- a/packages/xarc-create-app/package.json +++ b/packages/xarc-create-app/package.json @@ -39,7 +39,7 @@ "@xarc/app-dev": "^11.0.5", "@xarc/module-dev": "^2.2.4", "@xarc/react": "^1.0.3", - "@xarc/react-query": "^1.0.2", + "@xarc/react-query": "^1.0.3", "@xarc/react-redux": "^1.1.2", "babel-loader": "^9.1.3", "chai": "^4.2.0", diff --git a/packages/xarc-react-query/CHANGELOG.json b/packages/xarc-react-query/CHANGELOG.json index ce16d28d6..20bb5ceff 100644 --- a/packages/xarc-react-query/CHANGELOG.json +++ b/packages/xarc-react-query/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@xarc/react-query", "entries": [ + { + "version": "1.0.3", + "tag": "@xarc/react-query_v1.0.3", + "date": "Thu, 07 Sep 2023 22:19:14 GMT", + "comments": { + "patch": [ + { + "comment": "Minor change to force publish esm bundles" + } + ] + } + }, { "version": "1.0.2", "tag": "@xarc/react-query_v1.0.2", diff --git a/packages/xarc-react-query/CHANGELOG.md b/packages/xarc-react-query/CHANGELOG.md index 1e1bc8187..198a201dd 100644 --- a/packages/xarc-react-query/CHANGELOG.md +++ b/packages/xarc-react-query/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @xarc/react-query -This log was last generated on Tue, 29 Aug 2023 14:57:37 GMT and should not be manually modified. +This log was last generated on Thu, 07 Sep 2023 22:19:14 GMT and should not be manually modified. + +## 1.0.3 +Thu, 07 Sep 2023 22:19:14 GMT + +### Patches + +- Minor change to force publish esm bundles ## 1.0.2 Tue, 29 Aug 2023 14:57:37 GMT diff --git a/packages/xarc-react-query/docs/.nojekyll b/packages/xarc-react-query/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/packages/xarc-react-query/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/xarc-react-query/docs/assets/css/main.css b/packages/xarc-react-query/docs/assets/css/main.css deleted file mode 100644 index 46571c27c..000000000 --- a/packages/xarc-react-query/docs/assets/css/main.css +++ /dev/null @@ -1,2660 +0,0 @@ -:root { - --color-background: #fdfdfd; - --color-text: #222; - --color-text-aside: #707070; - --color-link: #4da6ff; - --color-menu-divider: #eee; - --color-menu-divider-focus: #000; - --color-menu-label: #707070; - --color-panel: #fff; - --color-panel-divider: #eee; - --color-comment-tag: #707070; - --color-comment-tag-text: #fff; - --color-code-background: rgba(0, 0, 0, 0.04); - --color-ts: #9600ff; - --color-ts-interface: #647f1b; - --color-ts-enum: #937210; - --color-ts-class: #0672de; - --color-ts-private: #707070; - --color-toolbar: #fff; - --color-toolbar-text: #333; -} - -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * * HTML5 display definitions - * * ========================================================================== */ -/** - * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; -} - -/** - * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; -} - -/** - * * Prevent modern browsers from displaying `audio` without controls. - * * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * * Known issue: no IE 6 support. */ -[hidden] { - display: none; -} - -/* ========================================================================== - * * Base - * * ========================================================================== */ -/** - * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * * `em` units. - * * 2. Prevent iOS text size adjust after orientation change, without disabling - * * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; -} - -/** - * * Address `font-family` inconsistency between `textarea` and other form - * * elements. */ -button, input, select, textarea { - font-family: sans-serif; -} - -/** - * * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; -} - -/* ========================================================================== - * * Links - * * ========================================================================== */ -/** - * * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; -} -a:active, a:hover { - outline: 0; -} - -/** - * * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * * Typography - * * ========================================================================== */ -/** - * * Address font sizes and margins set differently in IE 6/7. - * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -/** - * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; -} - -blockquote { - margin: 1em 40px; -} - -/** - * * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; -} - -/** - * * Address differences between Firefox and other browsers. - * * Known issue: no IE 6/7 normalization. */ -hr { - -moz-box-sizing: content-box; - box-sizing: content-box; - height: 0; -} - -/** - * * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; -} - -/** - * * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; -} - -/** - * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: "courier new", monospace; - font-size: 1em; -} - -/** - * * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -/** - * * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; -} -q:before, q:after { - content: ""; - content: none; -} - -/** - * * Address `quotes` property not supported in Safari 4. */ -/** - * * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; -} - -/** - * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* ========================================================================== - * * Lists - * * ========================================================================== */ -/** - * * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -/** - * * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; -} - -/** - * * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; -} - -/* ========================================================================== - * * Embedded content - * * ========================================================================== */ -/** - * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; -} - -/* 2 */ -/** - * * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; -} - -/* ========================================================================== - * * Figures - * * ========================================================================== */ -/** - * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; -} - -/* ========================================================================== - * * Forms - * * ========================================================================== */ -/** - * * Correct margin displayed oddly in IE 6/7. */ -/** - * * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * * 1. Correct color not being inherited in IE 6/7/8/9. - * * 2. Correct text not wrapping in Firefox 3. - * * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; -} - -/* 3 */ -/** - * * 1. Correct font size not being inherited in all browsers. - * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * * and Chrome. - * * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; -} - -/* 3 */ -/** - * * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * * the UA stylesheet. */ -button, input { - line-height: normal; -} - -/** - * * Address inconsistent `text-transform` inheritance for `button` and `select`. - * * All other form control elements do not inherit `text-transform` values. - * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; -} - -/** - * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * * and `video` controls. - * * 2. Correct inability to style clickable `input` types in iOS. - * * 3. Improve usability and consistency of cursor style between image-type - * * `input` and others. - * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * * Known issue: inner spacing remains in IE 6. */ -button, html input[type=button] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -input[type=reset], input[type=submit] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -/** - * * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; -} - -/** - * * 1. Address box sizing set to content-box in IE 8/9. - * * 2. Remove excess padding in IE 8/9. - * * 3. Remove excess padding in IE 7. - * * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ -} -input[type=checkbox], input[type=radio] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; -} -input[type=search] { - -webkit-appearance: textfield; - /* 1 */ - -moz-box-sizing: content-box; - -webkit-box-sizing: content-box; - /* 2 */ - box-sizing: content-box; -} -input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * * (include `-moz` to future-proof). */ -/** - * * Remove inner padding and search cancel button in Safari 5 and Chrome - * * on OS X. */ -/** - * * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; -} - -/* 2 */ -/* ========================================================================== - * * Tables - * * ========================================================================== */ -/** - * * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; -} - -ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-1 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-1 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-1 { - width: 8.3333333333%; -} - -.offset-1 { - margin-left: 8.3333333333%; -} - -.col-2 { - width: 16.6666666667%; -} - -.offset-2 { - margin-left: 16.6666666667%; -} - -.col-3 { - width: 25%; -} - -.offset-3 { - margin-left: 25%; -} - -.col-4 { - width: 33.3333333333%; -} - -.offset-4 { - margin-left: 33.3333333333%; -} - -.col-5 { - width: 41.6666666667%; -} - -.offset-5 { - margin-left: 41.6666666667%; -} - -.col-6 { - width: 50%; -} - -.offset-6 { - margin-left: 50%; -} - -.col-7 { - width: 58.3333333333%; -} - -.offset-7 { - margin-left: 58.3333333333%; -} - -.col-8 { - width: 66.6666666667%; -} - -.offset-8 { - margin-left: 66.6666666667%; -} - -.col-9 { - width: 75%; -} - -.offset-9 { - margin-left: 75%; -} - -.col-10 { - width: 83.3333333333%; -} - -.offset-10 { - margin-left: 83.3333333333%; -} - -.col-11 { - width: 91.6666666667%; -} - -.offset-11 { - margin-left: 91.6666666667%; -} - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: var(--color-code-background); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, .tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; - } - html.default .col-menu { - width: 28%; - } - html.default .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; - } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html.default .col-menu > *:last-child { - padding-bottom: 20px; - } - html.default .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; - } - html.default.to-has-menu header, -html.default.to-has-menu footer, -html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; - } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; - } - html.default.from-has-menu header, -html.default.from-has-menu footer, -html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; - } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - html.default.has-menu body { - overflow: hidden; - } - html.default.has-menu .overlay { - visibility: visible; - } - html.default.has-menu header, -html.default.has-menu footer, -html.default.has-menu .col-content { - transform: translate(-25%, 0); - } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -html.minimal .container { - margin: 0; -} -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; -} -html.minimal .content-wrap { - padding-left: 300px; -} -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; -} -html.minimal .tsd-member .tsd-member { - margin-left: 0; -} -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; -} -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; -} -html.minimal footer { - background-color: transparent; -} -html.minimal footer .container { - padding: 0; -} -html.minimal .tsd-generator { - padding: 0; -} -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; - } - html.minimal .content-wrap { - padding-left: 0; - } -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, -#tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member a[data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member a[data-tsd-kind=Interface] { - color: var(--color-ts-interface); -} -.tsd-member a[data-tsd-kind=Enum] { - color: var(--color-ts-enum); -} -.tsd-member a[data-tsd-kind=Class] { - color: var(--color-ts-class); -} -.tsd-member a[data-tsd-kind=Private] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; -} -.tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; -} -.tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, .tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.8; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, .tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; - } -} -input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; -} -input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} diff --git a/packages/xarc-react-query/docs/assets/highlight.css b/packages/xarc-react-query/docs/assets/highlight.css new file mode 100644 index 000000000..bcfb24646 --- /dev/null +++ b/packages/xarc-react-query/docs/assets/highlight.css @@ -0,0 +1,71 @@ +:root { + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #795E26; + --dark-hl-3: #DCDCAA; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #A31515; + --dark-hl-5: #CE9178; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --code-background: var(--dark-code-background); +} } + +body.light { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --code-background: var(--light-code-background); +} + +body.dark { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +pre, code { background: var(--code-background); } diff --git a/packages/xarc-react-query/docs/assets/icons.css b/packages/xarc-react-query/docs/assets/icons.css new file mode 100644 index 000000000..776a3562d --- /dev/null +++ b/packages/xarc-react-query/docs/assets/icons.css @@ -0,0 +1,1043 @@ +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(./icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(./icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -187px; +} diff --git a/packages/xarc-react-query/docs/assets/images/icons.png b/packages/xarc-react-query/docs/assets/icons.png similarity index 100% rename from packages/xarc-react-query/docs/assets/images/icons.png rename to packages/xarc-react-query/docs/assets/icons.png diff --git a/packages/xarc-react-query/docs/assets/images/icons@2x.png b/packages/xarc-react-query/docs/assets/icons@2x.png similarity index 100% rename from packages/xarc-react-query/docs/assets/images/icons@2x.png rename to packages/xarc-react-query/docs/assets/icons@2x.png diff --git a/packages/xarc-react-query/docs/assets/js/main.js b/packages/xarc-react-query/docs/assets/js/main.js deleted file mode 100644 index dc257a868..000000000 --- a/packages/xarc-react-query/docs/assets/js/main.js +++ /dev/null @@ -1,248 +0,0 @@ -/* - * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). - * This devtool is not neither made for production nor for readable output files. - * It uses "eval()" calls to create a separate source file in the browser devtools. - * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) - * or disable the default devtool with "devtool: false". - * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). - */ -/******/ (() => { // webpackBootstrap -/******/ var __webpack_modules__ = ({ - -/***/ "../node_modules/lunr/lunr.js": -/*!************************************!*\ - !*** ../node_modules/lunr/lunr.js ***! - \************************************/ -/***/ ((module, exports, __webpack_require__) => { - -eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); - -/***/ }), - -/***/ "./default/assets/css/main.sass": -/*!**************************************!*\ - !*** ./default/assets/css/main.sass ***! - \**************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); - -/***/ }), - -/***/ "./default/assets/js/src/bootstrap.ts": -/*!********************************************!*\ - !*** ./default/assets/js/src/bootstrap.ts ***! - \********************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Application.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/Application.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Component.ts": -/*!****************************************************!*\ - !*** ./default/assets/js/src/typedoc/Component.ts ***! - \****************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/EventTarget.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Filter.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": -/*!*******************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! - \*******************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Search.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Search.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Signature.ts": -/*!***************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! - \***************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": -/*!*********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! - \*********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); - -/***/ }) - -/******/ }); -/************************************************************************/ -/******/ // The module cache -/******/ var __webpack_module_cache__ = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ // Check if module is in cache -/******/ if(__webpack_module_cache__[moduleId]) { -/******/ return __webpack_module_cache__[moduleId].exports; -/******/ } -/******/ // Create a new module (and put it into the cache) -/******/ var module = __webpack_module_cache__[moduleId] = { -/******/ // no module.id needed -/******/ // no module.loaded needed -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/************************************************************************/ -/******/ /* webpack/runtime/compat get default export */ -/******/ (() => { -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = (module) => { -/******/ var getter = module && module.__esModule ? -/******/ () => module['default'] : -/******/ () => module; -/******/ __webpack_require__.d(getter, { a: getter }); -/******/ return getter; -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/define property getters */ -/******/ (() => { -/******/ // define getter functions for harmony exports -/******/ __webpack_require__.d = (exports, definition) => { -/******/ for(var key in definition) { -/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { -/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); -/******/ } -/******/ } -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/hasOwnProperty shorthand */ -/******/ (() => { -/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) -/******/ })(); -/******/ -/******/ /* webpack/runtime/make namespace object */ -/******/ (() => { -/******/ // define __esModule on exports -/******/ __webpack_require__.r = (exports) => { -/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { -/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); -/******/ } -/******/ Object.defineProperty(exports, '__esModule', { value: true }); -/******/ }; -/******/ })(); -/******/ -/************************************************************************/ -/******/ // startup -/******/ // Load entry module -/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); -/******/ // This entry module used 'exports' so it can't be inlined -/******/ })() -; \ No newline at end of file diff --git a/packages/xarc-react-query/docs/assets/js/search.js b/packages/xarc-react-query/docs/assets/js/search.js deleted file mode 100644 index 939083816..000000000 --- a/packages/xarc-react-query/docs/assets/js/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = {"kinds":{"1":"Module","32":"Variable","64":"Function","1024":"Property","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":1,"name":"browser","url":"modules/browser.html","classes":"tsd-kind-module"},{"id":1,"kind":64,"name":"reactQueryFeature","url":"modules/browser.html#reactqueryfeature-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"browser"},{"id":2,"kind":1,"name":"common/feature-info","url":"modules/common_feature_info.html","classes":"tsd-kind-module"},{"id":3,"kind":32,"name":"featureId","url":"modules/common_feature_info.html#featureid","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"common/feature-info"},{"id":4,"kind":32,"name":"featureSubId","url":"modules/common_feature_info.html#featuresubid","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"common/feature-info"},{"id":5,"kind":1,"name":"common","url":"modules/common.html","classes":"tsd-kind-module"},{"id":6,"kind":4194304,"name":"prefetchQueryMethod","url":"modules/common.html#prefetchquerymethod","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":7,"kind":65536,"name":"__type","url":"modules/common.html#prefetchquerymethod.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"common.prefetchQueryMethod"},{"id":8,"kind":4194304,"name":"PrefetchQueryServerModule","url":"modules/common.html#prefetchqueryservermodule","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":9,"kind":65536,"name":"__type","url":"modules/common.html#prefetchqueryservermodule.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"common.PrefetchQueryServerModule"},{"id":10,"kind":1024,"name":"prefetchQuery","url":"modules/common.html#prefetchqueryservermodule.__type.prefetchquery","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.PrefetchQueryServerModule.__type"},{"id":11,"kind":4194304,"name":"ReactQueryFeatureOptions","url":"modules/common.html#reactqueryfeatureoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":12,"kind":65536,"name":"__type","url":"modules/common.html#reactqueryfeatureoptions.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"common.ReactQueryFeatureOptions"},{"id":13,"kind":1024,"name":"React","url":"modules/common.html#reactqueryfeatureoptions.__type-1.react","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactQueryFeatureOptions.__type"},{"id":14,"kind":1024,"name":"queryClient","url":"modules/common.html#reactqueryfeatureoptions.__type-1.queryclient-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactQueryFeatureOptions.__type"},{"id":15,"kind":1024,"name":"serverModule","url":"modules/common.html#reactqueryfeatureoptions.__type-1.servermodule","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactQueryFeatureOptions.__type"},{"id":16,"kind":1024,"name":"exportName","url":"modules/common.html#reactqueryfeatureoptions.__type-1.exportname","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactQueryFeatureOptions.__type"},{"id":17,"kind":4194304,"name":"ReactQueryFeature","url":"modules/common.html#reactqueryfeature","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":18,"kind":1,"name":"node","url":"modules/node.html","classes":"tsd-kind-module"},{"id":19,"kind":64,"name":"reactQueryFeature","url":"modules/node.html#reactqueryfeature-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"node"},{"id":20,"kind":16777216,"name":"prefetchQueryMethod","url":"modules/browser.html#prefetchquerymethod","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":21,"kind":16777216,"name":"PrefetchQueryServerModule","url":"modules/browser.html#prefetchqueryservermodule","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":22,"kind":16777216,"name":"ReactQueryFeatureOptions","url":"modules/browser.html#reactqueryfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":23,"kind":16777216,"name":"ReactQueryFeature","url":"modules/browser.html#reactqueryfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":24,"kind":16777216,"name":"dehydrate","url":"modules/common.html#dehydrate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":25,"kind":16777216,"name":"Hydrate","url":"modules/common.html#hydrate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":26,"kind":16777216,"name":"CancelledError","url":"modules/common.html#cancellederror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":27,"kind":16777216,"name":"QueryCache","url":"modules/common.html#querycache","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":28,"kind":16777216,"name":"QueryClient","url":"modules/common.html#queryclient","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":29,"kind":16777216,"name":"QueryObserver","url":"modules/common.html#queryobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":30,"kind":16777216,"name":"QueriesObserver","url":"modules/common.html#queriesobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":31,"kind":16777216,"name":"InfiniteQueryObserver","url":"modules/common.html#infinitequeryobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":32,"kind":16777216,"name":"MutationCache","url":"modules/common.html#mutationcache","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":33,"kind":16777216,"name":"MutationObserver","url":"modules/common.html#mutationobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":34,"kind":16777216,"name":"setLogger","url":"modules/common.html#setlogger","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":35,"kind":16777216,"name":"notifyManager","url":"modules/common.html#notifymanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":36,"kind":16777216,"name":"focusManager","url":"modules/common.html#focusmanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":37,"kind":16777216,"name":"onlineManager","url":"modules/common.html#onlinemanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":38,"kind":16777216,"name":"hashQueryKey","url":"modules/common.html#hashquerykey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":39,"kind":16777216,"name":"isError","url":"modules/common.html#iserror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":40,"kind":16777216,"name":"isCancelledError","url":"modules/common.html#iscancellederror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":41,"kind":16777216,"name":"Query","url":"modules/common.html#query","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":42,"kind":16777216,"name":"Logger","url":"modules/common.html#logger","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":43,"kind":16777216,"name":"QueryKey","url":"modules/common.html#querykey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":44,"kind":16777216,"name":"QueryFunction","url":"modules/common.html#queryfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":45,"kind":16777216,"name":"QueryFunctionContext","url":"modules/common.html#queryfunctioncontext","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":46,"kind":16777216,"name":"InitialDataFunction","url":"modules/common.html#initialdatafunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":47,"kind":16777216,"name":"InitialStaleFunction","url":"modules/common.html#initialstalefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":48,"kind":16777216,"name":"PlaceholderDataFunction","url":"modules/common.html#placeholderdatafunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":49,"kind":16777216,"name":"QueryKeyHashFunction","url":"modules/common.html#querykeyhashfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":50,"kind":16777216,"name":"GetPreviousPageParamFunction","url":"modules/common.html#getpreviouspageparamfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":51,"kind":16777216,"name":"GetNextPageParamFunction","url":"modules/common.html#getnextpageparamfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":52,"kind":16777216,"name":"InfiniteData","url":"modules/common.html#infinitedata","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":53,"kind":16777216,"name":"QueryOptions","url":"modules/common.html#queryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":54,"kind":16777216,"name":"QueryObserverOptions","url":"modules/common.html#queryobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":55,"kind":16777216,"name":"InfiniteQueryObserverOptions","url":"modules/common.html#infinitequeryobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":56,"kind":16777216,"name":"FetchQueryOptions","url":"modules/common.html#fetchqueryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":57,"kind":16777216,"name":"FetchInfiniteQueryOptions","url":"modules/common.html#fetchinfinitequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":58,"kind":16777216,"name":"ResultOptions","url":"modules/common.html#resultoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":59,"kind":16777216,"name":"RefetchOptions","url":"modules/common.html#refetchoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":60,"kind":16777216,"name":"InvalidateQueryFilters","url":"modules/common.html#invalidatequeryfilters","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":61,"kind":16777216,"name":"InvalidateOptions","url":"modules/common.html#invalidateoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":62,"kind":16777216,"name":"ResetOptions","url":"modules/common.html#resetoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":63,"kind":16777216,"name":"FetchNextPageOptions","url":"modules/common.html#fetchnextpageoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":64,"kind":16777216,"name":"FetchPreviousPageOptions","url":"modules/common.html#fetchpreviouspageoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":65,"kind":16777216,"name":"QueryStatus","url":"modules/common.html#querystatus","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":66,"kind":16777216,"name":"QueryObserverBaseResult","url":"modules/common.html#queryobserverbaseresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":67,"kind":16777216,"name":"QueryObserverIdleResult","url":"modules/common.html#queryobserveridleresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":68,"kind":16777216,"name":"QueryObserverLoadingResult","url":"modules/common.html#queryobserverloadingresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":69,"kind":16777216,"name":"QueryObserverLoadingErrorResult","url":"modules/common.html#queryobserverloadingerrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":70,"kind":16777216,"name":"QueryObserverRefetchErrorResult","url":"modules/common.html#queryobserverrefetcherrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":71,"kind":16777216,"name":"QueryObserverSuccessResult","url":"modules/common.html#queryobserversuccessresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":72,"kind":16777216,"name":"QueryObserverResult","url":"modules/common.html#queryobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":73,"kind":16777216,"name":"InfiniteQueryObserverBaseResult","url":"modules/common.html#infinitequeryobserverbaseresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":74,"kind":16777216,"name":"InfiniteQueryObserverIdleResult","url":"modules/common.html#infinitequeryobserveridleresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":75,"kind":16777216,"name":"InfiniteQueryObserverLoadingResult","url":"modules/common.html#infinitequeryobserverloadingresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":76,"kind":16777216,"name":"InfiniteQueryObserverLoadingErrorResult","url":"modules/common.html#infinitequeryobserverloadingerrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":77,"kind":16777216,"name":"InfiniteQueryObserverRefetchErrorResult","url":"modules/common.html#infinitequeryobserverrefetcherrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":78,"kind":16777216,"name":"InfiniteQueryObserverSuccessResult","url":"modules/common.html#infinitequeryobserversuccessresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":79,"kind":16777216,"name":"InfiniteQueryObserverResult","url":"modules/common.html#infinitequeryobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":80,"kind":16777216,"name":"MutationKey","url":"modules/common.html#mutationkey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":81,"kind":16777216,"name":"MutationStatus","url":"modules/common.html#mutationstatus","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":82,"kind":16777216,"name":"MutationFunction","url":"modules/common.html#mutationfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":83,"kind":16777216,"name":"MutationOptions","url":"modules/common.html#mutationoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":84,"kind":16777216,"name":"MutationObserverOptions","url":"modules/common.html#mutationobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":85,"kind":16777216,"name":"MutateOptions","url":"modules/common.html#mutateoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":86,"kind":16777216,"name":"MutateFunction","url":"modules/common.html#mutatefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":87,"kind":16777216,"name":"MutationObserverResult","url":"modules/common.html#mutationobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":88,"kind":16777216,"name":"DefaultOptions","url":"modules/common.html#defaultoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":89,"kind":16777216,"name":"QueryClientProvider","url":"modules/common.html#queryclientprovider","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":90,"kind":16777216,"name":"useQueryClient","url":"modules/common.html#usequeryclient","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":91,"kind":16777216,"name":"QueryErrorResetBoundary","url":"modules/common.html#queryerrorresetboundary","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":92,"kind":16777216,"name":"useQueryErrorResetBoundary","url":"modules/common.html#usequeryerrorresetboundary","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":93,"kind":16777216,"name":"useIsFetching","url":"modules/common.html#useisfetching","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":94,"kind":16777216,"name":"useIsMutating","url":"modules/common.html#useismutating","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":95,"kind":16777216,"name":"useMutation","url":"modules/common.html#usemutation","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":96,"kind":16777216,"name":"useQuery","url":"modules/common.html#usequery","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":97,"kind":16777216,"name":"useQueries","url":"modules/common.html#usequeries","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":98,"kind":16777216,"name":"useInfiniteQuery","url":"modules/common.html#useinfinitequery","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":99,"kind":16777216,"name":"QueryClientProviderProps","url":"modules/common.html#queryclientproviderprops","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":100,"kind":16777216,"name":"QueryErrorResetBoundaryProps","url":"modules/common.html#queryerrorresetboundaryprops","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":101,"kind":16777216,"name":"UseBaseQueryOptions","url":"modules/common.html#usebasequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":102,"kind":16777216,"name":"UseQueryOptions","url":"modules/common.html#usequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":103,"kind":16777216,"name":"UseInfiniteQueryOptions","url":"modules/common.html#useinfinitequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":104,"kind":16777216,"name":"UseBaseQueryResult","url":"modules/common.html#usebasequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":105,"kind":16777216,"name":"UseQueryResult","url":"modules/common.html#usequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":106,"kind":16777216,"name":"UseInfiniteQueryResult","url":"modules/common.html#useinfinitequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":107,"kind":16777216,"name":"UseMutationOptions","url":"modules/common.html#usemutationoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":108,"kind":16777216,"name":"UseMutateFunction","url":"modules/common.html#usemutatefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":109,"kind":16777216,"name":"UseMutateAsyncFunction","url":"modules/common.html#usemutateasyncfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":110,"kind":16777216,"name":"UseMutationResult","url":"modules/common.html#usemutationresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":111,"kind":16777216,"name":"dehydrate","url":"modules/node.html#dehydrate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":112,"kind":16777216,"name":"Hydrate","url":"modules/node.html#hydrate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":113,"kind":16777216,"name":"prefetchQueryMethod","url":"modules/node.html#prefetchquerymethod","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":114,"kind":16777216,"name":"PrefetchQueryServerModule","url":"modules/node.html#prefetchqueryservermodule","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":115,"kind":16777216,"name":"ReactQueryFeatureOptions","url":"modules/node.html#reactqueryfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":116,"kind":16777216,"name":"ReactQueryFeature","url":"modules/node.html#reactqueryfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":117,"kind":16777216,"name":"CancelledError","url":"modules/node.html#cancellederror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":118,"kind":16777216,"name":"QueryCache","url":"modules/node.html#querycache","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":119,"kind":16777216,"name":"QueryClient","url":"modules/node.html#queryclient","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":120,"kind":16777216,"name":"QueryObserver","url":"modules/node.html#queryobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":121,"kind":16777216,"name":"QueriesObserver","url":"modules/node.html#queriesobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":122,"kind":16777216,"name":"InfiniteQueryObserver","url":"modules/node.html#infinitequeryobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":123,"kind":16777216,"name":"MutationCache","url":"modules/node.html#mutationcache","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":124,"kind":16777216,"name":"MutationObserver","url":"modules/node.html#mutationobserver","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":125,"kind":16777216,"name":"setLogger","url":"modules/node.html#setlogger","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":126,"kind":16777216,"name":"notifyManager","url":"modules/node.html#notifymanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":127,"kind":16777216,"name":"focusManager","url":"modules/node.html#focusmanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":128,"kind":16777216,"name":"onlineManager","url":"modules/node.html#onlinemanager","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":129,"kind":16777216,"name":"hashQueryKey","url":"modules/node.html#hashquerykey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":130,"kind":16777216,"name":"isError","url":"modules/node.html#iserror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":131,"kind":16777216,"name":"isCancelledError","url":"modules/node.html#iscancellederror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":132,"kind":16777216,"name":"Query","url":"modules/node.html#query","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":133,"kind":16777216,"name":"Logger","url":"modules/node.html#logger","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":134,"kind":16777216,"name":"QueryKey","url":"modules/node.html#querykey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":135,"kind":16777216,"name":"QueryFunction","url":"modules/node.html#queryfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":136,"kind":16777216,"name":"QueryFunctionContext","url":"modules/node.html#queryfunctioncontext","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":137,"kind":16777216,"name":"InitialDataFunction","url":"modules/node.html#initialdatafunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":138,"kind":16777216,"name":"InitialStaleFunction","url":"modules/node.html#initialstalefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":139,"kind":16777216,"name":"PlaceholderDataFunction","url":"modules/node.html#placeholderdatafunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":140,"kind":16777216,"name":"QueryKeyHashFunction","url":"modules/node.html#querykeyhashfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":141,"kind":16777216,"name":"GetPreviousPageParamFunction","url":"modules/node.html#getpreviouspageparamfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":142,"kind":16777216,"name":"GetNextPageParamFunction","url":"modules/node.html#getnextpageparamfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":143,"kind":16777216,"name":"InfiniteData","url":"modules/node.html#infinitedata","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":144,"kind":16777216,"name":"QueryOptions","url":"modules/node.html#queryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":145,"kind":16777216,"name":"QueryObserverOptions","url":"modules/node.html#queryobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":146,"kind":16777216,"name":"InfiniteQueryObserverOptions","url":"modules/node.html#infinitequeryobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":147,"kind":16777216,"name":"FetchQueryOptions","url":"modules/node.html#fetchqueryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":148,"kind":16777216,"name":"FetchInfiniteQueryOptions","url":"modules/node.html#fetchinfinitequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":149,"kind":16777216,"name":"ResultOptions","url":"modules/node.html#resultoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":150,"kind":16777216,"name":"RefetchOptions","url":"modules/node.html#refetchoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":151,"kind":16777216,"name":"InvalidateQueryFilters","url":"modules/node.html#invalidatequeryfilters","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":152,"kind":16777216,"name":"InvalidateOptions","url":"modules/node.html#invalidateoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":153,"kind":16777216,"name":"ResetOptions","url":"modules/node.html#resetoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":154,"kind":16777216,"name":"FetchNextPageOptions","url":"modules/node.html#fetchnextpageoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":155,"kind":16777216,"name":"FetchPreviousPageOptions","url":"modules/node.html#fetchpreviouspageoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":156,"kind":16777216,"name":"QueryStatus","url":"modules/node.html#querystatus","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":157,"kind":16777216,"name":"QueryObserverBaseResult","url":"modules/node.html#queryobserverbaseresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":158,"kind":16777216,"name":"QueryObserverIdleResult","url":"modules/node.html#queryobserveridleresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":159,"kind":16777216,"name":"QueryObserverLoadingResult","url":"modules/node.html#queryobserverloadingresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":160,"kind":16777216,"name":"QueryObserverLoadingErrorResult","url":"modules/node.html#queryobserverloadingerrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":161,"kind":16777216,"name":"QueryObserverRefetchErrorResult","url":"modules/node.html#queryobserverrefetcherrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":162,"kind":16777216,"name":"QueryObserverSuccessResult","url":"modules/node.html#queryobserversuccessresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":163,"kind":16777216,"name":"QueryObserverResult","url":"modules/node.html#queryobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":164,"kind":16777216,"name":"InfiniteQueryObserverBaseResult","url":"modules/node.html#infinitequeryobserverbaseresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":165,"kind":16777216,"name":"InfiniteQueryObserverIdleResult","url":"modules/node.html#infinitequeryobserveridleresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":166,"kind":16777216,"name":"InfiniteQueryObserverLoadingResult","url":"modules/node.html#infinitequeryobserverloadingresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":167,"kind":16777216,"name":"InfiniteQueryObserverLoadingErrorResult","url":"modules/node.html#infinitequeryobserverloadingerrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":168,"kind":16777216,"name":"InfiniteQueryObserverRefetchErrorResult","url":"modules/node.html#infinitequeryobserverrefetcherrorresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":169,"kind":16777216,"name":"InfiniteQueryObserverSuccessResult","url":"modules/node.html#infinitequeryobserversuccessresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":170,"kind":16777216,"name":"InfiniteQueryObserverResult","url":"modules/node.html#infinitequeryobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":171,"kind":16777216,"name":"MutationKey","url":"modules/node.html#mutationkey","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":172,"kind":16777216,"name":"MutationStatus","url":"modules/node.html#mutationstatus","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":173,"kind":16777216,"name":"MutationFunction","url":"modules/node.html#mutationfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":174,"kind":16777216,"name":"MutationOptions","url":"modules/node.html#mutationoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":175,"kind":16777216,"name":"MutationObserverOptions","url":"modules/node.html#mutationobserveroptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":176,"kind":16777216,"name":"MutateOptions","url":"modules/node.html#mutateoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":177,"kind":16777216,"name":"MutateFunction","url":"modules/node.html#mutatefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":178,"kind":16777216,"name":"MutationObserverResult","url":"modules/node.html#mutationobserverresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":179,"kind":16777216,"name":"DefaultOptions","url":"modules/node.html#defaultoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":180,"kind":16777216,"name":"QueryClientProvider","url":"modules/node.html#queryclientprovider","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":181,"kind":16777216,"name":"useQueryClient","url":"modules/node.html#usequeryclient","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":182,"kind":16777216,"name":"QueryErrorResetBoundary","url":"modules/node.html#queryerrorresetboundary","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":183,"kind":16777216,"name":"useQueryErrorResetBoundary","url":"modules/node.html#usequeryerrorresetboundary","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":184,"kind":16777216,"name":"useIsFetching","url":"modules/node.html#useisfetching","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":185,"kind":16777216,"name":"useIsMutating","url":"modules/node.html#useismutating","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":186,"kind":16777216,"name":"useMutation","url":"modules/node.html#usemutation","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":187,"kind":16777216,"name":"useQuery","url":"modules/node.html#usequery","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":188,"kind":16777216,"name":"useQueries","url":"modules/node.html#usequeries","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":189,"kind":16777216,"name":"useInfiniteQuery","url":"modules/node.html#useinfinitequery","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":190,"kind":16777216,"name":"QueryClientProviderProps","url":"modules/node.html#queryclientproviderprops","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":191,"kind":16777216,"name":"QueryErrorResetBoundaryProps","url":"modules/node.html#queryerrorresetboundaryprops","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":192,"kind":16777216,"name":"UseBaseQueryOptions","url":"modules/node.html#usebasequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":193,"kind":16777216,"name":"UseQueryOptions","url":"modules/node.html#usequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":194,"kind":16777216,"name":"UseInfiniteQueryOptions","url":"modules/node.html#useinfinitequeryoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":195,"kind":16777216,"name":"UseBaseQueryResult","url":"modules/node.html#usebasequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":196,"kind":16777216,"name":"UseQueryResult","url":"modules/node.html#usequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":197,"kind":16777216,"name":"UseInfiniteQueryResult","url":"modules/node.html#useinfinitequeryresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":198,"kind":16777216,"name":"UseMutationOptions","url":"modules/node.html#usemutationoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":199,"kind":16777216,"name":"UseMutateFunction","url":"modules/node.html#usemutatefunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":200,"kind":16777216,"name":"UseMutateAsyncFunction","url":"modules/node.html#usemutateasyncfunction","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":201,"kind":16777216,"name":"UseMutationResult","url":"modules/node.html#usemutationresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,34.484]],["parent/0",[]],["name/1",[1,36.157]],["parent/1",[0,3.427]],["name/2",[2,28.899,3,28.899]],["parent/2",[]],["name/3",[4,49.177]],["parent/3",[2,2.865,3,2.865]],["name/4",[5,49.177]],["parent/4",[2,2.865,3,2.865]],["name/5",[6,7.876]],["parent/5",[]],["name/6",[7,40.686]],["parent/6",[6,0.783]],["name/7",[8,40.686]],["parent/7",[9,4.888]],["name/8",[10,40.686]],["parent/8",[6,0.783]],["name/9",[8,40.686]],["parent/9",[11,4.888]],["name/10",[12,49.177]],["parent/10",[13,4.888]],["name/11",[14,40.686]],["parent/11",[6,0.783]],["name/12",[8,40.686]],["parent/12",[15,4.888]],["name/13",[16,49.177]],["parent/13",[17,3.794]],["name/14",[18,40.686]],["parent/14",[17,3.794]],["name/15",[19,49.177]],["parent/15",[17,3.794]],["name/16",[20,49.177]],["parent/16",[17,3.794]],["name/17",[1,36.157]],["parent/17",[6,0.783]],["name/18",[21,7.768]],["parent/18",[]],["name/19",[1,36.157]],["parent/19",[21,0.772]],["name/20",[7,40.686]],["parent/20",[0,3.427]],["name/21",[10,40.686]],["parent/21",[0,3.427]],["name/22",[14,40.686]],["parent/22",[0,3.427]],["name/23",[1,36.157]],["parent/23",[0,3.427]],["name/24",[22,44.058]],["parent/24",[6,0.783]],["name/25",[23,44.058]],["parent/25",[6,0.783]],["name/26",[24,44.058]],["parent/26",[6,0.783]],["name/27",[25,44.058]],["parent/27",[6,0.783]],["name/28",[18,40.686]],["parent/28",[6,0.783]],["name/29",[26,44.058]],["parent/29",[6,0.783]],["name/30",[27,44.058]],["parent/30",[6,0.783]],["name/31",[28,44.058]],["parent/31",[6,0.783]],["name/32",[29,44.058]],["parent/32",[6,0.783]],["name/33",[30,44.058]],["parent/33",[6,0.783]],["name/34",[31,44.058]],["parent/34",[6,0.783]],["name/35",[32,44.058]],["parent/35",[6,0.783]],["name/36",[33,44.058]],["parent/36",[6,0.783]],["name/37",[34,44.058]],["parent/37",[6,0.783]],["name/38",[35,44.058]],["parent/38",[6,0.783]],["name/39",[36,44.058]],["parent/39",[6,0.783]],["name/40",[37,44.058]],["parent/40",[6,0.783]],["name/41",[38,44.058]],["parent/41",[6,0.783]],["name/42",[39,44.058]],["parent/42",[6,0.783]],["name/43",[40,44.058]],["parent/43",[6,0.783]],["name/44",[41,44.058]],["parent/44",[6,0.783]],["name/45",[42,44.058]],["parent/45",[6,0.783]],["name/46",[43,44.058]],["parent/46",[6,0.783]],["name/47",[44,44.058]],["parent/47",[6,0.783]],["name/48",[45,44.058]],["parent/48",[6,0.783]],["name/49",[46,44.058]],["parent/49",[6,0.783]],["name/50",[47,44.058]],["parent/50",[6,0.783]],["name/51",[48,44.058]],["parent/51",[6,0.783]],["name/52",[49,44.058]],["parent/52",[6,0.783]],["name/53",[50,44.058]],["parent/53",[6,0.783]],["name/54",[51,44.058]],["parent/54",[6,0.783]],["name/55",[52,44.058]],["parent/55",[6,0.783]],["name/56",[53,44.058]],["parent/56",[6,0.783]],["name/57",[54,44.058]],["parent/57",[6,0.783]],["name/58",[55,44.058]],["parent/58",[6,0.783]],["name/59",[56,44.058]],["parent/59",[6,0.783]],["name/60",[57,44.058]],["parent/60",[6,0.783]],["name/61",[58,44.058]],["parent/61",[6,0.783]],["name/62",[59,44.058]],["parent/62",[6,0.783]],["name/63",[60,44.058]],["parent/63",[6,0.783]],["name/64",[61,44.058]],["parent/64",[6,0.783]],["name/65",[62,44.058]],["parent/65",[6,0.783]],["name/66",[63,44.058]],["parent/66",[6,0.783]],["name/67",[64,44.058]],["parent/67",[6,0.783]],["name/68",[65,44.058]],["parent/68",[6,0.783]],["name/69",[66,44.058]],["parent/69",[6,0.783]],["name/70",[67,44.058]],["parent/70",[6,0.783]],["name/71",[68,44.058]],["parent/71",[6,0.783]],["name/72",[69,44.058]],["parent/72",[6,0.783]],["name/73",[70,44.058]],["parent/73",[6,0.783]],["name/74",[71,44.058]],["parent/74",[6,0.783]],["name/75",[72,44.058]],["parent/75",[6,0.783]],["name/76",[73,44.058]],["parent/76",[6,0.783]],["name/77",[74,44.058]],["parent/77",[6,0.783]],["name/78",[75,44.058]],["parent/78",[6,0.783]],["name/79",[76,44.058]],["parent/79",[6,0.783]],["name/80",[77,44.058]],["parent/80",[6,0.783]],["name/81",[78,44.058]],["parent/81",[6,0.783]],["name/82",[79,44.058]],["parent/82",[6,0.783]],["name/83",[80,44.058]],["parent/83",[6,0.783]],["name/84",[81,44.058]],["parent/84",[6,0.783]],["name/85",[82,44.058]],["parent/85",[6,0.783]],["name/86",[83,44.058]],["parent/86",[6,0.783]],["name/87",[84,44.058]],["parent/87",[6,0.783]],["name/88",[85,44.058]],["parent/88",[6,0.783]],["name/89",[86,44.058]],["parent/89",[6,0.783]],["name/90",[87,44.058]],["parent/90",[6,0.783]],["name/91",[88,44.058]],["parent/91",[6,0.783]],["name/92",[89,44.058]],["parent/92",[6,0.783]],["name/93",[90,44.058]],["parent/93",[6,0.783]],["name/94",[91,44.058]],["parent/94",[6,0.783]],["name/95",[92,44.058]],["parent/95",[6,0.783]],["name/96",[93,44.058]],["parent/96",[6,0.783]],["name/97",[94,44.058]],["parent/97",[6,0.783]],["name/98",[95,44.058]],["parent/98",[6,0.783]],["name/99",[96,44.058]],["parent/99",[6,0.783]],["name/100",[97,44.058]],["parent/100",[6,0.783]],["name/101",[98,44.058]],["parent/101",[6,0.783]],["name/102",[99,44.058]],["parent/102",[6,0.783]],["name/103",[100,44.058]],["parent/103",[6,0.783]],["name/104",[101,44.058]],["parent/104",[6,0.783]],["name/105",[102,44.058]],["parent/105",[6,0.783]],["name/106",[103,44.058]],["parent/106",[6,0.783]],["name/107",[104,44.058]],["parent/107",[6,0.783]],["name/108",[105,44.058]],["parent/108",[6,0.783]],["name/109",[106,44.058]],["parent/109",[6,0.783]],["name/110",[107,44.058]],["parent/110",[6,0.783]],["name/111",[22,44.058]],["parent/111",[21,0.772]],["name/112",[23,44.058]],["parent/112",[21,0.772]],["name/113",[7,40.686]],["parent/113",[21,0.772]],["name/114",[10,40.686]],["parent/114",[21,0.772]],["name/115",[14,40.686]],["parent/115",[21,0.772]],["name/116",[1,36.157]],["parent/116",[21,0.772]],["name/117",[24,44.058]],["parent/117",[21,0.772]],["name/118",[25,44.058]],["parent/118",[21,0.772]],["name/119",[18,40.686]],["parent/119",[21,0.772]],["name/120",[26,44.058]],["parent/120",[21,0.772]],["name/121",[27,44.058]],["parent/121",[21,0.772]],["name/122",[28,44.058]],["parent/122",[21,0.772]],["name/123",[29,44.058]],["parent/123",[21,0.772]],["name/124",[30,44.058]],["parent/124",[21,0.772]],["name/125",[31,44.058]],["parent/125",[21,0.772]],["name/126",[32,44.058]],["parent/126",[21,0.772]],["name/127",[33,44.058]],["parent/127",[21,0.772]],["name/128",[34,44.058]],["parent/128",[21,0.772]],["name/129",[35,44.058]],["parent/129",[21,0.772]],["name/130",[36,44.058]],["parent/130",[21,0.772]],["name/131",[37,44.058]],["parent/131",[21,0.772]],["name/132",[38,44.058]],["parent/132",[21,0.772]],["name/133",[39,44.058]],["parent/133",[21,0.772]],["name/134",[40,44.058]],["parent/134",[21,0.772]],["name/135",[41,44.058]],["parent/135",[21,0.772]],["name/136",[42,44.058]],["parent/136",[21,0.772]],["name/137",[43,44.058]],["parent/137",[21,0.772]],["name/138",[44,44.058]],["parent/138",[21,0.772]],["name/139",[45,44.058]],["parent/139",[21,0.772]],["name/140",[46,44.058]],["parent/140",[21,0.772]],["name/141",[47,44.058]],["parent/141",[21,0.772]],["name/142",[48,44.058]],["parent/142",[21,0.772]],["name/143",[49,44.058]],["parent/143",[21,0.772]],["name/144",[50,44.058]],["parent/144",[21,0.772]],["name/145",[51,44.058]],["parent/145",[21,0.772]],["name/146",[52,44.058]],["parent/146",[21,0.772]],["name/147",[53,44.058]],["parent/147",[21,0.772]],["name/148",[54,44.058]],["parent/148",[21,0.772]],["name/149",[55,44.058]],["parent/149",[21,0.772]],["name/150",[56,44.058]],["parent/150",[21,0.772]],["name/151",[57,44.058]],["parent/151",[21,0.772]],["name/152",[58,44.058]],["parent/152",[21,0.772]],["name/153",[59,44.058]],["parent/153",[21,0.772]],["name/154",[60,44.058]],["parent/154",[21,0.772]],["name/155",[61,44.058]],["parent/155",[21,0.772]],["name/156",[62,44.058]],["parent/156",[21,0.772]],["name/157",[63,44.058]],["parent/157",[21,0.772]],["name/158",[64,44.058]],["parent/158",[21,0.772]],["name/159",[65,44.058]],["parent/159",[21,0.772]],["name/160",[66,44.058]],["parent/160",[21,0.772]],["name/161",[67,44.058]],["parent/161",[21,0.772]],["name/162",[68,44.058]],["parent/162",[21,0.772]],["name/163",[69,44.058]],["parent/163",[21,0.772]],["name/164",[70,44.058]],["parent/164",[21,0.772]],["name/165",[71,44.058]],["parent/165",[21,0.772]],["name/166",[72,44.058]],["parent/166",[21,0.772]],["name/167",[73,44.058]],["parent/167",[21,0.772]],["name/168",[74,44.058]],["parent/168",[21,0.772]],["name/169",[75,44.058]],["parent/169",[21,0.772]],["name/170",[76,44.058]],["parent/170",[21,0.772]],["name/171",[77,44.058]],["parent/171",[21,0.772]],["name/172",[78,44.058]],["parent/172",[21,0.772]],["name/173",[79,44.058]],["parent/173",[21,0.772]],["name/174",[80,44.058]],["parent/174",[21,0.772]],["name/175",[81,44.058]],["parent/175",[21,0.772]],["name/176",[82,44.058]],["parent/176",[21,0.772]],["name/177",[83,44.058]],["parent/177",[21,0.772]],["name/178",[84,44.058]],["parent/178",[21,0.772]],["name/179",[85,44.058]],["parent/179",[21,0.772]],["name/180",[86,44.058]],["parent/180",[21,0.772]],["name/181",[87,44.058]],["parent/181",[21,0.772]],["name/182",[88,44.058]],["parent/182",[21,0.772]],["name/183",[89,44.058]],["parent/183",[21,0.772]],["name/184",[90,44.058]],["parent/184",[21,0.772]],["name/185",[91,44.058]],["parent/185",[21,0.772]],["name/186",[92,44.058]],["parent/186",[21,0.772]],["name/187",[93,44.058]],["parent/187",[21,0.772]],["name/188",[94,44.058]],["parent/188",[21,0.772]],["name/189",[95,44.058]],["parent/189",[21,0.772]],["name/190",[96,44.058]],["parent/190",[21,0.772]],["name/191",[97,44.058]],["parent/191",[21,0.772]],["name/192",[98,44.058]],["parent/192",[21,0.772]],["name/193",[99,44.058]],["parent/193",[21,0.772]],["name/194",[100,44.058]],["parent/194",[21,0.772]],["name/195",[101,44.058]],["parent/195",[21,0.772]],["name/196",[102,44.058]],["parent/196",[21,0.772]],["name/197",[103,44.058]],["parent/197",[21,0.772]],["name/198",[104,44.058]],["parent/198",[21,0.772]],["name/199",[105,44.058]],["parent/199",[21,0.772]],["name/200",[106,44.058]],["parent/200",[21,0.772]],["name/201",[107,44.058]],["parent/201",[21,0.772]]],"invertedIndex":[["__type",{"_index":8,"name":{"7":{},"9":{},"12":{}},"parent":{}}],["browser",{"_index":0,"name":{"0":{}},"parent":{"1":{},"20":{},"21":{},"22":{},"23":{}}}],["cancellederror",{"_index":24,"name":{"26":{},"117":{}},"parent":{}}],["common",{"_index":6,"name":{"5":{}},"parent":{"6":{},"8":{},"11":{},"17":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{}}}],["common.prefetchquerymethod",{"_index":9,"name":{},"parent":{"7":{}}}],["common.prefetchqueryservermodule",{"_index":11,"name":{},"parent":{"9":{}}}],["common.prefetchqueryservermodule.__type",{"_index":13,"name":{},"parent":{"10":{}}}],["common.reactqueryfeatureoptions",{"_index":15,"name":{},"parent":{"12":{}}}],["common.reactqueryfeatureoptions.__type",{"_index":17,"name":{},"parent":{"13":{},"14":{},"15":{},"16":{}}}],["common/feature",{"_index":2,"name":{"2":{}},"parent":{"3":{},"4":{}}}],["defaultoptions",{"_index":85,"name":{"88":{},"179":{}},"parent":{}}],["dehydrate",{"_index":22,"name":{"24":{},"111":{}},"parent":{}}],["exportname",{"_index":20,"name":{"16":{}},"parent":{}}],["featureid",{"_index":4,"name":{"3":{}},"parent":{}}],["featuresubid",{"_index":5,"name":{"4":{}},"parent":{}}],["fetchinfinitequeryoptions",{"_index":54,"name":{"57":{},"148":{}},"parent":{}}],["fetchnextpageoptions",{"_index":60,"name":{"63":{},"154":{}},"parent":{}}],["fetchpreviouspageoptions",{"_index":61,"name":{"64":{},"155":{}},"parent":{}}],["fetchqueryoptions",{"_index":53,"name":{"56":{},"147":{}},"parent":{}}],["focusmanager",{"_index":33,"name":{"36":{},"127":{}},"parent":{}}],["getnextpageparamfunction",{"_index":48,"name":{"51":{},"142":{}},"parent":{}}],["getpreviouspageparamfunction",{"_index":47,"name":{"50":{},"141":{}},"parent":{}}],["hashquerykey",{"_index":35,"name":{"38":{},"129":{}},"parent":{}}],["hydrate",{"_index":23,"name":{"25":{},"112":{}},"parent":{}}],["infinitedata",{"_index":49,"name":{"52":{},"143":{}},"parent":{}}],["infinitequeryobserver",{"_index":28,"name":{"31":{},"122":{}},"parent":{}}],["infinitequeryobserverbaseresult",{"_index":70,"name":{"73":{},"164":{}},"parent":{}}],["infinitequeryobserveridleresult",{"_index":71,"name":{"74":{},"165":{}},"parent":{}}],["infinitequeryobserverloadingerrorresult",{"_index":73,"name":{"76":{},"167":{}},"parent":{}}],["infinitequeryobserverloadingresult",{"_index":72,"name":{"75":{},"166":{}},"parent":{}}],["infinitequeryobserveroptions",{"_index":52,"name":{"55":{},"146":{}},"parent":{}}],["infinitequeryobserverrefetcherrorresult",{"_index":74,"name":{"77":{},"168":{}},"parent":{}}],["infinitequeryobserverresult",{"_index":76,"name":{"79":{},"170":{}},"parent":{}}],["infinitequeryobserversuccessresult",{"_index":75,"name":{"78":{},"169":{}},"parent":{}}],["info",{"_index":3,"name":{"2":{}},"parent":{"3":{},"4":{}}}],["initialdatafunction",{"_index":43,"name":{"46":{},"137":{}},"parent":{}}],["initialstalefunction",{"_index":44,"name":{"47":{},"138":{}},"parent":{}}],["invalidateoptions",{"_index":58,"name":{"61":{},"152":{}},"parent":{}}],["invalidatequeryfilters",{"_index":57,"name":{"60":{},"151":{}},"parent":{}}],["iscancellederror",{"_index":37,"name":{"40":{},"131":{}},"parent":{}}],["iserror",{"_index":36,"name":{"39":{},"130":{}},"parent":{}}],["logger",{"_index":39,"name":{"42":{},"133":{}},"parent":{}}],["mutatefunction",{"_index":83,"name":{"86":{},"177":{}},"parent":{}}],["mutateoptions",{"_index":82,"name":{"85":{},"176":{}},"parent":{}}],["mutationcache",{"_index":29,"name":{"32":{},"123":{}},"parent":{}}],["mutationfunction",{"_index":79,"name":{"82":{},"173":{}},"parent":{}}],["mutationkey",{"_index":77,"name":{"80":{},"171":{}},"parent":{}}],["mutationobserver",{"_index":30,"name":{"33":{},"124":{}},"parent":{}}],["mutationobserveroptions",{"_index":81,"name":{"84":{},"175":{}},"parent":{}}],["mutationobserverresult",{"_index":84,"name":{"87":{},"178":{}},"parent":{}}],["mutationoptions",{"_index":80,"name":{"83":{},"174":{}},"parent":{}}],["mutationstatus",{"_index":78,"name":{"81":{},"172":{}},"parent":{}}],["node",{"_index":21,"name":{"18":{}},"parent":{"19":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}}}],["notifymanager",{"_index":32,"name":{"35":{},"126":{}},"parent":{}}],["onlinemanager",{"_index":34,"name":{"37":{},"128":{}},"parent":{}}],["placeholderdatafunction",{"_index":45,"name":{"48":{},"139":{}},"parent":{}}],["prefetchquery",{"_index":12,"name":{"10":{}},"parent":{}}],["prefetchquerymethod",{"_index":7,"name":{"6":{},"20":{},"113":{}},"parent":{}}],["prefetchqueryservermodule",{"_index":10,"name":{"8":{},"21":{},"114":{}},"parent":{}}],["queriesobserver",{"_index":27,"name":{"30":{},"121":{}},"parent":{}}],["query",{"_index":38,"name":{"41":{},"132":{}},"parent":{}}],["querycache",{"_index":25,"name":{"27":{},"118":{}},"parent":{}}],["queryclient",{"_index":18,"name":{"14":{},"28":{},"119":{}},"parent":{}}],["queryclientprovider",{"_index":86,"name":{"89":{},"180":{}},"parent":{}}],["queryclientproviderprops",{"_index":96,"name":{"99":{},"190":{}},"parent":{}}],["queryerrorresetboundary",{"_index":88,"name":{"91":{},"182":{}},"parent":{}}],["queryerrorresetboundaryprops",{"_index":97,"name":{"100":{},"191":{}},"parent":{}}],["queryfunction",{"_index":41,"name":{"44":{},"135":{}},"parent":{}}],["queryfunctioncontext",{"_index":42,"name":{"45":{},"136":{}},"parent":{}}],["querykey",{"_index":40,"name":{"43":{},"134":{}},"parent":{}}],["querykeyhashfunction",{"_index":46,"name":{"49":{},"140":{}},"parent":{}}],["queryobserver",{"_index":26,"name":{"29":{},"120":{}},"parent":{}}],["queryobserverbaseresult",{"_index":63,"name":{"66":{},"157":{}},"parent":{}}],["queryobserveridleresult",{"_index":64,"name":{"67":{},"158":{}},"parent":{}}],["queryobserverloadingerrorresult",{"_index":66,"name":{"69":{},"160":{}},"parent":{}}],["queryobserverloadingresult",{"_index":65,"name":{"68":{},"159":{}},"parent":{}}],["queryobserveroptions",{"_index":51,"name":{"54":{},"145":{}},"parent":{}}],["queryobserverrefetcherrorresult",{"_index":67,"name":{"70":{},"161":{}},"parent":{}}],["queryobserverresult",{"_index":69,"name":{"72":{},"163":{}},"parent":{}}],["queryobserversuccessresult",{"_index":68,"name":{"71":{},"162":{}},"parent":{}}],["queryoptions",{"_index":50,"name":{"53":{},"144":{}},"parent":{}}],["querystatus",{"_index":62,"name":{"65":{},"156":{}},"parent":{}}],["react",{"_index":16,"name":{"13":{}},"parent":{}}],["reactqueryfeature",{"_index":1,"name":{"1":{},"17":{},"19":{},"23":{},"116":{}},"parent":{}}],["reactqueryfeatureoptions",{"_index":14,"name":{"11":{},"22":{},"115":{}},"parent":{}}],["refetchoptions",{"_index":56,"name":{"59":{},"150":{}},"parent":{}}],["resetoptions",{"_index":59,"name":{"62":{},"153":{}},"parent":{}}],["resultoptions",{"_index":55,"name":{"58":{},"149":{}},"parent":{}}],["servermodule",{"_index":19,"name":{"15":{}},"parent":{}}],["setlogger",{"_index":31,"name":{"34":{},"125":{}},"parent":{}}],["usebasequeryoptions",{"_index":98,"name":{"101":{},"192":{}},"parent":{}}],["usebasequeryresult",{"_index":101,"name":{"104":{},"195":{}},"parent":{}}],["useinfinitequery",{"_index":95,"name":{"98":{},"189":{}},"parent":{}}],["useinfinitequeryoptions",{"_index":100,"name":{"103":{},"194":{}},"parent":{}}],["useinfinitequeryresult",{"_index":103,"name":{"106":{},"197":{}},"parent":{}}],["useisfetching",{"_index":90,"name":{"93":{},"184":{}},"parent":{}}],["useismutating",{"_index":91,"name":{"94":{},"185":{}},"parent":{}}],["usemutateasyncfunction",{"_index":106,"name":{"109":{},"200":{}},"parent":{}}],["usemutatefunction",{"_index":105,"name":{"108":{},"199":{}},"parent":{}}],["usemutation",{"_index":92,"name":{"95":{},"186":{}},"parent":{}}],["usemutationoptions",{"_index":104,"name":{"107":{},"198":{}},"parent":{}}],["usemutationresult",{"_index":107,"name":{"110":{},"201":{}},"parent":{}}],["usequeries",{"_index":94,"name":{"97":{},"188":{}},"parent":{}}],["usequery",{"_index":93,"name":{"96":{},"187":{}},"parent":{}}],["usequeryclient",{"_index":87,"name":{"90":{},"181":{}},"parent":{}}],["usequeryerrorresetboundary",{"_index":89,"name":{"92":{},"183":{}},"parent":{}}],["usequeryoptions",{"_index":99,"name":{"102":{},"193":{}},"parent":{}}],["usequeryresult",{"_index":102,"name":{"105":{},"196":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/packages/xarc-react-query/docs/assets/main.js b/packages/xarc-react-query/docs/assets/main.js new file mode 100644 index 000000000..bd45452db --- /dev/null +++ b/packages/xarc-react-query/docs/assets/main.js @@ -0,0 +1,52 @@ +(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,u],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/packages/xarc-react-query/docs/assets/search.js b/packages/xarc-react-query/docs/assets/search.js new file mode 100644 index 000000000..f38c2aa90 --- /dev/null +++ b/packages/xarc-react-query/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\",\"16777216\":\"Reference\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"browser\",\"url\":\"modules/browser.html\",\"classes\":\"tsd-kind-module\"},{\"id\":1,\"kind\":64,\"name\":\"reactQueryFeature\",\"url\":\"modules/browser.html#reactQueryFeature\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":2,\"kind\":2,\"name\":\"common/feature-info\",\"url\":\"modules/common_feature_info.html\",\"classes\":\"tsd-kind-module\"},{\"id\":3,\"kind\":32,\"name\":\"featureId\",\"url\":\"modules/common_feature_info.html#featureId\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"common/feature-info\"},{\"id\":4,\"kind\":32,\"name\":\"featureSubId\",\"url\":\"modules/common_feature_info.html#featureSubId\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"common/feature-info\"},{\"id\":5,\"kind\":2,\"name\":\"common\",\"url\":\"modules/common.html\",\"classes\":\"tsd-kind-module\"},{\"id\":6,\"kind\":4194304,\"name\":\"prefetchQueryMethod\",\"url\":\"modules/common.html#prefetchQueryMethod\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":7,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/common.html#prefetchQueryMethod.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"common.prefetchQueryMethod\"},{\"id\":8,\"kind\":4194304,\"name\":\"PrefetchQueryServerModule\",\"url\":\"modules/common.html#PrefetchQueryServerModule\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":9,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/common.html#PrefetchQueryServerModule.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"common.PrefetchQueryServerModule\"},{\"id\":10,\"kind\":1024,\"name\":\"prefetchQuery\",\"url\":\"modules/common.html#PrefetchQueryServerModule.__type.prefetchQuery\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.PrefetchQueryServerModule.__type\"},{\"id\":11,\"kind\":4194304,\"name\":\"ReactQueryFeatureOptions\",\"url\":\"modules/common.html#ReactQueryFeatureOptions\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":12,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/common.html#ReactQueryFeatureOptions.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"common.ReactQueryFeatureOptions\"},{\"id\":13,\"kind\":1024,\"name\":\"React\",\"url\":\"modules/common.html#ReactQueryFeatureOptions.__type-1.React\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactQueryFeatureOptions.__type\"},{\"id\":14,\"kind\":1024,\"name\":\"queryClient\",\"url\":\"modules/common.html#ReactQueryFeatureOptions.__type-1.queryClient\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactQueryFeatureOptions.__type\"},{\"id\":15,\"kind\":1024,\"name\":\"serverModule\",\"url\":\"modules/common.html#ReactQueryFeatureOptions.__type-1.serverModule\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactQueryFeatureOptions.__type\"},{\"id\":16,\"kind\":1024,\"name\":\"exportName\",\"url\":\"modules/common.html#ReactQueryFeatureOptions.__type-1.exportName\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactQueryFeatureOptions.__type\"},{\"id\":17,\"kind\":4194304,\"name\":\"ReactQueryFeature\",\"url\":\"modules/common.html#ReactQueryFeature\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":18,\"kind\":2,\"name\":\"node\",\"url\":\"modules/node.html\",\"classes\":\"tsd-kind-module\"},{\"id\":19,\"kind\":64,\"name\":\"reactQueryFeature\",\"url\":\"modules/node.html#reactQueryFeature\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":20,\"kind\":16777216,\"name\":\"prefetchQueryMethod\",\"url\":\"modules/browser.html#prefetchQueryMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":21,\"kind\":16777216,\"name\":\"PrefetchQueryServerModule\",\"url\":\"modules/browser.html#PrefetchQueryServerModule\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":22,\"kind\":16777216,\"name\":\"ReactQueryFeatureOptions\",\"url\":\"modules/browser.html#ReactQueryFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":23,\"kind\":16777216,\"name\":\"ReactQueryFeature\",\"url\":\"modules/browser.html#ReactQueryFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":24,\"kind\":16777216,\"name\":\"dehydrate\",\"url\":\"modules/common.html#dehydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":25,\"kind\":16777216,\"name\":\"Hydrate\",\"url\":\"modules/common.html#Hydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":26,\"kind\":16777216,\"name\":\"CancelledError\",\"url\":\"modules/common.html#CancelledError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":27,\"kind\":16777216,\"name\":\"QueryCache\",\"url\":\"modules/common.html#QueryCache\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":28,\"kind\":16777216,\"name\":\"QueryClient\",\"url\":\"modules/common.html#QueryClient\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":29,\"kind\":16777216,\"name\":\"QueryObserver\",\"url\":\"modules/common.html#QueryObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":30,\"kind\":16777216,\"name\":\"QueriesObserver\",\"url\":\"modules/common.html#QueriesObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":31,\"kind\":16777216,\"name\":\"InfiniteQueryObserver\",\"url\":\"modules/common.html#InfiniteQueryObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":32,\"kind\":16777216,\"name\":\"MutationCache\",\"url\":\"modules/common.html#MutationCache\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":33,\"kind\":16777216,\"name\":\"MutationObserver\",\"url\":\"modules/common.html#MutationObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":34,\"kind\":16777216,\"name\":\"setLogger\",\"url\":\"modules/common.html#setLogger\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":35,\"kind\":16777216,\"name\":\"notifyManager\",\"url\":\"modules/common.html#notifyManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":36,\"kind\":16777216,\"name\":\"focusManager\",\"url\":\"modules/common.html#focusManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":37,\"kind\":16777216,\"name\":\"onlineManager\",\"url\":\"modules/common.html#onlineManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":38,\"kind\":16777216,\"name\":\"hashQueryKey\",\"url\":\"modules/common.html#hashQueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":39,\"kind\":16777216,\"name\":\"isError\",\"url\":\"modules/common.html#isError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":40,\"kind\":16777216,\"name\":\"isCancelledError\",\"url\":\"modules/common.html#isCancelledError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":41,\"kind\":16777216,\"name\":\"hydrate\",\"url\":\"modules/common.html#hydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":42,\"kind\":16777216,\"name\":\"Query\",\"url\":\"modules/common.html#Query\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":43,\"kind\":16777216,\"name\":\"Mutation\",\"url\":\"modules/common.html#Mutation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":44,\"kind\":16777216,\"name\":\"Logger\",\"url\":\"modules/common.html#Logger\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":45,\"kind\":16777216,\"name\":\"DehydrateOptions\",\"url\":\"modules/common.html#DehydrateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":46,\"kind\":16777216,\"name\":\"DehydratedState\",\"url\":\"modules/common.html#DehydratedState\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":47,\"kind\":16777216,\"name\":\"HydrateOptions\",\"url\":\"modules/common.html#HydrateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":48,\"kind\":16777216,\"name\":\"ShouldDehydrateMutationFunction\",\"url\":\"modules/common.html#ShouldDehydrateMutationFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":49,\"kind\":16777216,\"name\":\"ShouldDehydrateQueryFunction\",\"url\":\"modules/common.html#ShouldDehydrateQueryFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":50,\"kind\":16777216,\"name\":\"QueryKey\",\"url\":\"modules/common.html#QueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":51,\"kind\":16777216,\"name\":\"EnsuredQueryKey\",\"url\":\"modules/common.html#EnsuredQueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":52,\"kind\":16777216,\"name\":\"QueryFunction\",\"url\":\"modules/common.html#QueryFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":53,\"kind\":16777216,\"name\":\"QueryFunctionContext\",\"url\":\"modules/common.html#QueryFunctionContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":54,\"kind\":16777216,\"name\":\"InitialDataFunction\",\"url\":\"modules/common.html#InitialDataFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":55,\"kind\":16777216,\"name\":\"PlaceholderDataFunction\",\"url\":\"modules/common.html#PlaceholderDataFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":56,\"kind\":16777216,\"name\":\"QueryKeyHashFunction\",\"url\":\"modules/common.html#QueryKeyHashFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":57,\"kind\":16777216,\"name\":\"GetPreviousPageParamFunction\",\"url\":\"modules/common.html#GetPreviousPageParamFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":58,\"kind\":16777216,\"name\":\"GetNextPageParamFunction\",\"url\":\"modules/common.html#GetNextPageParamFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":59,\"kind\":16777216,\"name\":\"InfiniteData\",\"url\":\"modules/common.html#InfiniteData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":60,\"kind\":16777216,\"name\":\"QueryMeta\",\"url\":\"modules/common.html#QueryMeta\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":61,\"kind\":16777216,\"name\":\"QueryOptions\",\"url\":\"modules/common.html#QueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":62,\"kind\":16777216,\"name\":\"QueryObserverOptions\",\"url\":\"modules/common.html#QueryObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":63,\"kind\":16777216,\"name\":\"InfiniteQueryObserverOptions\",\"url\":\"modules/common.html#InfiniteQueryObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":64,\"kind\":16777216,\"name\":\"FetchQueryOptions\",\"url\":\"modules/common.html#FetchQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":65,\"kind\":16777216,\"name\":\"FetchInfiniteQueryOptions\",\"url\":\"modules/common.html#FetchInfiniteQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":66,\"kind\":16777216,\"name\":\"ResultOptions\",\"url\":\"modules/common.html#ResultOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":67,\"kind\":16777216,\"name\":\"RefetchPageFilters\",\"url\":\"modules/common.html#RefetchPageFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":68,\"kind\":16777216,\"name\":\"RefetchOptions\",\"url\":\"modules/common.html#RefetchOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":69,\"kind\":16777216,\"name\":\"InvalidateQueryFilters\",\"url\":\"modules/common.html#InvalidateQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":70,\"kind\":16777216,\"name\":\"RefetchQueryFilters\",\"url\":\"modules/common.html#RefetchQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":71,\"kind\":16777216,\"name\":\"ResetQueryFilters\",\"url\":\"modules/common.html#ResetQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":72,\"kind\":16777216,\"name\":\"InvalidateOptions\",\"url\":\"modules/common.html#InvalidateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":73,\"kind\":16777216,\"name\":\"ResetOptions\",\"url\":\"modules/common.html#ResetOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":74,\"kind\":16777216,\"name\":\"FetchNextPageOptions\",\"url\":\"modules/common.html#FetchNextPageOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":75,\"kind\":16777216,\"name\":\"FetchPreviousPageOptions\",\"url\":\"modules/common.html#FetchPreviousPageOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":76,\"kind\":16777216,\"name\":\"QueryStatus\",\"url\":\"modules/common.html#QueryStatus\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":77,\"kind\":16777216,\"name\":\"QueryObserverBaseResult\",\"url\":\"modules/common.html#QueryObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":78,\"kind\":16777216,\"name\":\"QueryObserverIdleResult\",\"url\":\"modules/common.html#QueryObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":79,\"kind\":16777216,\"name\":\"QueryObserverLoadingResult\",\"url\":\"modules/common.html#QueryObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":80,\"kind\":16777216,\"name\":\"QueryObserverLoadingErrorResult\",\"url\":\"modules/common.html#QueryObserverLoadingErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":81,\"kind\":16777216,\"name\":\"QueryObserverRefetchErrorResult\",\"url\":\"modules/common.html#QueryObserverRefetchErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":82,\"kind\":16777216,\"name\":\"QueryObserverSuccessResult\",\"url\":\"modules/common.html#QueryObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":83,\"kind\":16777216,\"name\":\"QueryObserverResult\",\"url\":\"modules/common.html#QueryObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":84,\"kind\":16777216,\"name\":\"InfiniteQueryObserverBaseResult\",\"url\":\"modules/common.html#InfiniteQueryObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":85,\"kind\":16777216,\"name\":\"InfiniteQueryObserverIdleResult\",\"url\":\"modules/common.html#InfiniteQueryObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":86,\"kind\":16777216,\"name\":\"InfiniteQueryObserverLoadingResult\",\"url\":\"modules/common.html#InfiniteQueryObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":87,\"kind\":16777216,\"name\":\"InfiniteQueryObserverLoadingErrorResult\",\"url\":\"modules/common.html#InfiniteQueryObserverLoadingErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":88,\"kind\":16777216,\"name\":\"InfiniteQueryObserverRefetchErrorResult\",\"url\":\"modules/common.html#InfiniteQueryObserverRefetchErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":89,\"kind\":16777216,\"name\":\"InfiniteQueryObserverSuccessResult\",\"url\":\"modules/common.html#InfiniteQueryObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":90,\"kind\":16777216,\"name\":\"InfiniteQueryObserverResult\",\"url\":\"modules/common.html#InfiniteQueryObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":91,\"kind\":16777216,\"name\":\"MutationKey\",\"url\":\"modules/common.html#MutationKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":92,\"kind\":16777216,\"name\":\"MutationStatus\",\"url\":\"modules/common.html#MutationStatus\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":93,\"kind\":16777216,\"name\":\"MutationMeta\",\"url\":\"modules/common.html#MutationMeta\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":94,\"kind\":16777216,\"name\":\"MutationFunction\",\"url\":\"modules/common.html#MutationFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":95,\"kind\":16777216,\"name\":\"MutationOptions\",\"url\":\"modules/common.html#MutationOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":96,\"kind\":16777216,\"name\":\"MutationObserverOptions\",\"url\":\"modules/common.html#MutationObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":97,\"kind\":16777216,\"name\":\"MutateOptions\",\"url\":\"modules/common.html#MutateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":98,\"kind\":16777216,\"name\":\"MutateFunction\",\"url\":\"modules/common.html#MutateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":99,\"kind\":16777216,\"name\":\"MutationObserverBaseResult\",\"url\":\"modules/common.html#MutationObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":100,\"kind\":16777216,\"name\":\"MutationObserverIdleResult\",\"url\":\"modules/common.html#MutationObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":101,\"kind\":16777216,\"name\":\"MutationObserverLoadingResult\",\"url\":\"modules/common.html#MutationObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":102,\"kind\":16777216,\"name\":\"MutationObserverErrorResult\",\"url\":\"modules/common.html#MutationObserverErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":103,\"kind\":16777216,\"name\":\"MutationObserverSuccessResult\",\"url\":\"modules/common.html#MutationObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":104,\"kind\":16777216,\"name\":\"MutationObserverResult\",\"url\":\"modules/common.html#MutationObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":105,\"kind\":16777216,\"name\":\"QueryClientConfig\",\"url\":\"modules/common.html#QueryClientConfig\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":106,\"kind\":16777216,\"name\":\"DefaultOptions\",\"url\":\"modules/common.html#DefaultOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":107,\"kind\":16777216,\"name\":\"CancelOptions\",\"url\":\"modules/common.html#CancelOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":108,\"kind\":16777216,\"name\":\"SetDataOptions\",\"url\":\"modules/common.html#SetDataOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":109,\"kind\":16777216,\"name\":\"QueryClientProvider\",\"url\":\"modules/common.html#QueryClientProvider\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":110,\"kind\":16777216,\"name\":\"useQueryClient\",\"url\":\"modules/common.html#useQueryClient\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":111,\"kind\":16777216,\"name\":\"QueryErrorResetBoundary\",\"url\":\"modules/common.html#QueryErrorResetBoundary\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":112,\"kind\":16777216,\"name\":\"useQueryErrorResetBoundary\",\"url\":\"modules/common.html#useQueryErrorResetBoundary\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":113,\"kind\":16777216,\"name\":\"useIsFetching\",\"url\":\"modules/common.html#useIsFetching\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":114,\"kind\":16777216,\"name\":\"useIsMutating\",\"url\":\"modules/common.html#useIsMutating\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":115,\"kind\":16777216,\"name\":\"useMutation\",\"url\":\"modules/common.html#useMutation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":116,\"kind\":16777216,\"name\":\"useQuery\",\"url\":\"modules/common.html#useQuery\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":117,\"kind\":16777216,\"name\":\"useQueries\",\"url\":\"modules/common.html#useQueries\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":118,\"kind\":16777216,\"name\":\"useInfiniteQuery\",\"url\":\"modules/common.html#useInfiniteQuery\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":119,\"kind\":16777216,\"name\":\"useHydrate\",\"url\":\"modules/common.html#useHydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":120,\"kind\":16777216,\"name\":\"QueryClientProviderProps\",\"url\":\"modules/common.html#QueryClientProviderProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":121,\"kind\":16777216,\"name\":\"QueryErrorResetBoundaryProps\",\"url\":\"modules/common.html#QueryErrorResetBoundaryProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":122,\"kind\":16777216,\"name\":\"HydrateProps\",\"url\":\"modules/common.html#HydrateProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":123,\"kind\":16777216,\"name\":\"QueriesOptions\",\"url\":\"modules/common.html#QueriesOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":124,\"kind\":16777216,\"name\":\"QueriesResults\",\"url\":\"modules/common.html#QueriesResults\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":125,\"kind\":16777216,\"name\":\"UseBaseQueryOptions\",\"url\":\"modules/common.html#UseBaseQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":126,\"kind\":16777216,\"name\":\"UseQueryOptions\",\"url\":\"modules/common.html#UseQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":127,\"kind\":16777216,\"name\":\"UseInfiniteQueryOptions\",\"url\":\"modules/common.html#UseInfiniteQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":128,\"kind\":16777216,\"name\":\"UseBaseQueryResult\",\"url\":\"modules/common.html#UseBaseQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":129,\"kind\":16777216,\"name\":\"UseQueryResult\",\"url\":\"modules/common.html#UseQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":130,\"kind\":16777216,\"name\":\"UseInfiniteQueryResult\",\"url\":\"modules/common.html#UseInfiniteQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":131,\"kind\":16777216,\"name\":\"UseMutationOptions\",\"url\":\"modules/common.html#UseMutationOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":132,\"kind\":16777216,\"name\":\"UseMutateFunction\",\"url\":\"modules/common.html#UseMutateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":133,\"kind\":16777216,\"name\":\"UseMutateAsyncFunction\",\"url\":\"modules/common.html#UseMutateAsyncFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":134,\"kind\":16777216,\"name\":\"UseBaseMutationResult\",\"url\":\"modules/common.html#UseBaseMutationResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":135,\"kind\":16777216,\"name\":\"UseMutationResult\",\"url\":\"modules/common.html#UseMutationResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":136,\"kind\":16777216,\"name\":\"dehydrate\",\"url\":\"modules/node.html#dehydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":137,\"kind\":16777216,\"name\":\"Hydrate\",\"url\":\"modules/node.html#Hydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":138,\"kind\":16777216,\"name\":\"prefetchQueryMethod\",\"url\":\"modules/node.html#prefetchQueryMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":139,\"kind\":16777216,\"name\":\"PrefetchQueryServerModule\",\"url\":\"modules/node.html#PrefetchQueryServerModule\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":140,\"kind\":16777216,\"name\":\"ReactQueryFeatureOptions\",\"url\":\"modules/node.html#ReactQueryFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":141,\"kind\":16777216,\"name\":\"ReactQueryFeature\",\"url\":\"modules/node.html#ReactQueryFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":142,\"kind\":16777216,\"name\":\"CancelledError\",\"url\":\"modules/node.html#CancelledError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":143,\"kind\":16777216,\"name\":\"QueryCache\",\"url\":\"modules/node.html#QueryCache\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":144,\"kind\":16777216,\"name\":\"QueryClient\",\"url\":\"modules/node.html#QueryClient\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":145,\"kind\":16777216,\"name\":\"QueryObserver\",\"url\":\"modules/node.html#QueryObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":146,\"kind\":16777216,\"name\":\"QueriesObserver\",\"url\":\"modules/node.html#QueriesObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":147,\"kind\":16777216,\"name\":\"InfiniteQueryObserver\",\"url\":\"modules/node.html#InfiniteQueryObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":148,\"kind\":16777216,\"name\":\"MutationCache\",\"url\":\"modules/node.html#MutationCache\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":149,\"kind\":16777216,\"name\":\"MutationObserver\",\"url\":\"modules/node.html#MutationObserver\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":150,\"kind\":16777216,\"name\":\"setLogger\",\"url\":\"modules/node.html#setLogger\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":151,\"kind\":16777216,\"name\":\"notifyManager\",\"url\":\"modules/node.html#notifyManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":152,\"kind\":16777216,\"name\":\"focusManager\",\"url\":\"modules/node.html#focusManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":153,\"kind\":16777216,\"name\":\"onlineManager\",\"url\":\"modules/node.html#onlineManager\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":154,\"kind\":16777216,\"name\":\"hashQueryKey\",\"url\":\"modules/node.html#hashQueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":155,\"kind\":16777216,\"name\":\"isError\",\"url\":\"modules/node.html#isError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":156,\"kind\":16777216,\"name\":\"isCancelledError\",\"url\":\"modules/node.html#isCancelledError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":157,\"kind\":16777216,\"name\":\"hydrate\",\"url\":\"modules/node.html#hydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":158,\"kind\":16777216,\"name\":\"Query\",\"url\":\"modules/node.html#Query\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":159,\"kind\":16777216,\"name\":\"Mutation\",\"url\":\"modules/node.html#Mutation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":160,\"kind\":16777216,\"name\":\"Logger\",\"url\":\"modules/node.html#Logger\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":161,\"kind\":16777216,\"name\":\"DehydrateOptions\",\"url\":\"modules/node.html#DehydrateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":162,\"kind\":16777216,\"name\":\"DehydratedState\",\"url\":\"modules/node.html#DehydratedState\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":163,\"kind\":16777216,\"name\":\"HydrateOptions\",\"url\":\"modules/node.html#HydrateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":164,\"kind\":16777216,\"name\":\"ShouldDehydrateMutationFunction\",\"url\":\"modules/node.html#ShouldDehydrateMutationFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":165,\"kind\":16777216,\"name\":\"ShouldDehydrateQueryFunction\",\"url\":\"modules/node.html#ShouldDehydrateQueryFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":166,\"kind\":16777216,\"name\":\"QueryKey\",\"url\":\"modules/node.html#QueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":167,\"kind\":16777216,\"name\":\"EnsuredQueryKey\",\"url\":\"modules/node.html#EnsuredQueryKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":168,\"kind\":16777216,\"name\":\"QueryFunction\",\"url\":\"modules/node.html#QueryFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":169,\"kind\":16777216,\"name\":\"QueryFunctionContext\",\"url\":\"modules/node.html#QueryFunctionContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":170,\"kind\":16777216,\"name\":\"InitialDataFunction\",\"url\":\"modules/node.html#InitialDataFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":171,\"kind\":16777216,\"name\":\"PlaceholderDataFunction\",\"url\":\"modules/node.html#PlaceholderDataFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":172,\"kind\":16777216,\"name\":\"QueryKeyHashFunction\",\"url\":\"modules/node.html#QueryKeyHashFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":173,\"kind\":16777216,\"name\":\"GetPreviousPageParamFunction\",\"url\":\"modules/node.html#GetPreviousPageParamFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":174,\"kind\":16777216,\"name\":\"GetNextPageParamFunction\",\"url\":\"modules/node.html#GetNextPageParamFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":175,\"kind\":16777216,\"name\":\"InfiniteData\",\"url\":\"modules/node.html#InfiniteData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":176,\"kind\":16777216,\"name\":\"QueryMeta\",\"url\":\"modules/node.html#QueryMeta\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":177,\"kind\":16777216,\"name\":\"QueryOptions\",\"url\":\"modules/node.html#QueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":178,\"kind\":16777216,\"name\":\"QueryObserverOptions\",\"url\":\"modules/node.html#QueryObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":179,\"kind\":16777216,\"name\":\"InfiniteQueryObserverOptions\",\"url\":\"modules/node.html#InfiniteQueryObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":180,\"kind\":16777216,\"name\":\"FetchQueryOptions\",\"url\":\"modules/node.html#FetchQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":181,\"kind\":16777216,\"name\":\"FetchInfiniteQueryOptions\",\"url\":\"modules/node.html#FetchInfiniteQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":182,\"kind\":16777216,\"name\":\"ResultOptions\",\"url\":\"modules/node.html#ResultOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":183,\"kind\":16777216,\"name\":\"RefetchPageFilters\",\"url\":\"modules/node.html#RefetchPageFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":184,\"kind\":16777216,\"name\":\"RefetchOptions\",\"url\":\"modules/node.html#RefetchOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":185,\"kind\":16777216,\"name\":\"InvalidateQueryFilters\",\"url\":\"modules/node.html#InvalidateQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":186,\"kind\":16777216,\"name\":\"RefetchQueryFilters\",\"url\":\"modules/node.html#RefetchQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":187,\"kind\":16777216,\"name\":\"ResetQueryFilters\",\"url\":\"modules/node.html#ResetQueryFilters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":188,\"kind\":16777216,\"name\":\"InvalidateOptions\",\"url\":\"modules/node.html#InvalidateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":189,\"kind\":16777216,\"name\":\"ResetOptions\",\"url\":\"modules/node.html#ResetOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":190,\"kind\":16777216,\"name\":\"FetchNextPageOptions\",\"url\":\"modules/node.html#FetchNextPageOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":191,\"kind\":16777216,\"name\":\"FetchPreviousPageOptions\",\"url\":\"modules/node.html#FetchPreviousPageOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":192,\"kind\":16777216,\"name\":\"QueryStatus\",\"url\":\"modules/node.html#QueryStatus\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":193,\"kind\":16777216,\"name\":\"QueryObserverBaseResult\",\"url\":\"modules/node.html#QueryObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":194,\"kind\":16777216,\"name\":\"QueryObserverIdleResult\",\"url\":\"modules/node.html#QueryObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":195,\"kind\":16777216,\"name\":\"QueryObserverLoadingResult\",\"url\":\"modules/node.html#QueryObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":196,\"kind\":16777216,\"name\":\"QueryObserverLoadingErrorResult\",\"url\":\"modules/node.html#QueryObserverLoadingErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":197,\"kind\":16777216,\"name\":\"QueryObserverRefetchErrorResult\",\"url\":\"modules/node.html#QueryObserverRefetchErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":198,\"kind\":16777216,\"name\":\"QueryObserverSuccessResult\",\"url\":\"modules/node.html#QueryObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":199,\"kind\":16777216,\"name\":\"QueryObserverResult\",\"url\":\"modules/node.html#QueryObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":200,\"kind\":16777216,\"name\":\"InfiniteQueryObserverBaseResult\",\"url\":\"modules/node.html#InfiniteQueryObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":201,\"kind\":16777216,\"name\":\"InfiniteQueryObserverIdleResult\",\"url\":\"modules/node.html#InfiniteQueryObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":202,\"kind\":16777216,\"name\":\"InfiniteQueryObserverLoadingResult\",\"url\":\"modules/node.html#InfiniteQueryObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":203,\"kind\":16777216,\"name\":\"InfiniteQueryObserverLoadingErrorResult\",\"url\":\"modules/node.html#InfiniteQueryObserverLoadingErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":204,\"kind\":16777216,\"name\":\"InfiniteQueryObserverRefetchErrorResult\",\"url\":\"modules/node.html#InfiniteQueryObserverRefetchErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":205,\"kind\":16777216,\"name\":\"InfiniteQueryObserverSuccessResult\",\"url\":\"modules/node.html#InfiniteQueryObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":206,\"kind\":16777216,\"name\":\"InfiniteQueryObserverResult\",\"url\":\"modules/node.html#InfiniteQueryObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":207,\"kind\":16777216,\"name\":\"MutationKey\",\"url\":\"modules/node.html#MutationKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":208,\"kind\":16777216,\"name\":\"MutationStatus\",\"url\":\"modules/node.html#MutationStatus\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":209,\"kind\":16777216,\"name\":\"MutationMeta\",\"url\":\"modules/node.html#MutationMeta\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":210,\"kind\":16777216,\"name\":\"MutationFunction\",\"url\":\"modules/node.html#MutationFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":211,\"kind\":16777216,\"name\":\"MutationOptions\",\"url\":\"modules/node.html#MutationOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":212,\"kind\":16777216,\"name\":\"MutationObserverOptions\",\"url\":\"modules/node.html#MutationObserverOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":213,\"kind\":16777216,\"name\":\"MutateOptions\",\"url\":\"modules/node.html#MutateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":214,\"kind\":16777216,\"name\":\"MutateFunction\",\"url\":\"modules/node.html#MutateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":215,\"kind\":16777216,\"name\":\"MutationObserverBaseResult\",\"url\":\"modules/node.html#MutationObserverBaseResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":216,\"kind\":16777216,\"name\":\"MutationObserverIdleResult\",\"url\":\"modules/node.html#MutationObserverIdleResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":217,\"kind\":16777216,\"name\":\"MutationObserverLoadingResult\",\"url\":\"modules/node.html#MutationObserverLoadingResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":218,\"kind\":16777216,\"name\":\"MutationObserverErrorResult\",\"url\":\"modules/node.html#MutationObserverErrorResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":219,\"kind\":16777216,\"name\":\"MutationObserverSuccessResult\",\"url\":\"modules/node.html#MutationObserverSuccessResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":220,\"kind\":16777216,\"name\":\"MutationObserverResult\",\"url\":\"modules/node.html#MutationObserverResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":221,\"kind\":16777216,\"name\":\"QueryClientConfig\",\"url\":\"modules/node.html#QueryClientConfig\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":222,\"kind\":16777216,\"name\":\"DefaultOptions\",\"url\":\"modules/node.html#DefaultOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":223,\"kind\":16777216,\"name\":\"CancelOptions\",\"url\":\"modules/node.html#CancelOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":224,\"kind\":16777216,\"name\":\"SetDataOptions\",\"url\":\"modules/node.html#SetDataOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":225,\"kind\":16777216,\"name\":\"QueryClientProvider\",\"url\":\"modules/node.html#QueryClientProvider\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":226,\"kind\":16777216,\"name\":\"useQueryClient\",\"url\":\"modules/node.html#useQueryClient\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":227,\"kind\":16777216,\"name\":\"QueryErrorResetBoundary\",\"url\":\"modules/node.html#QueryErrorResetBoundary\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":228,\"kind\":16777216,\"name\":\"useQueryErrorResetBoundary\",\"url\":\"modules/node.html#useQueryErrorResetBoundary\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":229,\"kind\":16777216,\"name\":\"useIsFetching\",\"url\":\"modules/node.html#useIsFetching\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":230,\"kind\":16777216,\"name\":\"useIsMutating\",\"url\":\"modules/node.html#useIsMutating\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":231,\"kind\":16777216,\"name\":\"useMutation\",\"url\":\"modules/node.html#useMutation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":232,\"kind\":16777216,\"name\":\"useQuery\",\"url\":\"modules/node.html#useQuery\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":233,\"kind\":16777216,\"name\":\"useQueries\",\"url\":\"modules/node.html#useQueries\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":234,\"kind\":16777216,\"name\":\"useInfiniteQuery\",\"url\":\"modules/node.html#useInfiniteQuery\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":235,\"kind\":16777216,\"name\":\"useHydrate\",\"url\":\"modules/node.html#useHydrate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":236,\"kind\":16777216,\"name\":\"QueryClientProviderProps\",\"url\":\"modules/node.html#QueryClientProviderProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":237,\"kind\":16777216,\"name\":\"QueryErrorResetBoundaryProps\",\"url\":\"modules/node.html#QueryErrorResetBoundaryProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":238,\"kind\":16777216,\"name\":\"HydrateProps\",\"url\":\"modules/node.html#HydrateProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":239,\"kind\":16777216,\"name\":\"QueriesOptions\",\"url\":\"modules/node.html#QueriesOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":240,\"kind\":16777216,\"name\":\"QueriesResults\",\"url\":\"modules/node.html#QueriesResults\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":241,\"kind\":16777216,\"name\":\"UseBaseQueryOptions\",\"url\":\"modules/node.html#UseBaseQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":242,\"kind\":16777216,\"name\":\"UseQueryOptions\",\"url\":\"modules/node.html#UseQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":243,\"kind\":16777216,\"name\":\"UseInfiniteQueryOptions\",\"url\":\"modules/node.html#UseInfiniteQueryOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":244,\"kind\":16777216,\"name\":\"UseBaseQueryResult\",\"url\":\"modules/node.html#UseBaseQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":245,\"kind\":16777216,\"name\":\"UseQueryResult\",\"url\":\"modules/node.html#UseQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":246,\"kind\":16777216,\"name\":\"UseInfiniteQueryResult\",\"url\":\"modules/node.html#UseInfiniteQueryResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":247,\"kind\":16777216,\"name\":\"UseMutationOptions\",\"url\":\"modules/node.html#UseMutationOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":248,\"kind\":16777216,\"name\":\"UseMutateFunction\",\"url\":\"modules/node.html#UseMutateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":249,\"kind\":16777216,\"name\":\"UseMutateAsyncFunction\",\"url\":\"modules/node.html#UseMutateAsyncFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":250,\"kind\":16777216,\"name\":\"UseBaseMutationResult\",\"url\":\"modules/node.html#UseBaseMutationResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":251,\"kind\":16777216,\"name\":\"UseMutationResult\",\"url\":\"modules/node.html#UseMutationResult\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,36.675]],[\"parent/0\",[]],[\"name/1\",[1,38.348]],[\"parent/1\",[0,3.65]],[\"name/2\",[2,30.449,3,30.449]],[\"parent/2\",[]],[\"name/3\",[4,51.362]],[\"parent/3\",[2,3.024,3,3.024]],[\"name/4\",[5,51.362]],[\"parent/4\",[2,3.024,3,3.024]],[\"name/5\",[6,7.682]],[\"parent/5\",[]],[\"name/6\",[7,42.876]],[\"parent/6\",[6,0.764]],[\"name/7\",[8,42.876]],[\"parent/7\",[9,5.111]],[\"name/8\",[10,42.876]],[\"parent/8\",[6,0.764]],[\"name/9\",[8,42.876]],[\"parent/9\",[11,5.111]],[\"name/10\",[12,51.362]],[\"parent/10\",[13,5.111]],[\"name/11\",[14,42.876]],[\"parent/11\",[6,0.764]],[\"name/12\",[8,42.876]],[\"parent/12\",[15,5.111]],[\"name/13\",[16,51.362]],[\"parent/13\",[17,4.016]],[\"name/14\",[18,42.876]],[\"parent/14\",[17,4.016]],[\"name/15\",[19,51.362]],[\"parent/15\",[17,4.016]],[\"name/16\",[20,51.362]],[\"parent/16\",[17,4.016]],[\"name/17\",[1,38.348]],[\"parent/17\",[6,0.764]],[\"name/18\",[21,7.597]],[\"parent/18\",[]],[\"name/19\",[1,38.348]],[\"parent/19\",[21,0.756]],[\"name/20\",[7,42.876]],[\"parent/20\",[0,3.65]],[\"name/21\",[10,42.876]],[\"parent/21\",[0,3.65]],[\"name/22\",[14,42.876]],[\"parent/22\",[0,3.65]],[\"name/23\",[1,38.348]],[\"parent/23\",[0,3.65]],[\"name/24\",[22,46.246]],[\"parent/24\",[6,0.764]],[\"name/25\",[23,40.358]],[\"parent/25\",[6,0.764]],[\"name/26\",[24,46.246]],[\"parent/26\",[6,0.764]],[\"name/27\",[25,46.246]],[\"parent/27\",[6,0.764]],[\"name/28\",[18,42.876]],[\"parent/28\",[6,0.764]],[\"name/29\",[26,46.246]],[\"parent/29\",[6,0.764]],[\"name/30\",[27,46.246]],[\"parent/30\",[6,0.764]],[\"name/31\",[28,46.246]],[\"parent/31\",[6,0.764]],[\"name/32\",[29,46.246]],[\"parent/32\",[6,0.764]],[\"name/33\",[30,46.246]],[\"parent/33\",[6,0.764]],[\"name/34\",[31,46.246]],[\"parent/34\",[6,0.764]],[\"name/35\",[32,46.246]],[\"parent/35\",[6,0.764]],[\"name/36\",[33,46.246]],[\"parent/36\",[6,0.764]],[\"name/37\",[34,46.246]],[\"parent/37\",[6,0.764]],[\"name/38\",[35,46.246]],[\"parent/38\",[6,0.764]],[\"name/39\",[36,46.246]],[\"parent/39\",[6,0.764]],[\"name/40\",[37,46.246]],[\"parent/40\",[6,0.764]],[\"name/41\",[23,40.358]],[\"parent/41\",[6,0.764]],[\"name/42\",[38,46.246]],[\"parent/42\",[6,0.764]],[\"name/43\",[39,46.246]],[\"parent/43\",[6,0.764]],[\"name/44\",[40,46.246]],[\"parent/44\",[6,0.764]],[\"name/45\",[41,46.246]],[\"parent/45\",[6,0.764]],[\"name/46\",[42,46.246]],[\"parent/46\",[6,0.764]],[\"name/47\",[43,46.246]],[\"parent/47\",[6,0.764]],[\"name/48\",[44,46.246]],[\"parent/48\",[6,0.764]],[\"name/49\",[45,46.246]],[\"parent/49\",[6,0.764]],[\"name/50\",[46,46.246]],[\"parent/50\",[6,0.764]],[\"name/51\",[47,46.246]],[\"parent/51\",[6,0.764]],[\"name/52\",[48,46.246]],[\"parent/52\",[6,0.764]],[\"name/53\",[49,46.246]],[\"parent/53\",[6,0.764]],[\"name/54\",[50,46.246]],[\"parent/54\",[6,0.764]],[\"name/55\",[51,46.246]],[\"parent/55\",[6,0.764]],[\"name/56\",[52,46.246]],[\"parent/56\",[6,0.764]],[\"name/57\",[53,46.246]],[\"parent/57\",[6,0.764]],[\"name/58\",[54,46.246]],[\"parent/58\",[6,0.764]],[\"name/59\",[55,46.246]],[\"parent/59\",[6,0.764]],[\"name/60\",[56,46.246]],[\"parent/60\",[6,0.764]],[\"name/61\",[57,46.246]],[\"parent/61\",[6,0.764]],[\"name/62\",[58,46.246]],[\"parent/62\",[6,0.764]],[\"name/63\",[59,46.246]],[\"parent/63\",[6,0.764]],[\"name/64\",[60,46.246]],[\"parent/64\",[6,0.764]],[\"name/65\",[61,46.246]],[\"parent/65\",[6,0.764]],[\"name/66\",[62,46.246]],[\"parent/66\",[6,0.764]],[\"name/67\",[63,46.246]],[\"parent/67\",[6,0.764]],[\"name/68\",[64,46.246]],[\"parent/68\",[6,0.764]],[\"name/69\",[65,46.246]],[\"parent/69\",[6,0.764]],[\"name/70\",[66,46.246]],[\"parent/70\",[6,0.764]],[\"name/71\",[67,46.246]],[\"parent/71\",[6,0.764]],[\"name/72\",[68,46.246]],[\"parent/72\",[6,0.764]],[\"name/73\",[69,46.246]],[\"parent/73\",[6,0.764]],[\"name/74\",[70,46.246]],[\"parent/74\",[6,0.764]],[\"name/75\",[71,46.246]],[\"parent/75\",[6,0.764]],[\"name/76\",[72,46.246]],[\"parent/76\",[6,0.764]],[\"name/77\",[73,46.246]],[\"parent/77\",[6,0.764]],[\"name/78\",[74,46.246]],[\"parent/78\",[6,0.764]],[\"name/79\",[75,46.246]],[\"parent/79\",[6,0.764]],[\"name/80\",[76,46.246]],[\"parent/80\",[6,0.764]],[\"name/81\",[77,46.246]],[\"parent/81\",[6,0.764]],[\"name/82\",[78,46.246]],[\"parent/82\",[6,0.764]],[\"name/83\",[79,46.246]],[\"parent/83\",[6,0.764]],[\"name/84\",[80,46.246]],[\"parent/84\",[6,0.764]],[\"name/85\",[81,46.246]],[\"parent/85\",[6,0.764]],[\"name/86\",[82,46.246]],[\"parent/86\",[6,0.764]],[\"name/87\",[83,46.246]],[\"parent/87\",[6,0.764]],[\"name/88\",[84,46.246]],[\"parent/88\",[6,0.764]],[\"name/89\",[85,46.246]],[\"parent/89\",[6,0.764]],[\"name/90\",[86,46.246]],[\"parent/90\",[6,0.764]],[\"name/91\",[87,46.246]],[\"parent/91\",[6,0.764]],[\"name/92\",[88,46.246]],[\"parent/92\",[6,0.764]],[\"name/93\",[89,46.246]],[\"parent/93\",[6,0.764]],[\"name/94\",[90,46.246]],[\"parent/94\",[6,0.764]],[\"name/95\",[91,46.246]],[\"parent/95\",[6,0.764]],[\"name/96\",[92,46.246]],[\"parent/96\",[6,0.764]],[\"name/97\",[93,46.246]],[\"parent/97\",[6,0.764]],[\"name/98\",[94,46.246]],[\"parent/98\",[6,0.764]],[\"name/99\",[95,46.246]],[\"parent/99\",[6,0.764]],[\"name/100\",[96,46.246]],[\"parent/100\",[6,0.764]],[\"name/101\",[97,46.246]],[\"parent/101\",[6,0.764]],[\"name/102\",[98,46.246]],[\"parent/102\",[6,0.764]],[\"name/103\",[99,46.246]],[\"parent/103\",[6,0.764]],[\"name/104\",[100,46.246]],[\"parent/104\",[6,0.764]],[\"name/105\",[101,46.246]],[\"parent/105\",[6,0.764]],[\"name/106\",[102,46.246]],[\"parent/106\",[6,0.764]],[\"name/107\",[103,46.246]],[\"parent/107\",[6,0.764]],[\"name/108\",[104,46.246]],[\"parent/108\",[6,0.764]],[\"name/109\",[105,46.246]],[\"parent/109\",[6,0.764]],[\"name/110\",[106,46.246]],[\"parent/110\",[6,0.764]],[\"name/111\",[107,46.246]],[\"parent/111\",[6,0.764]],[\"name/112\",[108,46.246]],[\"parent/112\",[6,0.764]],[\"name/113\",[109,46.246]],[\"parent/113\",[6,0.764]],[\"name/114\",[110,46.246]],[\"parent/114\",[6,0.764]],[\"name/115\",[111,46.246]],[\"parent/115\",[6,0.764]],[\"name/116\",[112,46.246]],[\"parent/116\",[6,0.764]],[\"name/117\",[113,46.246]],[\"parent/117\",[6,0.764]],[\"name/118\",[114,46.246]],[\"parent/118\",[6,0.764]],[\"name/119\",[115,46.246]],[\"parent/119\",[6,0.764]],[\"name/120\",[116,46.246]],[\"parent/120\",[6,0.764]],[\"name/121\",[117,46.246]],[\"parent/121\",[6,0.764]],[\"name/122\",[118,46.246]],[\"parent/122\",[6,0.764]],[\"name/123\",[119,46.246]],[\"parent/123\",[6,0.764]],[\"name/124\",[120,46.246]],[\"parent/124\",[6,0.764]],[\"name/125\",[121,46.246]],[\"parent/125\",[6,0.764]],[\"name/126\",[122,46.246]],[\"parent/126\",[6,0.764]],[\"name/127\",[123,46.246]],[\"parent/127\",[6,0.764]],[\"name/128\",[124,46.246]],[\"parent/128\",[6,0.764]],[\"name/129\",[125,46.246]],[\"parent/129\",[6,0.764]],[\"name/130\",[126,46.246]],[\"parent/130\",[6,0.764]],[\"name/131\",[127,46.246]],[\"parent/131\",[6,0.764]],[\"name/132\",[128,46.246]],[\"parent/132\",[6,0.764]],[\"name/133\",[129,46.246]],[\"parent/133\",[6,0.764]],[\"name/134\",[130,46.246]],[\"parent/134\",[6,0.764]],[\"name/135\",[131,46.246]],[\"parent/135\",[6,0.764]],[\"name/136\",[22,46.246]],[\"parent/136\",[21,0.756]],[\"name/137\",[23,40.358]],[\"parent/137\",[21,0.756]],[\"name/138\",[7,42.876]],[\"parent/138\",[21,0.756]],[\"name/139\",[10,42.876]],[\"parent/139\",[21,0.756]],[\"name/140\",[14,42.876]],[\"parent/140\",[21,0.756]],[\"name/141\",[1,38.348]],[\"parent/141\",[21,0.756]],[\"name/142\",[24,46.246]],[\"parent/142\",[21,0.756]],[\"name/143\",[25,46.246]],[\"parent/143\",[21,0.756]],[\"name/144\",[18,42.876]],[\"parent/144\",[21,0.756]],[\"name/145\",[26,46.246]],[\"parent/145\",[21,0.756]],[\"name/146\",[27,46.246]],[\"parent/146\",[21,0.756]],[\"name/147\",[28,46.246]],[\"parent/147\",[21,0.756]],[\"name/148\",[29,46.246]],[\"parent/148\",[21,0.756]],[\"name/149\",[30,46.246]],[\"parent/149\",[21,0.756]],[\"name/150\",[31,46.246]],[\"parent/150\",[21,0.756]],[\"name/151\",[32,46.246]],[\"parent/151\",[21,0.756]],[\"name/152\",[33,46.246]],[\"parent/152\",[21,0.756]],[\"name/153\",[34,46.246]],[\"parent/153\",[21,0.756]],[\"name/154\",[35,46.246]],[\"parent/154\",[21,0.756]],[\"name/155\",[36,46.246]],[\"parent/155\",[21,0.756]],[\"name/156\",[37,46.246]],[\"parent/156\",[21,0.756]],[\"name/157\",[23,40.358]],[\"parent/157\",[21,0.756]],[\"name/158\",[38,46.246]],[\"parent/158\",[21,0.756]],[\"name/159\",[39,46.246]],[\"parent/159\",[21,0.756]],[\"name/160\",[40,46.246]],[\"parent/160\",[21,0.756]],[\"name/161\",[41,46.246]],[\"parent/161\",[21,0.756]],[\"name/162\",[42,46.246]],[\"parent/162\",[21,0.756]],[\"name/163\",[43,46.246]],[\"parent/163\",[21,0.756]],[\"name/164\",[44,46.246]],[\"parent/164\",[21,0.756]],[\"name/165\",[45,46.246]],[\"parent/165\",[21,0.756]],[\"name/166\",[46,46.246]],[\"parent/166\",[21,0.756]],[\"name/167\",[47,46.246]],[\"parent/167\",[21,0.756]],[\"name/168\",[48,46.246]],[\"parent/168\",[21,0.756]],[\"name/169\",[49,46.246]],[\"parent/169\",[21,0.756]],[\"name/170\",[50,46.246]],[\"parent/170\",[21,0.756]],[\"name/171\",[51,46.246]],[\"parent/171\",[21,0.756]],[\"name/172\",[52,46.246]],[\"parent/172\",[21,0.756]],[\"name/173\",[53,46.246]],[\"parent/173\",[21,0.756]],[\"name/174\",[54,46.246]],[\"parent/174\",[21,0.756]],[\"name/175\",[55,46.246]],[\"parent/175\",[21,0.756]],[\"name/176\",[56,46.246]],[\"parent/176\",[21,0.756]],[\"name/177\",[57,46.246]],[\"parent/177\",[21,0.756]],[\"name/178\",[58,46.246]],[\"parent/178\",[21,0.756]],[\"name/179\",[59,46.246]],[\"parent/179\",[21,0.756]],[\"name/180\",[60,46.246]],[\"parent/180\",[21,0.756]],[\"name/181\",[61,46.246]],[\"parent/181\",[21,0.756]],[\"name/182\",[62,46.246]],[\"parent/182\",[21,0.756]],[\"name/183\",[63,46.246]],[\"parent/183\",[21,0.756]],[\"name/184\",[64,46.246]],[\"parent/184\",[21,0.756]],[\"name/185\",[65,46.246]],[\"parent/185\",[21,0.756]],[\"name/186\",[66,46.246]],[\"parent/186\",[21,0.756]],[\"name/187\",[67,46.246]],[\"parent/187\",[21,0.756]],[\"name/188\",[68,46.246]],[\"parent/188\",[21,0.756]],[\"name/189\",[69,46.246]],[\"parent/189\",[21,0.756]],[\"name/190\",[70,46.246]],[\"parent/190\",[21,0.756]],[\"name/191\",[71,46.246]],[\"parent/191\",[21,0.756]],[\"name/192\",[72,46.246]],[\"parent/192\",[21,0.756]],[\"name/193\",[73,46.246]],[\"parent/193\",[21,0.756]],[\"name/194\",[74,46.246]],[\"parent/194\",[21,0.756]],[\"name/195\",[75,46.246]],[\"parent/195\",[21,0.756]],[\"name/196\",[76,46.246]],[\"parent/196\",[21,0.756]],[\"name/197\",[77,46.246]],[\"parent/197\",[21,0.756]],[\"name/198\",[78,46.246]],[\"parent/198\",[21,0.756]],[\"name/199\",[79,46.246]],[\"parent/199\",[21,0.756]],[\"name/200\",[80,46.246]],[\"parent/200\",[21,0.756]],[\"name/201\",[81,46.246]],[\"parent/201\",[21,0.756]],[\"name/202\",[82,46.246]],[\"parent/202\",[21,0.756]],[\"name/203\",[83,46.246]],[\"parent/203\",[21,0.756]],[\"name/204\",[84,46.246]],[\"parent/204\",[21,0.756]],[\"name/205\",[85,46.246]],[\"parent/205\",[21,0.756]],[\"name/206\",[86,46.246]],[\"parent/206\",[21,0.756]],[\"name/207\",[87,46.246]],[\"parent/207\",[21,0.756]],[\"name/208\",[88,46.246]],[\"parent/208\",[21,0.756]],[\"name/209\",[89,46.246]],[\"parent/209\",[21,0.756]],[\"name/210\",[90,46.246]],[\"parent/210\",[21,0.756]],[\"name/211\",[91,46.246]],[\"parent/211\",[21,0.756]],[\"name/212\",[92,46.246]],[\"parent/212\",[21,0.756]],[\"name/213\",[93,46.246]],[\"parent/213\",[21,0.756]],[\"name/214\",[94,46.246]],[\"parent/214\",[21,0.756]],[\"name/215\",[95,46.246]],[\"parent/215\",[21,0.756]],[\"name/216\",[96,46.246]],[\"parent/216\",[21,0.756]],[\"name/217\",[97,46.246]],[\"parent/217\",[21,0.756]],[\"name/218\",[98,46.246]],[\"parent/218\",[21,0.756]],[\"name/219\",[99,46.246]],[\"parent/219\",[21,0.756]],[\"name/220\",[100,46.246]],[\"parent/220\",[21,0.756]],[\"name/221\",[101,46.246]],[\"parent/221\",[21,0.756]],[\"name/222\",[102,46.246]],[\"parent/222\",[21,0.756]],[\"name/223\",[103,46.246]],[\"parent/223\",[21,0.756]],[\"name/224\",[104,46.246]],[\"parent/224\",[21,0.756]],[\"name/225\",[105,46.246]],[\"parent/225\",[21,0.756]],[\"name/226\",[106,46.246]],[\"parent/226\",[21,0.756]],[\"name/227\",[107,46.246]],[\"parent/227\",[21,0.756]],[\"name/228\",[108,46.246]],[\"parent/228\",[21,0.756]],[\"name/229\",[109,46.246]],[\"parent/229\",[21,0.756]],[\"name/230\",[110,46.246]],[\"parent/230\",[21,0.756]],[\"name/231\",[111,46.246]],[\"parent/231\",[21,0.756]],[\"name/232\",[112,46.246]],[\"parent/232\",[21,0.756]],[\"name/233\",[113,46.246]],[\"parent/233\",[21,0.756]],[\"name/234\",[114,46.246]],[\"parent/234\",[21,0.756]],[\"name/235\",[115,46.246]],[\"parent/235\",[21,0.756]],[\"name/236\",[116,46.246]],[\"parent/236\",[21,0.756]],[\"name/237\",[117,46.246]],[\"parent/237\",[21,0.756]],[\"name/238\",[118,46.246]],[\"parent/238\",[21,0.756]],[\"name/239\",[119,46.246]],[\"parent/239\",[21,0.756]],[\"name/240\",[120,46.246]],[\"parent/240\",[21,0.756]],[\"name/241\",[121,46.246]],[\"parent/241\",[21,0.756]],[\"name/242\",[122,46.246]],[\"parent/242\",[21,0.756]],[\"name/243\",[123,46.246]],[\"parent/243\",[21,0.756]],[\"name/244\",[124,46.246]],[\"parent/244\",[21,0.756]],[\"name/245\",[125,46.246]],[\"parent/245\",[21,0.756]],[\"name/246\",[126,46.246]],[\"parent/246\",[21,0.756]],[\"name/247\",[127,46.246]],[\"parent/247\",[21,0.756]],[\"name/248\",[128,46.246]],[\"parent/248\",[21,0.756]],[\"name/249\",[129,46.246]],[\"parent/249\",[21,0.756]],[\"name/250\",[130,46.246]],[\"parent/250\",[21,0.756]],[\"name/251\",[131,46.246]],[\"parent/251\",[21,0.756]]],\"invertedIndex\":[[\"__type\",{\"_index\":8,\"name\":{\"7\":{},\"9\":{},\"12\":{}},\"parent\":{}}],[\"browser\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{}}}],[\"cancellederror\",{\"_index\":24,\"name\":{\"26\":{},\"142\":{}},\"parent\":{}}],[\"canceloptions\",{\"_index\":103,\"name\":{\"107\":{},\"223\":{}},\"parent\":{}}],[\"common\",{\"_index\":6,\"name\":{\"5\":{}},\"parent\":{\"6\":{},\"8\":{},\"11\":{},\"17\":{},\"24\":{},\"25\":{},\"26\":{},\"27\":{},\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{},\"63\":{},\"64\":{},\"65\":{},\"66\":{},\"67\":{},\"68\":{},\"69\":{},\"70\":{},\"71\":{},\"72\":{},\"73\":{},\"74\":{},\"75\":{},\"76\":{},\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{},\"83\":{},\"84\":{},\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{},\"91\":{},\"92\":{},\"93\":{},\"94\":{},\"95\":{},\"96\":{},\"97\":{},\"98\":{},\"99\":{},\"100\":{},\"101\":{},\"102\":{},\"103\":{},\"104\":{},\"105\":{},\"106\":{},\"107\":{},\"108\":{},\"109\":{},\"110\":{},\"111\":{},\"112\":{},\"113\":{},\"114\":{},\"115\":{},\"116\":{},\"117\":{},\"118\":{},\"119\":{},\"120\":{},\"121\":{},\"122\":{},\"123\":{},\"124\":{},\"125\":{},\"126\":{},\"127\":{},\"128\":{},\"129\":{},\"130\":{},\"131\":{},\"132\":{},\"133\":{},\"134\":{},\"135\":{}}}],[\"common.prefetchquerymethod\",{\"_index\":9,\"name\":{},\"parent\":{\"7\":{}}}],[\"common.prefetchqueryservermodule\",{\"_index\":11,\"name\":{},\"parent\":{\"9\":{}}}],[\"common.prefetchqueryservermodule.__type\",{\"_index\":13,\"name\":{},\"parent\":{\"10\":{}}}],[\"common.reactqueryfeatureoptions\",{\"_index\":15,\"name\":{},\"parent\":{\"12\":{}}}],[\"common.reactqueryfeatureoptions.__type\",{\"_index\":17,\"name\":{},\"parent\":{\"13\":{},\"14\":{},\"15\":{},\"16\":{}}}],[\"common/feature\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{\"3\":{},\"4\":{}}}],[\"defaultoptions\",{\"_index\":102,\"name\":{\"106\":{},\"222\":{}},\"parent\":{}}],[\"dehydrate\",{\"_index\":22,\"name\":{\"24\":{},\"136\":{}},\"parent\":{}}],[\"dehydratedstate\",{\"_index\":42,\"name\":{\"46\":{},\"162\":{}},\"parent\":{}}],[\"dehydrateoptions\",{\"_index\":41,\"name\":{\"45\":{},\"161\":{}},\"parent\":{}}],[\"ensuredquerykey\",{\"_index\":47,\"name\":{\"51\":{},\"167\":{}},\"parent\":{}}],[\"exportname\",{\"_index\":20,\"name\":{\"16\":{}},\"parent\":{}}],[\"featureid\",{\"_index\":4,\"name\":{\"3\":{}},\"parent\":{}}],[\"featuresubid\",{\"_index\":5,\"name\":{\"4\":{}},\"parent\":{}}],[\"fetchinfinitequeryoptions\",{\"_index\":61,\"name\":{\"65\":{},\"181\":{}},\"parent\":{}}],[\"fetchnextpageoptions\",{\"_index\":70,\"name\":{\"74\":{},\"190\":{}},\"parent\":{}}],[\"fetchpreviouspageoptions\",{\"_index\":71,\"name\":{\"75\":{},\"191\":{}},\"parent\":{}}],[\"fetchqueryoptions\",{\"_index\":60,\"name\":{\"64\":{},\"180\":{}},\"parent\":{}}],[\"focusmanager\",{\"_index\":33,\"name\":{\"36\":{},\"152\":{}},\"parent\":{}}],[\"getnextpageparamfunction\",{\"_index\":54,\"name\":{\"58\":{},\"174\":{}},\"parent\":{}}],[\"getpreviouspageparamfunction\",{\"_index\":53,\"name\":{\"57\":{},\"173\":{}},\"parent\":{}}],[\"hashquerykey\",{\"_index\":35,\"name\":{\"38\":{},\"154\":{}},\"parent\":{}}],[\"hydrate\",{\"_index\":23,\"name\":{\"25\":{},\"41\":{},\"137\":{},\"157\":{}},\"parent\":{}}],[\"hydrateoptions\",{\"_index\":43,\"name\":{\"47\":{},\"163\":{}},\"parent\":{}}],[\"hydrateprops\",{\"_index\":118,\"name\":{\"122\":{},\"238\":{}},\"parent\":{}}],[\"infinitedata\",{\"_index\":55,\"name\":{\"59\":{},\"175\":{}},\"parent\":{}}],[\"infinitequeryobserver\",{\"_index\":28,\"name\":{\"31\":{},\"147\":{}},\"parent\":{}}],[\"infinitequeryobserverbaseresult\",{\"_index\":80,\"name\":{\"84\":{},\"200\":{}},\"parent\":{}}],[\"infinitequeryobserveridleresult\",{\"_index\":81,\"name\":{\"85\":{},\"201\":{}},\"parent\":{}}],[\"infinitequeryobserverloadingerrorresult\",{\"_index\":83,\"name\":{\"87\":{},\"203\":{}},\"parent\":{}}],[\"infinitequeryobserverloadingresult\",{\"_index\":82,\"name\":{\"86\":{},\"202\":{}},\"parent\":{}}],[\"infinitequeryobserveroptions\",{\"_index\":59,\"name\":{\"63\":{},\"179\":{}},\"parent\":{}}],[\"infinitequeryobserverrefetcherrorresult\",{\"_index\":84,\"name\":{\"88\":{},\"204\":{}},\"parent\":{}}],[\"infinitequeryobserverresult\",{\"_index\":86,\"name\":{\"90\":{},\"206\":{}},\"parent\":{}}],[\"infinitequeryobserversuccessresult\",{\"_index\":85,\"name\":{\"89\":{},\"205\":{}},\"parent\":{}}],[\"info\",{\"_index\":3,\"name\":{\"2\":{}},\"parent\":{\"3\":{},\"4\":{}}}],[\"initialdatafunction\",{\"_index\":50,\"name\":{\"54\":{},\"170\":{}},\"parent\":{}}],[\"invalidateoptions\",{\"_index\":68,\"name\":{\"72\":{},\"188\":{}},\"parent\":{}}],[\"invalidatequeryfilters\",{\"_index\":65,\"name\":{\"69\":{},\"185\":{}},\"parent\":{}}],[\"iscancellederror\",{\"_index\":37,\"name\":{\"40\":{},\"156\":{}},\"parent\":{}}],[\"iserror\",{\"_index\":36,\"name\":{\"39\":{},\"155\":{}},\"parent\":{}}],[\"logger\",{\"_index\":40,\"name\":{\"44\":{},\"160\":{}},\"parent\":{}}],[\"mutatefunction\",{\"_index\":94,\"name\":{\"98\":{},\"214\":{}},\"parent\":{}}],[\"mutateoptions\",{\"_index\":93,\"name\":{\"97\":{},\"213\":{}},\"parent\":{}}],[\"mutation\",{\"_index\":39,\"name\":{\"43\":{},\"159\":{}},\"parent\":{}}],[\"mutationcache\",{\"_index\":29,\"name\":{\"32\":{},\"148\":{}},\"parent\":{}}],[\"mutationfunction\",{\"_index\":90,\"name\":{\"94\":{},\"210\":{}},\"parent\":{}}],[\"mutationkey\",{\"_index\":87,\"name\":{\"91\":{},\"207\":{}},\"parent\":{}}],[\"mutationmeta\",{\"_index\":89,\"name\":{\"93\":{},\"209\":{}},\"parent\":{}}],[\"mutationobserver\",{\"_index\":30,\"name\":{\"33\":{},\"149\":{}},\"parent\":{}}],[\"mutationobserverbaseresult\",{\"_index\":95,\"name\":{\"99\":{},\"215\":{}},\"parent\":{}}],[\"mutationobservererrorresult\",{\"_index\":98,\"name\":{\"102\":{},\"218\":{}},\"parent\":{}}],[\"mutationobserveridleresult\",{\"_index\":96,\"name\":{\"100\":{},\"216\":{}},\"parent\":{}}],[\"mutationobserverloadingresult\",{\"_index\":97,\"name\":{\"101\":{},\"217\":{}},\"parent\":{}}],[\"mutationobserveroptions\",{\"_index\":92,\"name\":{\"96\":{},\"212\":{}},\"parent\":{}}],[\"mutationobserverresult\",{\"_index\":100,\"name\":{\"104\":{},\"220\":{}},\"parent\":{}}],[\"mutationobserversuccessresult\",{\"_index\":99,\"name\":{\"103\":{},\"219\":{}},\"parent\":{}}],[\"mutationoptions\",{\"_index\":91,\"name\":{\"95\":{},\"211\":{}},\"parent\":{}}],[\"mutationstatus\",{\"_index\":88,\"name\":{\"92\":{},\"208\":{}},\"parent\":{}}],[\"node\",{\"_index\":21,\"name\":{\"18\":{}},\"parent\":{\"19\":{},\"136\":{},\"137\":{},\"138\":{},\"139\":{},\"140\":{},\"141\":{},\"142\":{},\"143\":{},\"144\":{},\"145\":{},\"146\":{},\"147\":{},\"148\":{},\"149\":{},\"150\":{},\"151\":{},\"152\":{},\"153\":{},\"154\":{},\"155\":{},\"156\":{},\"157\":{},\"158\":{},\"159\":{},\"160\":{},\"161\":{},\"162\":{},\"163\":{},\"164\":{},\"165\":{},\"166\":{},\"167\":{},\"168\":{},\"169\":{},\"170\":{},\"171\":{},\"172\":{},\"173\":{},\"174\":{},\"175\":{},\"176\":{},\"177\":{},\"178\":{},\"179\":{},\"180\":{},\"181\":{},\"182\":{},\"183\":{},\"184\":{},\"185\":{},\"186\":{},\"187\":{},\"188\":{},\"189\":{},\"190\":{},\"191\":{},\"192\":{},\"193\":{},\"194\":{},\"195\":{},\"196\":{},\"197\":{},\"198\":{},\"199\":{},\"200\":{},\"201\":{},\"202\":{},\"203\":{},\"204\":{},\"205\":{},\"206\":{},\"207\":{},\"208\":{},\"209\":{},\"210\":{},\"211\":{},\"212\":{},\"213\":{},\"214\":{},\"215\":{},\"216\":{},\"217\":{},\"218\":{},\"219\":{},\"220\":{},\"221\":{},\"222\":{},\"223\":{},\"224\":{},\"225\":{},\"226\":{},\"227\":{},\"228\":{},\"229\":{},\"230\":{},\"231\":{},\"232\":{},\"233\":{},\"234\":{},\"235\":{},\"236\":{},\"237\":{},\"238\":{},\"239\":{},\"240\":{},\"241\":{},\"242\":{},\"243\":{},\"244\":{},\"245\":{},\"246\":{},\"247\":{},\"248\":{},\"249\":{},\"250\":{},\"251\":{}}}],[\"notifymanager\",{\"_index\":32,\"name\":{\"35\":{},\"151\":{}},\"parent\":{}}],[\"onlinemanager\",{\"_index\":34,\"name\":{\"37\":{},\"153\":{}},\"parent\":{}}],[\"placeholderdatafunction\",{\"_index\":51,\"name\":{\"55\":{},\"171\":{}},\"parent\":{}}],[\"prefetchquery\",{\"_index\":12,\"name\":{\"10\":{}},\"parent\":{}}],[\"prefetchquerymethod\",{\"_index\":7,\"name\":{\"6\":{},\"20\":{},\"138\":{}},\"parent\":{}}],[\"prefetchqueryservermodule\",{\"_index\":10,\"name\":{\"8\":{},\"21\":{},\"139\":{}},\"parent\":{}}],[\"queriesobserver\",{\"_index\":27,\"name\":{\"30\":{},\"146\":{}},\"parent\":{}}],[\"queriesoptions\",{\"_index\":119,\"name\":{\"123\":{},\"239\":{}},\"parent\":{}}],[\"queriesresults\",{\"_index\":120,\"name\":{\"124\":{},\"240\":{}},\"parent\":{}}],[\"query\",{\"_index\":38,\"name\":{\"42\":{},\"158\":{}},\"parent\":{}}],[\"querycache\",{\"_index\":25,\"name\":{\"27\":{},\"143\":{}},\"parent\":{}}],[\"queryclient\",{\"_index\":18,\"name\":{\"14\":{},\"28\":{},\"144\":{}},\"parent\":{}}],[\"queryclientconfig\",{\"_index\":101,\"name\":{\"105\":{},\"221\":{}},\"parent\":{}}],[\"queryclientprovider\",{\"_index\":105,\"name\":{\"109\":{},\"225\":{}},\"parent\":{}}],[\"queryclientproviderprops\",{\"_index\":116,\"name\":{\"120\":{},\"236\":{}},\"parent\":{}}],[\"queryerrorresetboundary\",{\"_index\":107,\"name\":{\"111\":{},\"227\":{}},\"parent\":{}}],[\"queryerrorresetboundaryprops\",{\"_index\":117,\"name\":{\"121\":{},\"237\":{}},\"parent\":{}}],[\"queryfunction\",{\"_index\":48,\"name\":{\"52\":{},\"168\":{}},\"parent\":{}}],[\"queryfunctioncontext\",{\"_index\":49,\"name\":{\"53\":{},\"169\":{}},\"parent\":{}}],[\"querykey\",{\"_index\":46,\"name\":{\"50\":{},\"166\":{}},\"parent\":{}}],[\"querykeyhashfunction\",{\"_index\":52,\"name\":{\"56\":{},\"172\":{}},\"parent\":{}}],[\"querymeta\",{\"_index\":56,\"name\":{\"60\":{},\"176\":{}},\"parent\":{}}],[\"queryobserver\",{\"_index\":26,\"name\":{\"29\":{},\"145\":{}},\"parent\":{}}],[\"queryobserverbaseresult\",{\"_index\":73,\"name\":{\"77\":{},\"193\":{}},\"parent\":{}}],[\"queryobserveridleresult\",{\"_index\":74,\"name\":{\"78\":{},\"194\":{}},\"parent\":{}}],[\"queryobserverloadingerrorresult\",{\"_index\":76,\"name\":{\"80\":{},\"196\":{}},\"parent\":{}}],[\"queryobserverloadingresult\",{\"_index\":75,\"name\":{\"79\":{},\"195\":{}},\"parent\":{}}],[\"queryobserveroptions\",{\"_index\":58,\"name\":{\"62\":{},\"178\":{}},\"parent\":{}}],[\"queryobserverrefetcherrorresult\",{\"_index\":77,\"name\":{\"81\":{},\"197\":{}},\"parent\":{}}],[\"queryobserverresult\",{\"_index\":79,\"name\":{\"83\":{},\"199\":{}},\"parent\":{}}],[\"queryobserversuccessresult\",{\"_index\":78,\"name\":{\"82\":{},\"198\":{}},\"parent\":{}}],[\"queryoptions\",{\"_index\":57,\"name\":{\"61\":{},\"177\":{}},\"parent\":{}}],[\"querystatus\",{\"_index\":72,\"name\":{\"76\":{},\"192\":{}},\"parent\":{}}],[\"react\",{\"_index\":16,\"name\":{\"13\":{}},\"parent\":{}}],[\"reactqueryfeature\",{\"_index\":1,\"name\":{\"1\":{},\"17\":{},\"19\":{},\"23\":{},\"141\":{}},\"parent\":{}}],[\"reactqueryfeatureoptions\",{\"_index\":14,\"name\":{\"11\":{},\"22\":{},\"140\":{}},\"parent\":{}}],[\"refetchoptions\",{\"_index\":64,\"name\":{\"68\":{},\"184\":{}},\"parent\":{}}],[\"refetchpagefilters\",{\"_index\":63,\"name\":{\"67\":{},\"183\":{}},\"parent\":{}}],[\"refetchqueryfilters\",{\"_index\":66,\"name\":{\"70\":{},\"186\":{}},\"parent\":{}}],[\"resetoptions\",{\"_index\":69,\"name\":{\"73\":{},\"189\":{}},\"parent\":{}}],[\"resetqueryfilters\",{\"_index\":67,\"name\":{\"71\":{},\"187\":{}},\"parent\":{}}],[\"resultoptions\",{\"_index\":62,\"name\":{\"66\":{},\"182\":{}},\"parent\":{}}],[\"servermodule\",{\"_index\":19,\"name\":{\"15\":{}},\"parent\":{}}],[\"setdataoptions\",{\"_index\":104,\"name\":{\"108\":{},\"224\":{}},\"parent\":{}}],[\"setlogger\",{\"_index\":31,\"name\":{\"34\":{},\"150\":{}},\"parent\":{}}],[\"shoulddehydratemutationfunction\",{\"_index\":44,\"name\":{\"48\":{},\"164\":{}},\"parent\":{}}],[\"shoulddehydratequeryfunction\",{\"_index\":45,\"name\":{\"49\":{},\"165\":{}},\"parent\":{}}],[\"usebasemutationresult\",{\"_index\":130,\"name\":{\"134\":{},\"250\":{}},\"parent\":{}}],[\"usebasequeryoptions\",{\"_index\":121,\"name\":{\"125\":{},\"241\":{}},\"parent\":{}}],[\"usebasequeryresult\",{\"_index\":124,\"name\":{\"128\":{},\"244\":{}},\"parent\":{}}],[\"usehydrate\",{\"_index\":115,\"name\":{\"119\":{},\"235\":{}},\"parent\":{}}],[\"useinfinitequery\",{\"_index\":114,\"name\":{\"118\":{},\"234\":{}},\"parent\":{}}],[\"useinfinitequeryoptions\",{\"_index\":123,\"name\":{\"127\":{},\"243\":{}},\"parent\":{}}],[\"useinfinitequeryresult\",{\"_index\":126,\"name\":{\"130\":{},\"246\":{}},\"parent\":{}}],[\"useisfetching\",{\"_index\":109,\"name\":{\"113\":{},\"229\":{}},\"parent\":{}}],[\"useismutating\",{\"_index\":110,\"name\":{\"114\":{},\"230\":{}},\"parent\":{}}],[\"usemutateasyncfunction\",{\"_index\":129,\"name\":{\"133\":{},\"249\":{}},\"parent\":{}}],[\"usemutatefunction\",{\"_index\":128,\"name\":{\"132\":{},\"248\":{}},\"parent\":{}}],[\"usemutation\",{\"_index\":111,\"name\":{\"115\":{},\"231\":{}},\"parent\":{}}],[\"usemutationoptions\",{\"_index\":127,\"name\":{\"131\":{},\"247\":{}},\"parent\":{}}],[\"usemutationresult\",{\"_index\":131,\"name\":{\"135\":{},\"251\":{}},\"parent\":{}}],[\"usequeries\",{\"_index\":113,\"name\":{\"117\":{},\"233\":{}},\"parent\":{}}],[\"usequery\",{\"_index\":112,\"name\":{\"116\":{},\"232\":{}},\"parent\":{}}],[\"usequeryclient\",{\"_index\":106,\"name\":{\"110\":{},\"226\":{}},\"parent\":{}}],[\"usequeryerrorresetboundary\",{\"_index\":108,\"name\":{\"112\":{},\"228\":{}},\"parent\":{}}],[\"usequeryoptions\",{\"_index\":122,\"name\":{\"126\":{},\"242\":{}},\"parent\":{}}],[\"usequeryresult\",{\"_index\":125,\"name\":{\"129\":{},\"245\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/packages/xarc-react-query/docs/assets/style.css b/packages/xarc-react-query/docs/assets/style.css new file mode 100644 index 000000000..6127b27cd --- /dev/null +++ b/packages/xarc-react-query/docs/assets/style.css @@ -0,0 +1,1414 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/packages/xarc-react-query/docs/assets/images/widgets.png b/packages/xarc-react-query/docs/assets/widgets.png similarity index 100% rename from packages/xarc-react-query/docs/assets/images/widgets.png rename to packages/xarc-react-query/docs/assets/widgets.png diff --git a/packages/xarc-react-query/docs/assets/images/widgets@2x.png b/packages/xarc-react-query/docs/assets/widgets@2x.png similarity index 100% rename from packages/xarc-react-query/docs/assets/images/widgets@2x.png rename to packages/xarc-react-query/docs/assets/widgets@2x.png diff --git a/packages/xarc-react-query/docs/classes/browser.Mutation.html b/packages/xarc-react-query/docs/classes/browser.Mutation.html new file mode 100644 index 000000000..f2b17cfbf --- /dev/null +++ b/packages/xarc-react-query/docs/classes/browser.Mutation.html @@ -0,0 +1 @@ +Mutation | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Mutation<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

  • Mutation

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Mutation<TData, TError, TVariables, TContext>(config: MutationConfig<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    • config: MutationConfig<TData, TError, TVariables, TContext>

    Returns Mutation<TData, TError, TVariables, TContext>

Properties

Private dispatch

dispatch: any

Private executeMutation

executeMutation: any

meta

meta: MutationMeta

Private mutationCache

mutationCache: any

mutationId

mutationId: number

Private observers

observers: any

options

options: MutationOptions<TData, TError, TVariables, TContext>

Private Optional retryer

retryer?: any

state

state: MutationState<TData, TError, TVariables, TContext>

Methods

addObserver

  • Parameters

    Returns void

cancel

  • cancel(): Promise<void>

  • Returns Promise<void>

continue

  • continue(): Promise<TData>

  • Returns Promise<TData>

execute

  • execute(): Promise<TData>

  • Returns Promise<TData>

removeObserver

  • Parameters

    Returns void

setState

  • setState(state: MutationState<TData, TError, TVariables, TContext>): void

  • Parameters

    • state: MutationState<TData, TError, TVariables, TContext>

    Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.cancellederror.html b/packages/xarc-react-query/docs/classes/browser.cancellederror.html index 541ee5865..7a2fc42d6 100644 --- a/packages/xarc-react-query/docs/classes/browser.cancellederror.html +++ b/packages/xarc-react-query/docs/classes/browser.cancellederror.html @@ -1,212 +1 @@ - - - - - - CancelledError | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class CancelledError

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - CancelledError -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -

    Parameters

    -
      -
    • -
      Optional options: CancelOptions
      -
      • -
    -

    Returns CancelledError

    -
    • -
-
-
-
-

Properties

-
- -

Optional revert

-
revert: boolean
- -
-
- -

Optional silent

-
silent: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +CancelledError | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CancelledError

Hierarchy

  • CancelledError

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    Returns CancelledError

Properties

Optional revert

revert?: boolean

Optional silent

silent?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.infinitequeryobserver.html b/packages/xarc-react-query/docs/classes/browser.infinitequeryobserver.html index a0c31bce4..6b5362eba 100644 --- a/packages/xarc-react-query/docs/classes/browser.infinitequeryobserver.html +++ b/packages/xarc-react-query/docs/classes/browser.infinitequeryobserver.html @@ -1,884 +1 @@ - - - - - - InfiniteQueryObserver | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryData = TQueryFnData

      -
      • -
    -

    Parameters

    - -

    Returns InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData>

    -
    • -
-
-
-
-

Properties

-
- -

Protected fetch

-
fetch: (fetchOptions?: ObserverFetchOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

getCurrentResult

-
getCurrentResult: () => InfiniteQueryObserverResult<TData, TError>
- -
-

Type declaration

- -
-
-
- -

Protected listeners

-
listeners: QueryObserverListener<InfiniteData<TData>, TError>[]
- -
-
- -

options

-
options: QueryObserverOptions<TQueryFnData, TError, InfiniteData<TData>, InfiniteData<TQueryData>, QueryKey>
- -
-
- -

subscribe

-
subscribe: (listener?: InfiniteQueryObserverListener<TData, TError>) => () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (listener?: InfiniteQueryObserverListener<TData, TError>): () => void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        Optional listener: InfiniteQueryObserverListener<TData, TError>
        -
        • -
      -

      Returns () => void

      -
        -
      • -
          -
        • (): void
          • -
        -
          -
        • -

          Returns void

          -
          • -
        -
        • -
      -
      • -
    -
    • -
-
-
-
-
-

Methods

-
- -

Protected bindMethods

-
    -
  • bindMethods(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected createResult

- - -
-
- -

destroy

-
    -
  • destroy(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

fetchNextPage

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<InfiniteQueryObserverResult<TData, TError>>

    -
    • -
-
-
- -

fetchOptimistic

- - -
-
- -

fetchPreviousPage

- - -
-
- -

getCurrentQuery

- - -
-
- -

getNextResult

- - -
-
- -

getOptimisticResult

- - -
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

onQueryUpdate

-
    -
  • onQueryUpdate(action: Action<InfiniteData<TData>, TError>): void
    • -
-
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

refetch

- - -
-
- -

remove

-
    -
  • remove(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

setOptions

- - -
-
- -

shouldFetchOnReconnect

-
    -
  • shouldFetchOnReconnect(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

shouldFetchOnWindowFocus

-
    -
  • shouldFetchOnWindowFocus(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

trackResult

- - -
-
- -

updateResult

-
    -
  • updateResult(notifyOptions?: NotifyOptions): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional notifyOptions: NotifyOptions
      -
      • -
    -

    Returns void

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserver | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryData = TQueryFnData

    Parameters

    Returns InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData>

Properties

Protected fetch

fetch: ((fetchOptions?: ObserverFetchOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>)

Type declaration

getCurrentResult

getCurrentResult: (() => InfiniteQueryObserverResult<TData, TError>)

Type declaration

Protected listeners

listeners: QueryObserverListener<InfiniteData<TData>, TError>[]

options

options: QueryObserverOptions<TQueryFnData, TError, InfiniteData<TData>, InfiniteData<TQueryData>, QueryKey>

subscribe

subscribe: ((listener?: InfiniteQueryObserverListener<TData, TError>) => (() => void))

Type declaration

    • (listener?: InfiniteQueryObserverListener<TData, TError>): (() => void)

    • Parameters

      • Optional listener: InfiniteQueryObserverListener<TData, TError>

      Returns (() => void)

        • (): void

        • Returns void

Methods

Protected bindMethods

  • bindMethods(): void

  • Returns void

Protected createResult

destroy

  • destroy(): void

  • Returns void

fetchNextPage

  • Parameters

    Returns Promise<InfiniteQueryObserverResult<TData, TError>>

fetchOptimistic

fetchPreviousPage

  • Parameters

    Returns Promise<InfiniteQueryObserverResult<TData, TError>>

getCurrentQuery

getNextResult

getOptimisticResult

hasListeners

  • hasListeners(): boolean

  • Returns boolean

onQueryUpdate

  • onQueryUpdate(action: Action<InfiniteData<TData>, TError>): void

  • Parameters

    Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

refetch

remove

  • remove(): void

  • Returns void

setOptions

  • Parameters

    Returns void

shouldFetchOnReconnect

  • shouldFetchOnReconnect(): boolean

  • Returns boolean

shouldFetchOnWindowFocus

  • shouldFetchOnWindowFocus(): boolean

  • Returns boolean

trackResult

updateResult

  • updateResult(notifyOptions?: NotifyOptions): void

  • Parameters

    • Optional notifyOptions: NotifyOptions

    Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.mutationcache.html b/packages/xarc-react-query/docs/classes/browser.mutationcache.html index a7d2f8230..19c9cdf4c 100644 --- a/packages/xarc-react-query/docs/classes/browser.mutationcache.html +++ b/packages/xarc-react-query/docs/classes/browser.mutationcache.html @@ -1,664 +1 @@ - - - - - - MutationCache | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class MutationCache

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Subscribable<MutationCacheListener> -
      -
    • - MutationCache -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new MutationCache(config?: MutationCacheConfig): MutationCache
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional config: MutationCacheConfig
      -
      • -
    -

    Returns MutationCache

    -
    • -
-
-
-
-

Properties

-
- -

config

-
config: MutationCacheConfig
- -
-
- -

Protected listeners

-
listeners: MutationCacheListener[]
- -
-
- -

Private mutationId

-
mutationId: any
- -
-
- -

Private mutations

-
mutations: any
- -
-
-
-

Methods

-
- -

add

-
    -
  • add(mutation: Mutation<any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      mutation: Mutation<any, any, any, any>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

build

-
    -
  • build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData

      -
      • -
    • -

      TError

      -
      • -
    • -

      TVariables

      -
      • -
    • -

      TContext

      -
      • -
    -

    Parameters

    -
      -
    • -
      client: QueryClient
      -
      • -
    • -
      options: MutationOptions<TData, TError, TVariables, TContext>
      -
      • -
    • -
      Optional state: MutationState<TData, TError, TVariables, TContext>
      -
      • -
    -

    Returns Mutation<TData, TError, TVariables, TContext>

    -
    • -
-
-
- -

clear

-
    -
  • clear(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

find

-
    -
  • find<TData, TError, TVariables, TContext>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = any

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    -
      -
    • -
      filters: MutationFilters
      -
      • -
    -

    Returns Mutation<TData, TError, TVariables, TContext>

    -
    • -
-
-
- -

findAll

-
    -
  • findAll(filters: MutationFilters): Mutation<unknown, unknown, void, unknown>[]
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      filters: MutationFilters
      -
      • -
    -

    Returns Mutation<unknown, unknown, void, unknown>[]

    -
    • -
-
-
- -

getAll

-
    -
  • getAll(): Mutation<unknown, unknown, void, unknown>[]
    • -
-
    -
  • - -

    Returns Mutation<unknown, unknown, void, unknown>[]

    -
    • -
-
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

notify

-
    -
  • notify(mutation?: Mutation<any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional mutation: Mutation<any, any, any, any>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

onFocus

-
    -
  • onFocus(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

onOnline

-
    -
  • onOnline(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

remove

-
    -
  • remove(mutation: Mutation<any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      mutation: Mutation<any, any, any, any>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

resumePausedMutations

-
    -
  • resumePausedMutations(): Promise<void>
    • -
-
    -
  • - -

    Returns Promise<void>

    -
    • -
-
-
- -

subscribe

-
    -
  • subscribe(listener?: MutationCacheListener): () => void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional listener: MutationCacheListener
      -
      • -
    -

    Returns () => void

    -
      -
    • -
        -
      • (): void
        • -
      -
        -
      • -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutationCache | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutationCache

Hierarchy

  • Subscribable<MutationCacheListener>
    • MutationCache

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional config: MutationCacheConfig

    Returns MutationCache

Properties

config

config: MutationCacheConfig

Protected listeners

listeners: MutationCacheListener[]

Private mutationId

mutationId: any

Private mutations

mutations: any

Methods

add

  • add(mutation: Mutation<any, any, any, any>): void

  • Parameters

    Returns void

build

  • build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData

    • TError

    • TVariables

    • TContext

    Parameters

    • client: QueryClient
    • options: MutationOptions<TData, TError, TVariables, TContext>
    • Optional state: MutationState<TData, TError, TVariables, TContext>

    Returns Mutation<TData, TError, TVariables, TContext>

clear

  • clear(): void

  • Returns void

find

  • find<TData, TError, TVariables, TContext>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = any

    • TContext = unknown

    Parameters

    • filters: MutationFilters

    Returns Mutation<TData, TError, TVariables, TContext>

findAll

  • findAll(filters: MutationFilters): Mutation<unknown, unknown, void, unknown>[]

  • Parameters

    • filters: MutationFilters

    Returns Mutation<unknown, unknown, void, unknown>[]

getAll

  • getAll(): Mutation<unknown, unknown, void, unknown>[]

  • Returns Mutation<unknown, unknown, void, unknown>[]

hasListeners

  • hasListeners(): boolean

  • Returns boolean

notify

  • notify(mutation?: Mutation<any, any, any, any>): void

  • Parameters

    • Optional mutation: Mutation<any, any, any, any>

    Returns void

onFocus

  • onFocus(): void

  • Returns void

onOnline

  • onOnline(): void

  • Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

remove

  • remove(mutation: Mutation<any, any, any, any>): void

  • Parameters

    Returns void

resumePausedMutations

  • resumePausedMutations(): Promise<void>

  • Returns Promise<void>

subscribe

  • subscribe(listener?: MutationCacheListener): (() => void)

  • Parameters

    • Optional listener: MutationCacheListener

    Returns (() => void)

      • (): void

      • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.mutationobserver.html b/packages/xarc-react-query/docs/classes/browser.mutationobserver.html index 2f7f45fc8..28a5b54a6 100644 --- a/packages/xarc-react-query/docs/classes/browser.mutationobserver.html +++ b/packages/xarc-react-query/docs/classes/browser.mutationobserver.html @@ -1,599 +1 @@ - - - - - - MutationObserver | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class MutationObserver<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>> -
      -
    • - MutationObserver -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns MutationObserver<TData, TError, TVariables, TContext>

    -
    • -
-
-
-
-

Properties

-
- -

Private client

-
client: any
- -
-
- -

Private Optional currentMutation

-
currentMutation: any
- -
-
- -

Private currentResult

-
currentResult: any
- -
-
- -

Protected listeners

-
listeners: MutationObserverListener<TData, TError, TVariables, TContext>[]
- -
-
- -

Private Optional mutateOptions

-
mutateOptions: any
- -
-
- -

Private notify

-
notify: any
- -
-
- -

options

-
options: MutationObserverOptions<TData, TError, TVariables, TContext>
- -
-
- -

Private updateResult

-
updateResult: any
- -
-
-
-

Methods

-
- -

Protected bindMethods

-
    -
  • bindMethods(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

getCurrentResult

- -
    -
  • - -

    Returns MutationObserverResult<TData, TError, TVariables, TContext>

    -
    • -
-
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

mutate

-
    -
  • mutate(variables?: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional variables: TVariables
      -
      • -
    • -
      Optional options: MutateOptions<TData, TError, TVariables, TContext>
      -
      • -
    -

    Returns Promise<TData>

    -
    • -
-
-
- -

onMutationUpdate

-
    -
  • onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      action: Action<TData, TError, TVariables, TContext>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

reset

-
    -
  • reset(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

setOptions

- -
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

subscribe

-
    -
  • subscribe(listener?: MutationObserverListener<TData, TError, TVariables, TContext>): () => void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional listener: MutationObserverListener<TData, TError, TVariables, TContext>
      -
      • -
    -

    Returns () => void

    -
      -
    • -
        -
      • (): void
        • -
      -
        -
      • -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutationObserver | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutationObserver<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

  • Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>>
    • MutationObserver

Index

Constructors

Properties

Methods

Constructors

constructor

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns MutationObserver<TData, TError, TVariables, TContext>

Properties

Private client

client: any

Private Optional currentMutation

currentMutation?: any

Private currentResult

currentResult: any

Protected listeners

listeners: MutationObserverListener<TData, TError, TVariables, TContext>[]

Private Optional mutateOptions

mutateOptions?: any

Private notify

notify: any

options

options: MutationObserverOptions<TData, TError, TVariables, TContext>

Private updateResult

updateResult: any

Methods

Protected bindMethods

  • bindMethods(): void

  • Returns void

getCurrentResult

  • Returns MutationObserverResult<TData, TError, TVariables, TContext>

hasListeners

  • hasListeners(): boolean

  • Returns boolean

mutate

  • mutate(variables?: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>

  • Parameters

    • Optional variables: TVariables
    • Optional options: MutateOptions<TData, TError, TVariables, TContext>

    Returns Promise<TData>

onMutationUpdate

  • onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void

  • Parameters

    • action: Action<TData, TError, TVariables, TContext>

    Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

reset

  • reset(): void

  • Returns void

setOptions

  • Parameters

    Returns void

subscribe

  • subscribe(listener?: MutationObserverListener<TData, TError, TVariables, TContext>): (() => void)

  • Parameters

    • Optional listener: MutationObserverListener<TData, TError, TVariables, TContext>

    Returns (() => void)

      • (): void

      • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.queriesobserver.html b/packages/xarc-react-query/docs/classes/browser.queriesobserver.html index 7a042e58c..cc122f271 100644 --- a/packages/xarc-react-query/docs/classes/browser.queriesobserver.html +++ b/packages/xarc-react-query/docs/classes/browser.queriesobserver.html @@ -1,547 +1 @@ - - - - - - QueriesObserver | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class QueriesObserver

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Subscribable<QueriesObserverListener> -
      -
    • - QueriesObserver -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -

    Parameters

    - -

    Returns QueriesObserver

    -
    • -
-
-
-
-

Properties

-
- -

Private client

-
client: any
- -
-
- -

Private getObserver

-
getObserver: any
- -
-
- -

Protected listeners

-
listeners: QueriesObserverListener[]
- -
-
- -

Private notify

-
notify: any
- -
-
- -

Private observers

-
observers: any
- -
-
- -

Private observersMap

-
observersMap: any
- -
-
- -

Private onUpdate

-
onUpdate: any
- -
-
- -

Private queries

-
queries: any
- -
-
- -

Private result

-
result: any
- -
-
- -

Private updateObservers

-
updateObservers: any
- -
-
-
-

Methods

-
- -

destroy

-
    -
  • destroy(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

getCurrentResult

- -
    -
  • - -

    Returns QueryObserverResult<unknown, unknown>[]

    -
    • -
-
-
- -

getOptimisticResult

- -
    -
  • - -

    Parameters

    - -

    Returns QueryObserverResult<unknown, unknown>[]

    -
    • -
-
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

setQueries

- -
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

subscribe

-
    -
  • subscribe(listener?: QueriesObserverListener): () => void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional listener: QueriesObserverListener
      -
      • -
    -

    Returns () => void

    -
      -
    • -
        -
      • (): void
        • -
      -
        -
      • -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueriesObserver | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueriesObserver

Hierarchy

  • Subscribable<QueriesObserverListener>
    • QueriesObserver

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns QueriesObserver

Properties

Private client

client: any

Private findMatchingObservers

findMatchingObservers: any

Private getObserver

getObserver: any

Protected listeners

listeners: QueriesObserverListener[]

Private notify

notify: any

Private observers

observers: any

Private observersMap

observersMap: any

Private onUpdate

onUpdate: any

Private queries

queries: any

Private result

result: any

Private updateObservers

updateObservers: any

Methods

destroy

  • destroy(): void

  • Returns void

getCurrentResult

  • Returns QueryObserverResult<unknown, unknown>[]

getOptimisticResult

  • Parameters

    Returns QueryObserverResult<unknown, unknown>[]

hasListeners

  • hasListeners(): boolean

  • Returns boolean

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

setQueries

  • Parameters

    Returns void

subscribe

  • subscribe(listener?: QueriesObserverListener): (() => void)

  • Parameters

    • Optional listener: QueriesObserverListener

    Returns (() => void)

      • (): void

      • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.query.html b/packages/xarc-react-query/docs/classes/browser.query.html index bd174cdca..ce8a3a93a 100644 --- a/packages/xarc-react-query/docs/classes/browser.query.html +++ b/packages/xarc-react-query/docs/classes/browser.query.html @@ -1,926 +1 @@ - - - - - - Query | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class Query<TQueryFnData, TError, TData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

-
    -
  • - Query -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new Query<TQueryFnData, TError, TData, TQueryKey>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>): Query<TQueryFnData, TError, TData, TQueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns Query<TQueryFnData, TError, TData, TQueryKey>

    -
    • -
-
-
-
-

Properties

-
- -

Private cache

-
cache: any
- -
-
- -

cacheTime

-
cacheTime: number
- -
-
- -

Private clearGcTimeout

-
clearGcTimeout: any
- -
-
- -

Private Optional defaultOptions

-
defaultOptions: any
- -
-
- -

Private dispatch

-
dispatch: any
- -
-
- -

Private Optional gcTimeout

-
gcTimeout: any
- -
-
- -

initialState

-
initialState: QueryState<TData, TError>
- -
-
- -

Private observers

-
observers: any
- -
-
- -

Private optionalRemove

-
optionalRemove: any
- -
-
- -

options

-
options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
- -
-
- -

Private Optional promise

-
promise: any
- -
-
- -

queryHash

-
queryHash: string
- -
-
- -

queryKey

-
queryKey: TQueryKey
- -
-
- -

Private Optional retryer

-
retryer: any
- -
-
- -

Optional revertState

-
revertState: QueryState<TData, TError>
- -
-
- -

Private scheduleGc

-
scheduleGc: any
- -
-
- -

Private setOptions

-
setOptions: any
- -
-
- -

state

-
state: QueryState<TData, TError>
- -
-
-
-

Methods

-
- -

addObserver

-
    -
  • addObserver(observer: QueryObserver<any, any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

cancel

-
    -
  • cancel(options?: CancelOptions): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional options: CancelOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

destroy

-
    -
  • destroy(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

fetch

-
    -
  • fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    • -
      Optional fetchOptions: FetchOptions
      -
      • -
    -

    Returns Promise<TData>

    -
    • -
-
-
- -

Protected getDefaultState

-
    -
  • getDefaultState(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): QueryState<TData, TError>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns QueryState<TData, TError>

    -
    • -
-
-
- -

invalidate

-
    -
  • invalidate(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

isActive

-
    -
  • isActive(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

isFetching

-
    -
  • isFetching(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

isStale

-
    -
  • isStale(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

isStaleByTime

-
    -
  • isStaleByTime(staleTime?: number): boolean
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional staleTime: number
      -
      • -
    -

    Returns boolean

    -
    • -
-
-
- -

onFocus

-
    -
  • onFocus(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

onOnline

-
    -
  • onOnline(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected reducer

-
    -
  • reducer(state: QueryState<TData, TError>, action: Action<TData, TError>): QueryState<TData, TError>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      state: QueryState<TData, TError>
      -
      • -
    • -
      action: Action<TData, TError>
      -
      • -
    -

    Returns QueryState<TData, TError>

    -
    • -
-
-
- -

removeObserver

-
    -
  • removeObserver(observer: QueryObserver<any, any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

reset

-
    -
  • reset(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

setData

-
    -
  • setData(updater: Updater<TData, TData>, options?: SetDataOptions): TData
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      updater: Updater<TData, TData>
      -
      • -
    • -
      Optional options: SetDataOptions
      -
      • -
    -

    Returns TData

    -
    • -
-
-
- -

setDefaultOptions

-
    -
  • setDefaultOptions(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

setState

-
    -
  • setState(state: QueryState<TData, TError>, setStateOptions?: SetStateOptions): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      state: QueryState<TData, TError>
      -
      • -
    • -
      Optional setStateOptions: SetStateOptions
      -
      • -
    -

    Returns void

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +Query | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Query<TQueryFnData, TError, TData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

  • Query

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Query<TQueryFnData, TError, TData, TQueryKey>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>): Query<TQueryFnData, TError, TData, TQueryKey>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>

    Returns Query<TQueryFnData, TError, TData, TQueryKey>

Properties

Private abortSignalConsumed

abortSignalConsumed: any

Private cache

cache: any

cacheTime

cacheTime: number

Private clearGcTimeout

clearGcTimeout: any

Private Optional defaultOptions

defaultOptions?: any

Private dispatch

dispatch: any

Private Optional gcTimeout

gcTimeout?: any

Private hadObservers

hadObservers: any

initialState

initialState: QueryState<TData, TError>

meta

meta: QueryMeta

Private observers

observers: any

Private optionalRemove

optionalRemove: any

options

options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>

Private Optional promise

promise?: any

queryHash

queryHash: string

queryKey

queryKey: TQueryKey

Private Optional retryer

retryer?: any

Optional revertState

revertState?: QueryState<TData, TError>

Private scheduleGc

scheduleGc: any

Private setOptions

setOptions: any

state

state: QueryState<TData, TError>

Methods

addObserver

  • addObserver(observer: QueryObserver<any, any, any, any, any>): void

  • Parameters

    Returns void

cancel

  • Parameters

    Returns Promise<void>

destroy

  • destroy(): void

  • Returns void

fetch

  • fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>

  • Parameters

    • Optional options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
    • Optional fetchOptions: FetchOptions

    Returns Promise<TData>

Protected getDefaultState

  • getDefaultState(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): QueryState<TData, TError>

  • Parameters

    • options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>

    Returns QueryState<TData, TError>

getObserversCount

  • getObserversCount(): number

  • Returns number

invalidate

  • invalidate(): void

  • Returns void

isActive

  • isActive(): boolean

  • Returns boolean

isFetching

  • isFetching(): boolean

  • Returns boolean

isStale

  • isStale(): boolean

  • Returns boolean

isStaleByTime

  • isStaleByTime(staleTime?: number): boolean

  • Parameters

    • Optional staleTime: number

    Returns boolean

onFocus

  • onFocus(): void

  • Returns void

onOnline

  • onOnline(): void

  • Returns void

Protected reducer

  • reducer(state: QueryState<TData, TError>, action: Action<TData, TError>): QueryState<TData, TError>

  • Parameters

    • state: QueryState<TData, TError>
    • action: Action<TData, TError>

    Returns QueryState<TData, TError>

removeObserver

  • removeObserver(observer: QueryObserver<any, any, any, any, any>): void

  • Parameters

    Returns void

reset

  • reset(): void

  • Returns void

setData

  • setData(updater: Updater<TData, TData>, options?: SetDataOptions): TData

  • Parameters

    Returns TData

setDefaultOptions

  • setDefaultOptions(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void

  • Parameters

    • options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>

    Returns void

setState

  • setState(state: QueryState<TData, TError>, setStateOptions?: SetStateOptions): void

  • Parameters

    • state: QueryState<TData, TError>
    • Optional setStateOptions: SetStateOptions

    Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.querycache.html b/packages/xarc-react-query/docs/classes/browser.querycache.html index dff17ee2f..f643629a9 100644 --- a/packages/xarc-react-query/docs/classes/browser.querycache.html +++ b/packages/xarc-react-query/docs/classes/browser.querycache.html @@ -1,721 +1 @@ - - - - - - QueryCache | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class QueryCache

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Subscribable<QueryCacheListener> -
      -
    • - QueryCache -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new QueryCache(config?: QueryCacheConfig): QueryCache
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional config: QueryCacheConfig
      -
      • -
    -

    Returns QueryCache

    -
    • -
-
-
-
-

Properties

-
- -

config

-
config: QueryCacheConfig
- -
-
- -

Protected listeners

-
listeners: QueryCacheListener[]
- -
-
- -

Private queries

-
queries: any
- -
-
- -

Private queriesMap

-
queriesMap: any
- -
-
-
-

Methods

-
- -

add

-
    -
  • add(query: Query<any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      query: Query<any, any, any, any>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

build

-
    -
  • build<TQueryFnData, TError, TData, TQueryKey>(client: QueryClient, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData

      -
      • -
    • -

      TError

      -
      • -
    • -

      TData

      -
      • -
    • -

      TQueryKey: QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      client: QueryClient
      -
      • -
    • -
      options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    • -
      Optional state: QueryState<TData, TError>
      -
      • -
    -

    Returns Query<TQueryFnData, TError, TData, TQueryKey>

    -
    • -
-
-
- -

clear

-
    -
  • clear(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

find

-
    -
  • find<TQueryFnData, TError, TData>(arg1: QueryKey, arg2?: QueryFilters): Query<TQueryFnData, TError, TData, QueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    -

    Parameters

    -
      -
    • -
      arg1: QueryKey
      -
      • -
    • -
      Optional arg2: QueryFilters
      -
      • -
    -

    Returns Query<TQueryFnData, TError, TData, QueryKey>

    -
    • -
-
-
- -

findAll

-
    -
  • findAll(queryKey?: QueryKey, filters?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]
    • -
  • findAll(filters?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]
    • -
  • findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns Query<unknown, unknown, unknown, QueryKey>[]

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns Query<unknown, unknown, unknown, QueryKey>[]

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional arg1: QueryKey | QueryFilters
      -
      • -
    • -
      Optional arg2: QueryFilters
      -
      • -
    -

    Returns Query<unknown, unknown, unknown, QueryKey>[]

    -
    • -
-
-
- -

get

-
    -
  • get<TQueryFnData, TError, TData, TQueyKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueyKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueyKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryHash: string
      -
      • -
    -

    Returns Query<TQueryFnData, TError, TData, TQueyKey>

    -
    • -
-
-
- -

getAll

- -
    -
  • - -

    Returns Query<unknown, unknown, unknown, QueryKey>[]

    -
    • -
-
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

notify

-
    -
  • notify(event: QueryCacheNotifyEvent): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      event: QueryCacheNotifyEvent
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

onFocus

-
    -
  • onFocus(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

onOnline

-
    -
  • onOnline(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

remove

-
    -
  • remove(query: Query<any, any, any, any>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      query: Query<any, any, any, any>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

subscribe

-
    -
  • subscribe(listener?: QueryCacheListener): () => void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional listener: QueryCacheListener
      -
      • -
    -

    Returns () => void

    -
      -
    • -
        -
      • (): void
        • -
      -
        -
      • -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryCache | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryCache

Hierarchy

  • Subscribable<QueryCacheListener>
    • QueryCache

Index

Constructors

Properties

Methods

Constructors

constructor

  • new QueryCache(config?: QueryCacheConfig): QueryCache

  • Parameters

    • Optional config: QueryCacheConfig

    Returns QueryCache

Properties

config

config: QueryCacheConfig

Protected listeners

listeners: QueryCacheListener[]

Private queries

queries: any

Private queriesMap

queriesMap: any

Methods

add

  • add(query: Query<any, any, any, any>): void

  • Parameters

    • query: Query<any, any, any, any>

    Returns void

build

  • build<TQueryFnData, TError, TData, TQueryKey>(client: QueryClient, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>

  • Type Parameters

    • TQueryFnData

    • TError

    • TData

    • TQueryKey extends QueryKey

    Parameters

    • client: QueryClient
    • options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
    • Optional state: QueryState<TData, TError>

    Returns Query<TQueryFnData, TError, TData, TQueryKey>

clear

  • clear(): void

  • Returns void

find

  • find<TQueryFnData, TError, TData>(arg1: QueryKey, arg2?: QueryFilters): Query<TQueryFnData, TError, TData, QueryKey>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    Parameters

    • arg1: QueryKey
    • Optional arg2: QueryFilters

    Returns Query<TQueryFnData, TError, TData, QueryKey>

findAll

  • findAll(queryKey?: QueryKey, filters?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]
  • findAll(filters?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]
  • findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query<unknown, unknown, unknown, QueryKey>[]

  • Parameters

    • Optional queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns Query<unknown, unknown, unknown, QueryKey>[]

  • Parameters

    • Optional filters: QueryFilters

    Returns Query<unknown, unknown, unknown, QueryKey>[]

  • Parameters

    • Optional arg1: QueryKey | QueryFilters
    • Optional arg2: QueryFilters

    Returns Query<unknown, unknown, unknown, QueryKey>[]

get

  • get<TQueryFnData, TError, TData, TQueyKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueyKey>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueyKey extends QueryKey = QueryKey

    Parameters

    • queryHash: string

    Returns Query<TQueryFnData, TError, TData, TQueyKey>

getAll

  • Returns Query<unknown, unknown, unknown, QueryKey>[]

hasListeners

  • hasListeners(): boolean

  • Returns boolean

notify

  • notify(event: QueryCacheNotifyEvent): void

  • Parameters

    • event: QueryCacheNotifyEvent

    Returns void

onFocus

  • onFocus(): void

  • Returns void

onOnline

  • onOnline(): void

  • Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

remove

  • remove(query: Query<any, any, any, any>): void

  • Parameters

    • query: Query<any, any, any, any>

    Returns void

subscribe

  • subscribe(listener?: QueryCacheListener): (() => void)

  • Parameters

    • Optional listener: QueryCacheListener

    Returns (() => void)

      • (): void

      • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.queryclient.html b/packages/xarc-react-query/docs/classes/browser.queryclient.html index fc14baff6..839a4c8d6 100644 --- a/packages/xarc-react-query/docs/classes/browser.queryclient.html +++ b/packages/xarc-react-query/docs/classes/browser.queryclient.html @@ -1,1643 +1 @@ - - - - - - QueryClient | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class QueryClient

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - QueryClient -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new QueryClient(config?: QueryClientConfig): QueryClient
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional config: QueryClientConfig
      -
      • -
    -

    Returns QueryClient

    -
    • -
-
-
-
-

Properties

-
- -

Private defaultOptions

-
defaultOptions: any
- -
-
- -

Private mutationCache

-
mutationCache: any
- -
-
- -

Private mutationDefaults

-
mutationDefaults: any
- -
-
- -

Private queryCache

-
queryCache: any
- -
-
- -

Private queryDefaults

-
queryDefaults: any
- -
-
- -

Private Optional unsubscribeFocus

-
unsubscribeFocus: any
- -
-
- -

Private Optional unsubscribeOnline

-
unsubscribeOnline: any
- -
-
-
-

Methods

-
- -

cancelMutations

-
    -
  • cancelMutations(): Promise<void>
    • -
-
    -
  • - -

    Returns Promise<void>

    -
    • -
-
-
- -

cancelQueries

-
    -
  • cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>
    • -
  • cancelQueries(queryKey?: QueryKey, filters?: QueryFilters, options?: CancelOptions): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: CancelOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: CancelOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

clear

-
    -
  • clear(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

defaultMutationOptions

-
    -
  • defaultMutationOptions<T>(options?: T): T
    • -
-
    -
  • - -

    Type parameters

    - -

    Parameters

    -
      -
    • -
      Optional options: T
      -
      • -
    -

    Returns T

    -
    • -
-
-
- -

defaultQueryObserverOptions

-
    -
  • defaultQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData

      -
      • -
    • -

      TError

      -
      • -
    • -

      TData

      -
      • -
    • -

      TQueryData

      -
      • -
    • -

      TQueryKey: QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
      -
      • -
    -

    Returns QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

    -
    • -
-
-
- -

defaultQueryOptions

-
    -
  • defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData

      -
      • -
    • -

      TError

      -
      • -
    • -

      TData

      -
      • -
    • -

      TQueryData

      -
      • -
    • -

      TQueryKey: QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
      -
      • -
    -

    Returns QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

    -
    • -
-
-
- -

executeMutation

-
    -
  • executeMutation<TData, TError, TVariables, TContext>(options: MutationOptions<TData, TError, TVariables, TContext>): Promise<TData>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns Promise<TData>

    -
    • -
-
-
- -

fetchInfiniteQuery

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<InfiniteData<TData>>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<InfiniteData<TData>>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<InfiniteData<TData>>

    -
    • -
-
-
- -

fetchQuery

-
    -
  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>
    • -
  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>
    • -
  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<TData>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns Promise<TData>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      queryFn: QueryFunction<TQueryFnData, TQueryKey>
      -
      • -
    • -
      Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns Promise<TData>

    -
    • -
-
-
- -

getDefaultOptions

- -
    -
  • - -

    Returns DefaultOptions<unknown>

    -
    • -
-
-
- -

getMutationCache

- -
    -
  • - -

    Returns MutationCache

    -
    • -
-
-
- -

getMutationDefaults

- -
    -
  • - -

    Parameters

    - -

    Returns MutationObserverOptions<any, any, any, any>

    -
    • -
-
-
- -

getQueryCache

- -
    -
  • - -

    Returns QueryCache

    -
    • -
-
-
- -

getQueryData

-
    -
  • getQueryData<TData>(queryKey: QueryKey, filters?: QueryFilters): TData
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns TData

    -
    • -
-
-
- -

getQueryDefaults

- -
    -
  • - -

    Parameters

    - -

    Returns QueryObserverOptions<any, any, any, any, any>

    -
    • -
-
-
- -

getQueryState

-
    -
  • getQueryState<TData, TError>(queryKey: QueryKey, filters?: QueryFilters): QueryState<TData, TError>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = undefined

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns QueryState<TData, TError>

    -
    • -
-
-
- -

invalidateQueries

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
  • - -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

isFetching

-
    -
  • isFetching(filters?: QueryFilters): number
    • -
  • isFetching(queryKey?: QueryKey, filters?: QueryFilters): number
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns number

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns number

    -
    • -
-
-
- -

isMutating

-
    -
  • isMutating(filters?: MutationFilters): number
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: MutationFilters
      -
      • -
    -

    Returns number

    -
    • -
-
-
- -

mount

-
    -
  • mount(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

prefetchInfiniteQuery

-
    -
  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

prefetchQuery

-
    -
  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns Promise<void>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      queryFn: QueryFunction<TQueryFnData, TQueryKey>
      -
      • -
    • -
      Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

refetchQueries

-
    -
  • refetchQueries(filters?: QueryFilters, options?: RefetchOptions): Promise<void>
    • -
  • refetchQueries(queryKey?: QueryKey, filters?: QueryFilters, options?: RefetchOptions): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: RefetchOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: RefetchOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

removeQueries

-
    -
  • removeQueries(filters?: QueryFilters): void
    • -
  • removeQueries(queryKey?: QueryKey, filters?: QueryFilters): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns void

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

resetQueries

-
    -
  • resetQueries(filters?: QueryFilters, options?: ResetOptions): Promise<void>
    • -
  • resetQueries(queryKey?: QueryKey, filters?: QueryFilters, options?: ResetOptions): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: ResetOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    • -
      Optional options: ResetOptions
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

resumePausedMutations

-
    -
  • resumePausedMutations(): Promise<void>
    • -
-
    -
  • - -

    Returns Promise<void>

    -
    • -
-
-
- -

setDefaultOptions

- -
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

setMutationDefaults

- -
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

setQueryData

-
    -
  • setQueryData<TData>(queryKey: QueryKey, updater: Updater<TData, TData>, options?: SetDataOptions): TData
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TData

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: QueryKey
      -
      • -
    • -
      updater: Updater<TData, TData>
      -
      • -
    • -
      Optional options: SetDataOptions
      -
      • -
    -

    Returns TData

    -
    • -
-
-
- -

setQueryDefaults

- -
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

unmount

-
    -
  • unmount(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryClient | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryClient

Hierarchy

  • QueryClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns QueryClient

Properties

Private defaultOptions

defaultOptions: any

Private mutationCache

mutationCache: any

Private mutationDefaults

mutationDefaults: any

Private queryCache

queryCache: any

Private queryDefaults

queryDefaults: any

Private Optional unsubscribeFocus

unsubscribeFocus?: any

Private Optional unsubscribeOnline

unsubscribeOnline?: any

Methods

cancelMutations

  • cancelMutations(): Promise<void>

  • Returns Promise<void>

cancelQueries

  • cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>
  • cancelQueries(queryKey?: QueryKey, filters?: QueryFilters, options?: CancelOptions): Promise<void>

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

clear

  • clear(): void

  • Returns void

defaultMutationOptions

  • defaultMutationOptions<T>(options?: T): T

  • Type Parameters

    Parameters

    • Optional options: T

    Returns T

defaultQueryObserverOptions

  • defaultQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

  • Type Parameters

    • TQueryFnData

    • TError

    • TData

    • TQueryData

    • TQueryKey extends QueryKey

    Parameters

    Returns QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

defaultQueryOptions

  • defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

  • Type Parameters

    • TQueryFnData

    • TError

    • TData

    • TQueryData

    • TQueryKey extends QueryKey

    Parameters

    Returns QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

executeMutation

  • executeMutation<TData, TError, TVariables, TContext>(options: MutationOptions<TData, TError, TVariables, TContext>): Promise<TData>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns Promise<TData>

fetchInfiniteQuery

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

fetchQuery

  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>
  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>
  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>

    Returns Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<TData>

getDefaultOptions

  • Returns DefaultOptions<unknown>

getMutationCache

  • Returns MutationCache

getMutationDefaults

  • Parameters

    Returns MutationObserverOptions<any, any, any, any>

getQueriesData

  • getQueriesData<TData>(queryKey: QueryKey): [QueryKey, TData][]
  • getQueriesData<TData>(filters: QueryFilters): [QueryKey, TData][]

  • Type Parameters

    • TData = unknown

    Parameters

    Returns [QueryKey, TData][]

  • Type Parameters

    • TData = unknown

    Parameters

    • filters: QueryFilters

    Returns [QueryKey, TData][]

getQueryCache

  • Returns QueryCache

getQueryData

  • getQueryData<TData>(queryKey: QueryKey, filters?: QueryFilters): TData

  • Type Parameters

    • TData = unknown

    Parameters

    • queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns TData

getQueryDefaults

  • Parameters

    Returns QueryObserverOptions<any, any, any, any, any>

getQueryState

  • getQueryState<TData, TError>(queryKey: QueryKey, filters?: QueryFilters): QueryState<TData, TError>

  • Type Parameters

    • TData = unknown

    • TError = undefined

    Parameters

    • queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns QueryState<TData, TError>

invalidateQueries

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

isFetching

  • isFetching(filters?: QueryFilters): number
  • isFetching(queryKey?: QueryKey, filters?: QueryFilters): number

  • Parameters

    • Optional filters: QueryFilters

    Returns number

  • Parameters

    • Optional queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns number

isMutating

  • isMutating(filters?: MutationFilters): number

  • Parameters

    • Optional filters: MutationFilters

    Returns number

mount

  • mount(): void

  • Returns void

prefetchInfiniteQuery

  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

prefetchQuery

  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>
  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>

    Returns Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

refetchQueries

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

removeQueries

  • removeQueries(filters?: QueryFilters): void
  • removeQueries(queryKey?: QueryKey, filters?: QueryFilters): void

  • Parameters

    • Optional filters: QueryFilters

    Returns void

  • Parameters

    • Optional queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns void

resetQueries

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

resumePausedMutations

  • resumePausedMutations(): Promise<void>

  • Returns Promise<void>

setDefaultOptions

  • Parameters

    Returns void

setMutationDefaults

  • Parameters

    Returns void

setQueriesData

  • Type Parameters

    • TData

    Parameters

    Returns [QueryKey, TData][]

  • Type Parameters

    • TData

    Parameters

    • filters: QueryFilters
    • updater: Updater<TData, TData>
    • Optional options: SetDataOptions

    Returns [QueryKey, TData][]

setQueryData

  • Type Parameters

    • TData

    Parameters

    Returns TData

setQueryDefaults

  • Parameters

    Returns void

unmount

  • unmount(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/classes/browser.queryobserver.html b/packages/xarc-react-query/docs/classes/browser.queryobserver.html index 471bcffe3..902b83545 100644 --- a/packages/xarc-react-query/docs/classes/browser.queryobserver.html +++ b/packages/xarc-react-query/docs/classes/browser.queryobserver.html @@ -1,1096 +1 @@ - - - - - - QueryObserver | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

-
    -
  • - Subscribable<QueryObserverListener<TData, TError>> - -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

    -
    • -
-
-
-
-

Properties

-
- -

Private clearRefetchInterval

-
clearRefetchInterval: any
- -
-
- -

Private clearStaleTimeout

-
clearStaleTimeout: any
- -
-
- -

Private clearTimers

-
clearTimers: any
- -
-
- -

Private client

-
client: any
- -
-
- -

Private currentQuery

-
currentQuery: any
- -
-
- -

Private currentQueryInitialState

-
currentQueryInitialState: any
- -
-
- -

Private currentResult

-
currentResult: any
- -
-
- -

Private Optional currentResultOptions

-
currentResultOptions: any
- -
-
- -

Private Optional currentResultState

-
currentResultState: any
- -
-
- -

Private executeFetch

-
executeFetch: any
- -
-
- -

Protected listeners

-
listeners: QueryObserverListener<TData, TError>[]
- -
-
- -

Private notify

-
notify: any
- -
-
- -

options

-
options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
- -
-
- -

Private Optional previousQueryResult

-
previousQueryResult: any
- -
-
- -

Private previousSelectError

-
previousSelectError: any
- -
-
- -

Private Optional refetchIntervalId

-
refetchIntervalId: any
- -
-
- -

Private shouldNotifyListeners

-
shouldNotifyListeners: any
- -
-
- -

Private Optional staleTimeoutId

-
staleTimeoutId: any
- -
-
- -

Private trackedProps

-
trackedProps: any
- -
-
- -

Private updateQuery

-
updateQuery: any
- -
-
- -

Private updateRefetchInterval

-
updateRefetchInterval: any
- -
-
- -

Private updateStaleTimeout

-
updateStaleTimeout: any
- -
-
- -

Private updateTimers

-
updateTimers: any
- -
-
-
-

Methods

-
- -

Protected bindMethods

-
    -
  • bindMethods(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected createResult

- -
    -
  • - -

    Parameters

    -
      -
    • -
      query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
      -
      • -
    • -
      options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
      -
      • -
    -

    Returns QueryObserverResult<TData, TError>

    -
    • -
-
-
- -

destroy

-
    -
  • destroy(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected fetch

- -
    -
  • - -

    Parameters

    -
      -
    • -
      Optional fetchOptions: ObserverFetchOptions
      -
      • -
    -

    Returns Promise<QueryObserverResult<TData, TError>>

    -
    • -
-
-
- -

fetchOptimistic

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<QueryObserverResult<TData, TError>>

    -
    • -
-
-
- -

getCurrentQuery

-
    -
  • getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>
    • -
-
    -
  • - -

    Returns Query<TQueryFnData, TError, TQueryData, TQueryKey>

    -
    • -
-
-
- -

getCurrentResult

- -
    -
  • - -

    Returns QueryObserverResult<TData, TError>

    -
    • -
-
-
- -

getNextResult

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<QueryObserverResult<TData, TError>>

    -
    • -
-
-
- -

getOptimisticResult

- -
    -
  • - -

    Parameters

    - -

    Returns QueryObserverResult<TData, TError>

    -
    • -
-
-
- -

hasListeners

-
    -
  • hasListeners(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

onQueryUpdate

-
    -
  • onQueryUpdate(action: Action<TData, TError>): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      action: Action<TData, TError>
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

Protected onSubscribe

-
    -
  • onSubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

Protected onUnsubscribe

-
    -
  • onUnsubscribe(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

refetch

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<QueryObserverResult<TData, TError>>

    -
    • -
-
-
- -

remove

-
    -
  • remove(): void
    • -
-
    -
  • - -

    Returns void

    -
    • -
-
-
- -

setOptions

-
    -
  • setOptions(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
      -
      • -
    • -
      Optional notifyOptions: NotifyOptions
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

shouldFetchOnReconnect

-
    -
  • shouldFetchOnReconnect(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

shouldFetchOnWindowFocus

-
    -
  • shouldFetchOnWindowFocus(): boolean
    • -
-
    -
  • - -

    Returns boolean

    -
    • -
-
-
- -

subscribe

-
    -
  • subscribe(listener?: QueryObserverListener<TData, TError>): () => void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional listener: QueryObserverListener<TData, TError>
      -
      • -
    -

    Returns () => void

    -
      -
    • -
        -
      • (): void
        • -
      -
        -
      • -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
- -

trackResult

- -
    -
  • - -

    Parameters

    - -

    Returns QueryObserverResult<TData, TError>

    -
    • -
-
-
- -

updateResult

-
    -
  • updateResult(notifyOptions?: NotifyOptions): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional notifyOptions: NotifyOptions
      -
      • -
    -

    Returns void

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserver | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Properties

Private clearRefetchInterval

clearRefetchInterval: any

Private clearStaleTimeout

clearStaleTimeout: any

Private clearTimers

clearTimers: any

Private client

client: any

Private computeRefetchInterval

computeRefetchInterval: any

Private currentQuery

currentQuery: any

Private currentQueryInitialState

currentQueryInitialState: any

Private Optional currentRefetchInterval

currentRefetchInterval?: any

Private currentResult

currentResult: any

Private Optional currentResultOptions

currentResultOptions?: any

Private Optional currentResultState

currentResultState?: any

Private executeFetch

executeFetch: any

Protected listeners

listeners: QueryObserverListener<TData, TError>[]

Private notify

notify: any

options

options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Private Optional previousQueryResult

previousQueryResult?: any

Private Optional refetchIntervalId

refetchIntervalId?: any

Private selectError

selectError: any

Private Optional selectFn

selectFn?: any

Private Optional selectResult

selectResult?: any

Private shouldNotifyListeners

shouldNotifyListeners: any

Private Optional staleTimeoutId

staleTimeoutId?: any

Private trackedProps

trackedProps: any

Private updateQuery

updateQuery: any

Private updateRefetchInterval

updateRefetchInterval: any

Private updateStaleTimeout

updateStaleTimeout: any

Private updateTimers

updateTimers: any

Methods

Protected bindMethods

  • bindMethods(): void

  • Returns void

Protected createResult

  • Parameters

    • query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
    • options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

    Returns QueryObserverResult<TData, TError>

destroy

  • destroy(): void

  • Returns void

Protected fetch

  • Parameters

    • Optional fetchOptions: ObserverFetchOptions

    Returns Promise<QueryObserverResult<TData, TError>>

fetchOptimistic

  • Parameters

    Returns Promise<QueryObserverResult<TData, TError>>

getCurrentQuery

  • getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>

  • Returns Query<TQueryFnData, TError, TQueryData, TQueryKey>

getCurrentResult

  • Returns QueryObserverResult<TData, TError>

getNextResult

  • Parameters

    Returns Promise<QueryObserverResult<TData, TError>>

getOptimisticResult

  • Parameters

    Returns QueryObserverResult<TData, TError>

hasListeners

  • hasListeners(): boolean

  • Returns boolean

onQueryUpdate

  • onQueryUpdate(action: Action<TData, TError>): void

  • Parameters

    • action: Action<TData, TError>

    Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

refetch

  • Type Parameters

    • TPageData

    Parameters

    Returns Promise<QueryObserverResult<TData, TError>>

remove

  • remove(): void

  • Returns void

setOptions

  • setOptions(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void

  • Parameters

    • Optional options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    • Optional notifyOptions: NotifyOptions

    Returns void

shouldFetchOnReconnect

  • shouldFetchOnReconnect(): boolean

  • Returns boolean

shouldFetchOnWindowFocus

  • shouldFetchOnWindowFocus(): boolean

  • Returns boolean

subscribe

  • subscribe(listener?: QueryObserverListener<TData, TError>): (() => void)

  • Parameters

    • Optional listener: QueryObserverListener<TData, TError>

    Returns (() => void)

      • (): void

      • Returns void

trackResult

  • Parameters

    Returns QueryObserverResult<TData, TError>

updateResult

  • updateResult(notifyOptions?: NotifyOptions): void

  • Parameters

    • Optional notifyOptions: NotifyOptions

    Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/index.html b/packages/xarc-react-query/docs/index.html index c8c922276..3fb1a0736 100644 --- a/packages/xarc-react-query/docs/index.html +++ b/packages/xarc-react-query/docs/index.html @@ -1,112 +1,6 @@ - - - - - - @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
-

@xarc/react-query

-
-
-
-
-
-
-
- -

@xarc/react-query

- -

This module is part of the Electrode X React Web App platform for using [react-query] in version 2 of its SubApp design.

-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +@xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

@xarc/react-query

+ +

@xarc/react-query

+ +

This module is part of the Electrode X React Web App platform for using [react-query] in version 2 of its SubApp design.

+

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.CancelOptions.html b/packages/xarc-react-query/docs/interfaces/browser.CancelOptions.html new file mode 100644 index 000000000..7e57b0e7d --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.CancelOptions.html @@ -0,0 +1 @@ +CancelOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CancelOptions

Hierarchy

  • CancelOptions

Index

Properties

Properties

Optional revert

revert?: boolean

Optional silent

silent?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.DehydrateOptions.html b/packages/xarc-react-query/docs/interfaces/browser.DehydrateOptions.html new file mode 100644 index 000000000..b56d48fa7 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.DehydrateOptions.html @@ -0,0 +1 @@ +DehydrateOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DehydrateOptions

Hierarchy

  • DehydrateOptions

Index

Properties

Properties

Optional dehydrateMutations

dehydrateMutations?: boolean

Optional dehydrateQueries

dehydrateQueries?: boolean

Optional shouldDehydrateMutation

shouldDehydrateMutation?: ShouldDehydrateMutationFunction

Optional shouldDehydrateQuery

shouldDehydrateQuery?: ShouldDehydrateQueryFunction

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.DehydratedState.html b/packages/xarc-react-query/docs/interfaces/browser.DehydratedState.html new file mode 100644 index 000000000..7c900c704 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.DehydratedState.html @@ -0,0 +1 @@ +DehydratedState | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DehydratedState

Hierarchy

  • DehydratedState

Index

Properties

Properties

mutations

mutations: DehydratedMutation[]

queries

queries: DehydratedQuery[]

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.HydrateOptions.html b/packages/xarc-react-query/docs/interfaces/browser.HydrateOptions.html new file mode 100644 index 000000000..af81c207e --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.HydrateOptions.html @@ -0,0 +1 @@ +HydrateOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HydrateOptions

Hierarchy

  • HydrateOptions

Index

Properties

Properties

Optional defaultOptions

defaultOptions?: { mutations?: MutationOptions<unknown, unknown, void, unknown>; queries?: QueryOptions<unknown, unknown, unknown, QueryKey> }

Type declaration

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.HydrateProps.html b/packages/xarc-react-query/docs/interfaces/browser.HydrateProps.html new file mode 100644 index 000000000..0392c0b90 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.HydrateProps.html @@ -0,0 +1 @@ +HydrateProps | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HydrateProps

Hierarchy

  • HydrateProps

Index

Properties

Properties

Optional children

children?: ReactNode

Optional options

options?: HydrateOptions

Optional state

state?: unknown

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.MutationObserverBaseResult.html b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverBaseResult.html new file mode 100644 index 000000000..f4d1d7c7a --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverBaseResult.html @@ -0,0 +1 @@ +MutationObserverBaseResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverBaseResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

context

context: TContext

data

data: TData

error

error: TError

failureCount

failureCount: number

isError

isError: boolean

isIdle

isIdle: boolean

isLoading

isLoading: boolean

isPaused

isPaused: boolean

isSuccess

isSuccess: boolean

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

status

status: MutationStatus

variables

variables: TVariables

Methods

reset

  • reset(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.MutationObserverErrorResult.html b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverErrorResult.html new file mode 100644 index 000000000..11c6447f3 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverErrorResult.html @@ -0,0 +1 @@ +MutationObserverErrorResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverErrorResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

context

context: TContext

data

data: undefined

error

error: TError

failureCount

failureCount: number

isError

isError: true

isIdle

isIdle: false

isLoading

isLoading: false

isPaused

isPaused: boolean

isSuccess

isSuccess: false

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

status

status: "error"

variables

variables: TVariables

Methods

reset

  • reset(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.MutationObserverIdleResult.html b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverIdleResult.html new file mode 100644 index 000000000..e6d282a5a --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverIdleResult.html @@ -0,0 +1 @@ +MutationObserverIdleResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverIdleResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

context

context: TContext

data

data: undefined

error

error: null

failureCount

failureCount: number

isError

isError: false

isIdle

isIdle: true

isLoading

isLoading: false

isPaused

isPaused: boolean

isSuccess

isSuccess: false

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

status

status: "idle"

variables

variables: TVariables

Methods

reset

  • reset(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.MutationObserverLoadingResult.html b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverLoadingResult.html new file mode 100644 index 000000000..d592aa097 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverLoadingResult.html @@ -0,0 +1 @@ +MutationObserverLoadingResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverLoadingResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

context

context: TContext

data

data: undefined

error

error: null

failureCount

failureCount: number

isError

isError: false

isIdle

isIdle: false

isLoading

isLoading: true

isPaused

isPaused: boolean

isSuccess

isSuccess: false

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

status

status: "loading"

variables

variables: TVariables

Methods

reset

  • reset(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.MutationObserverSuccessResult.html b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverSuccessResult.html new file mode 100644 index 000000000..b7718b9b2 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.MutationObserverSuccessResult.html @@ -0,0 +1 @@ +MutationObserverSuccessResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverSuccessResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

context

context: TContext

data

data: TData

error

error: null

failureCount

failureCount: number

isError

isError: false

isIdle

isIdle: false

isLoading

isLoading: false

isPaused

isPaused: boolean

isSuccess

isSuccess: true

mutate

mutate: MutateFunction<TData, TError, TVariables, TContext>

status

status: "success"

variables

variables: TVariables

Methods

reset

  • reset(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.QueryClientConfig.html b/packages/xarc-react-query/docs/interfaces/browser.QueryClientConfig.html new file mode 100644 index 000000000..b1bce6328 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.QueryClientConfig.html @@ -0,0 +1 @@ +QueryClientConfig | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryClientConfig

Hierarchy

  • QueryClientConfig

Index

Properties

Properties

Optional defaultOptions

defaultOptions?: DefaultOptions<unknown>

Optional mutationCache

mutationCache?: MutationCache

Optional queryCache

queryCache?: QueryCache

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.RefetchPageFilters.html b/packages/xarc-react-query/docs/interfaces/browser.RefetchPageFilters.html new file mode 100644 index 000000000..745d18250 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.RefetchPageFilters.html @@ -0,0 +1 @@ +RefetchPageFilters | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefetchPageFilters<TPageData>

Type Parameters

  • TPageData = unknown

Hierarchy

Index

Methods

Methods

Optional refetchPage

  • refetchPage(lastPage: TPageData, index: number, allPages: TPageData[]): boolean

  • Parameters

    • lastPage: TPageData
    • index: number
    • allPages: TPageData[]

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.RefetchQueryFilters.html b/packages/xarc-react-query/docs/interfaces/browser.RefetchQueryFilters.html new file mode 100644 index 000000000..6e1799e69 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.RefetchQueryFilters.html @@ -0,0 +1,15 @@ +RefetchQueryFilters | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefetchQueryFilters<TPageData>

Type Parameters

  • TPageData = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional active

active?: boolean
+

Include or exclude active queries

+

Optional exact

exact?: boolean
+

Match query key exactly

+

Optional fetching

fetching?: boolean
+

Include or exclude fetching queries

+

Optional inactive

inactive?: boolean
+

Include or exclude inactive queries

+

Optional queryKey

queryKey?: QueryKey
+

Include queries matching this query key

+

Optional stale

stale?: boolean
+

Include or exclude stale queries

+

Methods

Optional predicate

  • predicate(query: Query<unknown, unknown, unknown, QueryKey>): boolean
  • +

    Include queries matching this predicate function

    +

    Parameters

    Returns boolean

Optional refetchPage

  • refetchPage(lastPage: TPageData, index: number, allPages: TPageData[]): boolean

  • Parameters

    • lastPage: TPageData
    • index: number
    • allPages: TPageData[]

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.ResetQueryFilters.html b/packages/xarc-react-query/docs/interfaces/browser.ResetQueryFilters.html new file mode 100644 index 000000000..56a034909 --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.ResetQueryFilters.html @@ -0,0 +1,15 @@ +ResetQueryFilters | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResetQueryFilters<TPageData>

Type Parameters

  • TPageData = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional active

active?: boolean
+

Include or exclude active queries

+

Optional exact

exact?: boolean
+

Match query key exactly

+

Optional fetching

fetching?: boolean
+

Include or exclude fetching queries

+

Optional inactive

inactive?: boolean
+

Include or exclude inactive queries

+

Optional queryKey

queryKey?: QueryKey
+

Include queries matching this query key

+

Optional stale

stale?: boolean
+

Include or exclude stale queries

+

Methods

Optional predicate

  • predicate(query: Query<unknown, unknown, unknown, QueryKey>): boolean
  • +

    Include queries matching this predicate function

    +

    Parameters

    Returns boolean

Optional refetchPage

  • refetchPage(lastPage: TPageData, index: number, allPages: TPageData[]): boolean

  • Parameters

    • lastPage: TPageData
    • index: number
    • allPages: TPageData[]

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.SetDataOptions.html b/packages/xarc-react-query/docs/interfaces/browser.SetDataOptions.html new file mode 100644 index 000000000..662b8744c --- /dev/null +++ b/packages/xarc-react-query/docs/interfaces/browser.SetDataOptions.html @@ -0,0 +1 @@ +SetDataOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SetDataOptions

Hierarchy

  • SetDataOptions

Index

Properties

Properties

Optional updatedAt

updatedAt?: number

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.defaultoptions.html b/packages/xarc-react-query/docs/interfaces/browser.defaultoptions.html index 1bb6f5ac6..c448dc913 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.defaultoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.defaultoptions.html @@ -1,185 +1 @@ - - - - - - DefaultOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface DefaultOptions<TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - DefaultOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional mutations

-
mutations: MutationObserverOptions<unknown, TError, unknown, unknown>
- -
-
- -

Optional queries

-
queries: QueryObserverOptions<unknown, TError, unknown, unknown, QueryKey>
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +DefaultOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DefaultOptions<TError>

Type Parameters

  • TError = unknown

Hierarchy

  • DefaultOptions

Index

Properties

Properties

Optional mutations

mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>

Optional queries

queries?: QueryObserverOptions<unknown, TError, unknown, unknown, QueryKey>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.fetchinfinitequeryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.fetchinfinitequeryoptions.html index a8d7eb450..61468c660 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.fetchinfinitequeryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.fetchinfinitequeryoptions.html @@ -1,467 +1,21 @@ - - - - - - FetchInfiniteQueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, InfiniteData<TData>, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: InfiniteData<TData> | InitialDataFunction<InfiniteData<TData>>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: InfiniteData<TData>, newData: InfiniteData<TData>) => boolean
- -
-

Type declaration

- -
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If the data is fresh it will be returned from the cache.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +FetchInfiniteQueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, InfiniteData<TData>, QueryKey>

Optional cacheTime

cacheTime?: number

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: InfiniteData<TData> | InitialDataFunction<InfiniteData<TData>>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If the data is fresh it will be returned from the cache.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.fetchnextpageoptions.html b/packages/xarc-react-query/docs/interfaces/browser.fetchnextpageoptions.html index 6885b7ff0..a0c9f52e7 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.fetchnextpageoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.fetchnextpageoptions.html @@ -1,183 +1 @@ - - - - - - FetchNextPageOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FetchNextPageOptions

-
-
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional pageParam

-
pageParam: unknown
- -
-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +FetchNextPageOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FetchNextPageOptions

Hierarchy

Index

Properties

Properties

Optional cancelRefetch

cancelRefetch?: boolean

Optional pageParam

pageParam?: unknown

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.fetchpreviouspageoptions.html b/packages/xarc-react-query/docs/interfaces/browser.fetchpreviouspageoptions.html index e63c39244..a3e13c0b6 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.fetchpreviouspageoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.fetchpreviouspageoptions.html @@ -1,183 +1 @@ - - - - - - FetchPreviousPageOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FetchPreviousPageOptions

-
-
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional pageParam

-
pageParam: unknown
- -
-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +FetchPreviousPageOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FetchPreviousPageOptions

Hierarchy

Index

Properties

Properties

Optional cancelRefetch

cancelRefetch?: boolean

Optional pageParam

pageParam?: unknown

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.fetchqueryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.fetchqueryoptions.html index 98e2a1895..5177aa83a 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.fetchqueryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.fetchqueryoptions.html @@ -1,471 +1,21 @@ - - - - - - FetchQueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, TData, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: TData | InitialDataFunction<TData>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: TData, newData: TData) => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (oldData: TData, newData: TData): boolean
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        oldData: TData
        -
        • -
      • -
        newData: TData
        -
        • -
      -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If the data is fresh it will be returned from the cache.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +FetchQueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: TData | InitialDataFunction<TData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If the data is fresh it will be returned from the cache.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitedata.html b/packages/xarc-react-query/docs/interfaces/browser.infinitedata.html index c861cdfb5..cd5bd369b 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitedata.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitedata.html @@ -1,185 +1 @@ - - - - - - InfiniteData | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteData<TData>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData

    -
    • -
-
-
-

Hierarchy

-
    -
  • - InfiniteData -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

pageParams

-
pageParams: unknown[]
- -
-
- -

pages

-
pages: TData[]
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteData | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteData<TData>

Type Parameters

  • TData

Hierarchy

  • InfiniteData

Index

Properties

Properties

pageParams

pageParams: unknown[]

pages

pages: TData[]

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverbaseresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverbaseresult.html index a01bf6bc2..e5e794639 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverbaseresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverbaseresult.html @@ -1,644 +1 @@ - - - - - - InfiniteQueryObserverBaseResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverBaseResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: InfiniteData<TData>
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: boolean
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: boolean
- -
-
- -

isLoading

-
isLoading: boolean
- -
-
- -

isLoadingError

-
isLoadingError: boolean
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: boolean
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: boolean
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: QueryStatus
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverBaseResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverBaseResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: InfiniteData<TData>

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: boolean

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: boolean

isLoading

isLoading: boolean

isLoadingError

isLoadingError: boolean

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: boolean

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: boolean

status

status: QueryStatus

Methods

fetchNextPage

  • Parameters

    Returns Promise<InfiniteQueryObserverResult<TData, TError>>

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveridleresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveridleresult.html index c6a20aaab..061b9236e 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveridleresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveridleresult.html @@ -1,633 +1 @@ - - - - - - InfiniteQueryObserverIdleResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverIdleResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: true
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "idle"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverIdleResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverIdleResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: true

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "idle"

Methods

fetchNextPage

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingerrorresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingerrorresult.html index 1531fe703..9958e752c 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingerrorresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingerrorresult.html @@ -1,633 +1 @@ - - - - - - InfiniteQueryObserverLoadingErrorResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverLoadingErrorResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: true
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: true
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "error"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverLoadingErrorResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverLoadingErrorResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: true

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: true

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "error"

Methods

fetchNextPage

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingresult.html index dcab71d28..990cc1130 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverloadingresult.html @@ -1,633 +1 @@ - - - - - - InfiniteQueryObserverLoadingResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverLoadingResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: true
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "loading"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverLoadingResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverLoadingResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: false

isLoading

isLoading: true

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "loading"

Methods

fetchNextPage

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveroptions.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveroptions.html index f54aeeba1..61ab208c9 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveroptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserveroptions.html @@ -1,944 +1,86 @@ - - - - - - InfiniteQueryObserverOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, InfiniteData<TQueryData>, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional enabled

-
enabled: boolean
- -
-
-

Set this to false to disable automatic refetching when the query mounts or changes query keys. - To refetch the query, use the refetch method returned from the useQuery instance. - Defaults to true.

-
-
-
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: InfiniteData<TQueryData> | InitialDataFunction<InfiniteData<TQueryData>>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: InfiniteData<TQueryData>, newData: InfiniteData<TQueryData>) => boolean
- -
-

Type declaration

- -
-
-
- -

Optional keepPreviousData

-
keepPreviousData: boolean
- -
-
-

Set this to true to keep the previous data when fetching based on a new query key. - Defaults to false.

-
-
-
-
- -

Optional notifyOnChangeProps

-
notifyOnChangeProps: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[] | "tracked"
- -
-
-

If set, the component will only re-render if any of the listed properties change. - When set to ['data', 'error'], the component will only re-render when the data or error properties change. - When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

-
-
-
-
- -

Optional notifyOnChangePropsExclusions

-
notifyOnChangePropsExclusions: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[]
- -
-
-

If set, the component will not re-render if any of the listed properties change.

-
-
-
-
- -

Optional onError

-
onError: (err: TError) => void
- -
-
-

This callback will fire if the query encounters an error and will be passed the error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (err: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        err: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: InfiniteData<TData>, error: TError) => void
- -
-
-

This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

-
-
-
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      - -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: InfiniteData<TData>) => void
- -
-
-

This callback will fire any time the query successfully fetches new data.

-
-
-
-

Type declaration

- -
-
-
- -

Optional optimisticResults

-
optimisticResults: boolean
- -
-
-

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. - This is to make sure the results are not lagging behind. - Defaults to true.

-
-
-
-
- -

Optional placeholderData

-
placeholderData: InfiniteData<TData> | PlaceholderDataFunction<InfiniteData<TData>>
- -
-
-

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

-
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional refetchInterval

-
refetchInterval: number | false
- -
-
-

If set to a number, the query will continuously refetch at this frequency in milliseconds. - Defaults to false.

-
-
-
-
- -

Optional refetchIntervalInBackground

-
refetchIntervalInBackground: boolean
- -
-
-

If set to true, the query will continue to refetch while their tab/window is in the background. - Defaults to false.

-
-
-
-
- -

Optional refetchOnMount

-
refetchOnMount: boolean | "always"
- -
-
-

If set to true, the query will refetch on mount if the data is stale. - If set to false, will disable additional instances of a query to trigger background refetches. - If set to 'always', the query will always refetch on mount. - Defaults to true.

-
-
-
-
- -

Optional refetchOnReconnect

-
refetchOnReconnect: boolean | "always"
- -
-
-

If set to true, the query will refetch on reconnect if the data is stale. - If set to false, the query will not refetch on reconnect. - If set to 'always', the query will always refetch on reconnect. - Defaults to true.

-
-
-
-
- -

Optional refetchOnWindowFocus

-
refetchOnWindowFocus: boolean | "always"
- -
-
-

If set to true, the query will refetch on window focus if the data is stale. - If set to false, the query will not refetch on window focus. - If set to 'always', the query will always refetch on window focus. - Defaults to true.

-
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional retryOnMount

-
retryOnMount: boolean
- -
-
-

If set to false, the query will not be retried on mount if it contains an error. - Defaults to true.

-
-
-
-
- -

Optional select

-
select: (data: InfiniteData<TQueryData>) => InfiniteData<TData>
- -
-
-

This option can be used to transform or select a part of the data returned by the query function.

-
-
-
-

Type declaration

- -
-
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If set to Infinity, the data will never be considered stale.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
- -

Optional suspense

-
suspense: boolean
- -
-
-

If set to true, the query will suspend when status === 'loading' - and throw errors when status === 'error'. - Defaults to false.

-
-
-
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-

Whether errors should be thrown instead of setting the error property. - Defaults to false.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, InfiniteData<TQueryData>, QueryKey>

Optional cacheTime

cacheTime?: number

Optional enabled

enabled?: boolean
+

Set this to false to disable automatic refetching when the query mounts or changes query keys. +To refetch the query, use the refetch method returned from the useQuery instance. +Defaults to true.

+

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: InfiniteData<TQueryData> | InitialDataFunction<InfiniteData<TQueryData>>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional keepPreviousData

keepPreviousData?: boolean
+

Set this to true to keep the previous data when fetching based on a new query key. +Defaults to false.

+

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional notifyOnChangeProps

notifyOnChangeProps?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[] | "tracked"
+

If set, the component will only re-render if any of the listed properties change. +When set to ['data', 'error'], the component will only re-render when the data or error properties change. +When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

+

Optional notifyOnChangePropsExclusions

notifyOnChangePropsExclusions?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[]
+

If set, the component will not re-render if any of the listed properties change.

+

Optional optimisticResults

optimisticResults?: boolean
+

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. +This is to make sure the results are not lagging behind. +Defaults to true.

+

Optional placeholderData

placeholderData?: InfiniteData<TQueryData> | PlaceholderDataFunction<InfiniteData<TQueryData>>
+

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional refetchInterval

refetchInterval?: number | false | ((data: InfiniteData<TData>, query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => number | false)
+

If set to a number, the query will continuously refetch at this frequency in milliseconds. +If set to a function, the function will be executed with the latest data and query to compute a frequency +Defaults to false.

+

Optional refetchIntervalInBackground

refetchIntervalInBackground?: boolean
+

If set to true, the query will continue to refetch while their tab/window is in the background. +Defaults to false.

+

Optional refetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on mount if the data is stale. +If set to false, will disable additional instances of a query to trigger background refetches. +If set to 'always', the query will always refetch on mount. +If set to a function, the function will be executed with the latest data and query to compute the value +Defaults to true.

+

Optional refetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on reconnect if the data is stale. +If set to false, the query will not refetch on reconnect. +If set to 'always', the query will always refetch on reconnect. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional refetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on window focus if the data is stale. +If set to false, the query will not refetch on window focus. +If set to 'always', the query will always refetch on window focus. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional retryOnMount

retryOnMount?: boolean
+

If set to false, the query will not be retried on mount if it contains an error. +Defaults to true.

+

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If set to Infinity, the data will never be considered stale.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Optional suspense

suspense?: boolean
+

If set to true, the query will suspend when status === 'loading' +and throw errors when status === 'error'. +Defaults to false.

+

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError, query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean)
+

Whether errors should be thrown instead of setting the error property. +If set to true or suspense is true, all errors will be thrown to the error boundary. +If set to false and suspense is false, errors are returned as state. +If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). +Defaults to false.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Optional onError

  • onError(err: TError): void
  • +

    This callback will fire if the query encounters an error and will be passed the error.

    +

    Parameters

    • err: TError

    Returns void

Optional onSettled

  • onSettled(data: TData, error: TError): void
  • +

    This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

    +

    Parameters

    • data: TData
    • error: TError

    Returns void

Optional onSuccess

  • onSuccess(data: TData): void
  • +

    This callback will fire any time the query successfully fetches new data or the cache is updated via setQueryData.

    +

    Parameters

    • data: TData

    Returns void

Optional select

  • select(data: TQueryData): TData
  • +

    This option can be used to transform or select a part of the data returned by the query function.

    +

    Parameters

    • data: TQueryData

    Returns TData

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverrefetcherrorresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverrefetcherrorresult.html index dd947b9a3..35468e005 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverrefetcherrorresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserverrefetcherrorresult.html @@ -1,633 +1 @@ - - - - - - InfiniteQueryObserverRefetchErrorResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverRefetchErrorResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: InfiniteData<TData>
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: true
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: true
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "error"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverRefetchErrorResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverRefetchErrorResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: InfiniteData<TData>

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: true

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: true

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "error"

Methods

fetchNextPage

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserversuccessresult.html b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserversuccessresult.html index e8c80412f..21aa3761f 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserversuccessresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.infinitequeryobserversuccessresult.html @@ -1,633 +1 @@ - - - - - - InfiniteQueryObserverSuccessResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InfiniteQueryObserverSuccessResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: InfiniteData<TData>
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

fetchNextPage

-
fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

fetchPreviousPage

-
fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

Optional hasNextPage

-
hasNextPage: boolean
- -
-
- -

Optional hasPreviousPage

-
hasPreviousPage: boolean
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isFetchingNextPage

-
isFetchingNextPage: boolean
- -
-
- -

isFetchingPreviousPage

-
isFetchingPreviousPage: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: true
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "success"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InfiniteQueryObserverSuccessResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfiniteQueryObserverSuccessResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: InfiniteData<TData>

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: true

status

status: "success"

Methods

fetchNextPage

fetchPreviousPage

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.invalidateoptions.html b/packages/xarc-react-query/docs/interfaces/browser.invalidateoptions.html index 7665901d8..2270e99f0 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.invalidateoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.invalidateoptions.html @@ -1,163 +1 @@ - - - - - - InvalidateOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InvalidateOptions

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - InvalidateOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InvalidateOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InvalidateOptions

Hierarchy

Index

Properties

Properties

Optional cancelRefetch

cancelRefetch?: boolean

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.invalidatequeryfilters.html b/packages/xarc-react-query/docs/interfaces/browser.invalidatequeryfilters.html index ffc39733b..5d0505a27 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.invalidatequeryfilters.html +++ b/packages/xarc-react-query/docs/interfaces/browser.invalidatequeryfilters.html @@ -1,343 +1,15 @@ - - - - - - InvalidateQueryFilters | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface InvalidateQueryFilters

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - QueryFilters -
      -
    • - InvalidateQueryFilters -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional active

-
active: boolean
- -
-
-

Include or exclude active queries

-
-
-
-
- -

Optional exact

-
exact: boolean
- -
-
-

Match query key exactly

-
-
-
-
- -

Optional fetching

-
fetching: boolean
- -
-
-

Include or exclude fetching queries

-
-
-
-
- -

Optional inactive

-
inactive: boolean
- -
-
-

Include or exclude inactive queries

-
-
-
-
- -

Optional predicate

-
predicate: (query: Query<unknown, unknown, unknown, QueryKey>) => boolean
- -
-
-

Include queries matching this predicate function

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (query: Query<unknown, unknown, unknown, QueryKey>): boolean
      • -
    -
      -
    • -

      Parameters

      - -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional queryKey

-
queryKey: QueryKey
- -
-
-

Include queries matching this query key

-
-
-
-
- -

Optional refetchActive

-
refetchActive: boolean
- -
-
- -

Optional refetchInactive

-
refetchInactive: boolean
- -
-
- -

Optional stale

-
stale: boolean
- -
-
-

Include or exclude stale queries

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +InvalidateQueryFilters | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InvalidateQueryFilters<TPageData>

Type Parameters

  • TPageData = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional active

active?: boolean
+

Include or exclude active queries

+

Optional exact

exact?: boolean
+

Match query key exactly

+

Optional fetching

fetching?: boolean
+

Include or exclude fetching queries

+

Optional inactive

inactive?: boolean
+

Include or exclude inactive queries

+

Optional queryKey

queryKey?: QueryKey
+

Include queries matching this query key

+

Optional refetchActive

refetchActive?: boolean

Optional refetchInactive

refetchInactive?: boolean

Optional stale

stale?: boolean
+

Include or exclude stale queries

+

Methods

Optional predicate

  • predicate(query: Query<unknown, unknown, unknown, QueryKey>): boolean
  • +

    Include queries matching this predicate function

    +

    Parameters

    Returns boolean

Optional refetchPage

  • refetchPage(lastPage: TPageData, index: number, allPages: TPageData[]): boolean

  • Parameters

    • lastPage: TPageData
    • index: number
    • allPages: TPageData[]

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.logger.html b/packages/xarc-react-query/docs/interfaces/browser.logger.html index 77ba94bab..c6bb4b871 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.logger.html +++ b/packages/xarc-react-query/docs/interfaces/browser.logger.html @@ -1,191 +1 @@ - - - - - - Logger | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Logger

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Logger -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

error

-
error: LogFunction
- -
-
- -

log

-
log: LogFunction
- -
-
- -

warn

-
warn: LogFunction
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +Logger | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Logger

Hierarchy

  • Logger

Index

Properties

Properties

error

error: LogFunction

log

log: LogFunction

warn

warn: LogFunction

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.mutateoptions.html b/packages/xarc-react-query/docs/interfaces/browser.mutateoptions.html index 69d03f063..46d073c91 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.mutateoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.mutateoptions.html @@ -1,292 +1 @@ - - - - - - MutateOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface MutateOptions<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - MutateOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional onError

-
onError: (error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutateOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutateOptions<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

  • MutateOptions

Index

Methods

Methods

Optional onError

  • onError(error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onSettled

  • onSettled(data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onSuccess

  • onSuccess(data: TData, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.mutationobserveroptions.html b/packages/xarc-react-query/docs/interfaces/browser.mutationobserveroptions.html index 4a637dd03..a2beb2984 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.mutationobserveroptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.mutationobserveroptions.html @@ -1,440 +1 @@ - - - - - - MutationObserverOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface MutationObserverOptions<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - MutationOptions<TData, TError, TVariables, TContext> -
      -
    • - MutationObserverOptions -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional mutationFn

-
mutationFn: MutationFunction<TData, TVariables>
- -
-
- -

Optional mutationKey

-
mutationKey: MutationKey
- -
-
- -

Optional onError

-
onError: (error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onMutate

-
onMutate: (variables: TVariables) => TContext | Promise<undefined> | Promise<TContext>
- -
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables): TContext | Promise<undefined> | Promise<TContext>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      -

      Returns TContext | Promise<undefined> | Promise<TContext>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
- -

Optional variables

-
variables: TVariables
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutationObserverOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationObserverOptions<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

  • MutationOptions<TData, TError, TVariables, TContext>
    • MutationObserverOptions

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional meta

meta?: MutationMeta

Optional mutationFn

mutationFn?: MutationFunction<TData, TVariables>

Optional mutationKey

mutationKey?: MutationKey

Optional retry

retry?: RetryValue<TError>

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError) => boolean)

Optional variables

variables?: TVariables

Methods

Optional onError

  • onError(error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onMutate

  • onMutate(variables: TVariables): TContext | Promise<TContext>

  • Parameters

    • variables: TVariables

    Returns TContext | Promise<TContext>

Optional onSettled

  • onSettled(data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onSuccess

  • onSuccess(data: TData, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.mutationobserverresult.html b/packages/xarc-react-query/docs/interfaces/browser.mutationobserverresult.html deleted file mode 100644 index 98095a6ad..000000000 --- a/packages/xarc-react-query/docs/interfaces/browser.mutationobserverresult.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - MutationObserverResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface MutationObserverResult<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - MutationState<TData, TError, TVariables, TContext> -
      -
    • - MutationObserverResult -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

context

-
context: TContext
- -
-
- -

data

-
data: TData
- -
-
- -

error

-
error: TError
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: boolean
- -
-
- -

isIdle

-
isIdle: boolean
- -
-
- -

isLoading

-
isLoading: boolean
- -
-
- -

isPaused

-
isPaused: boolean
- -
-
- -

isSuccess

-
isSuccess: boolean
- -
-
- -

mutate

-
mutate: MutateFunction<TData, TError, TVariables, TContext>
- -
-
- -

reset

-
reset: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: MutationStatus
- -
-
- -

variables

-
variables: TVariables
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.mutationoptions.html b/packages/xarc-react-query/docs/interfaces/browser.mutationoptions.html index 0b2cb4da8..cf4e12db9 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.mutationoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.mutationoptions.html @@ -1,416 +1 @@ - - - - - - MutationOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface MutationOptions<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional mutationFn

-
mutationFn: MutationFunction<TData, TVariables>
- -
-
- -

Optional mutationKey

-
mutationKey: MutationKey
- -
-
- -

Optional onError

-
onError: (error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onMutate

-
onMutate: (variables: TVariables) => TContext | Promise<TContext> | Promise<undefined>
- -
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables): TContext | Promise<TContext> | Promise<undefined>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      -

      Returns TContext | Promise<TContext> | Promise<undefined>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional variables

-
variables: TVariables
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutationOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutationOptions<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional meta

meta?: MutationMeta

Optional mutationFn

mutationFn?: MutationFunction<TData, TVariables>

Optional mutationKey

mutationKey?: MutationKey

Optional retry

retry?: RetryValue<TError>

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional variables

variables?: TVariables

Methods

Optional onError

  • onError(error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onMutate

  • onMutate(variables: TVariables): TContext | Promise<TContext>

  • Parameters

    • variables: TVariables

    Returns TContext | Promise<TContext>

Optional onSettled

  • onSettled(data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onSuccess

  • onSuccess(data: TData, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryclientproviderprops.html b/packages/xarc-react-query/docs/interfaces/browser.queryclientproviderprops.html index faa781aa0..cf8990c9c 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryclientproviderprops.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryclientproviderprops.html @@ -1,177 +1 @@ - - - - - - QueryClientProviderProps | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryClientProviderProps

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - QueryClientProviderProps -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

client

-
client: QueryClient
- -
-
- -

Optional contextSharing

-
contextSharing: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryClientProviderProps | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryClientProviderProps

Hierarchy

  • QueryClientProviderProps

Index

Properties

Properties

Optional children

children?: ReactNode

client

client: QueryClient

Optional contextSharing

contextSharing?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryerrorresetboundaryprops.html b/packages/xarc-react-query/docs/interfaces/browser.queryerrorresetboundaryprops.html index 066e1e876..c80ed2fb8 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryerrorresetboundaryprops.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryerrorresetboundaryprops.html @@ -1,163 +1 @@ - - - - - - QueryErrorResetBoundaryProps | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryErrorResetBoundaryProps

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - QueryErrorResetBoundaryProps -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

children

-
children: ((value: QueryErrorResetBoundaryValue) => ReactNode) | ReactNode
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryErrorResetBoundaryProps | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryErrorResetBoundaryProps

Hierarchy

  • QueryErrorResetBoundaryProps

Index

Properties

Properties

children

children: ReactNode | ((value: QueryErrorResetBoundaryValue) => ReactNode)

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryfunctioncontext.html b/packages/xarc-react-query/docs/interfaces/browser.queryfunctioncontext.html index e8b6892c6..8fa06fdba 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryfunctioncontext.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryfunctioncontext.html @@ -1,188 +1 @@ - - - - - - QueryFunctionContext | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryFunctionContext<TQueryKey, TPageParam>

-
-
-
-
-
-
-
-

Type parameters

- -
-
-

Hierarchy

-
    -
  • - QueryFunctionContext -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional pageParam

-
pageParam: TPageParam
- -
-
- -

queryKey

-
queryKey: TQueryKey
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryFunctionContext | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryFunctionContext<TQueryKey, TPageParam>

Type Parameters

Hierarchy

  • QueryFunctionContext

Index

Properties

Properties

meta

meta: QueryMeta

Optional pageParam

pageParam?: TPageParam

queryKey

queryKey: EnsuredQueryKey<TQueryKey>

Optional signal

signal?: AbortSignal

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserverbaseresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserverbaseresult.html index 74ce3a6ee..2f08de755 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserverbaseresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserverbaseresult.html @@ -1,496 +1 @@ - - - - - - QueryObserverBaseResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverBaseResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: TData
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: boolean
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: boolean
- -
-
- -

isLoading

-
isLoading: boolean
- -
-
- -

isLoadingError

-
isLoadingError: boolean
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: boolean
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: boolean
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: QueryStatus
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverBaseResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverBaseResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: TData

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: boolean

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: boolean

isLoading

isLoading: boolean

isLoadingError

isLoadingError: boolean

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: boolean

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: boolean

status

status: QueryStatus

Methods

refetch

  • Type Parameters

    • TPageData

    Parameters

    Returns Promise<QueryObserverResult<TData, TError>>

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserveridleresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserveridleresult.html index 923ad92b1..991da1da8 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserveridleresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserveridleresult.html @@ -1,501 +1 @@ - - - - - - QueryObserverIdleResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverIdleResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: true
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "idle"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverIdleResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverIdleResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: true

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "idle"

Methods

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingerrorresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingerrorresult.html index 9f3ad3ebc..e873983d9 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingerrorresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingerrorresult.html @@ -1,501 +1 @@ - - - - - - QueryObserverLoadingErrorResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverLoadingErrorResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: true
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: true
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "error"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverLoadingErrorResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverLoadingErrorResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: true

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: true

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "error"

Methods

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingresult.html index 99631067e..ffa5b7683 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserverloadingresult.html @@ -1,501 +1 @@ - - - - - - QueryObserverLoadingResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverLoadingResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: undefined
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: true
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "loading"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverLoadingResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverLoadingResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: undefined

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: false

isLoading

isLoading: true

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "loading"

Methods

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserveroptions.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserveroptions.html index cdbed2ec0..fa176d296 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserveroptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserveroptions.html @@ -1,928 +1,86 @@ - - - - - - QueryObserverOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, TQueryData, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional enabled

-
enabled: boolean
- -
-
-

Set this to false to disable automatic refetching when the query mounts or changes query keys. - To refetch the query, use the refetch method returned from the useQuery instance. - Defaults to true.

-
-
-
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: TQueryData | InitialDataFunction<TQueryData>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: TQueryData, newData: TQueryData) => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (oldData: TQueryData, newData: TQueryData): boolean
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        oldData: TQueryData
        -
        • -
      • -
        newData: TQueryData
        -
        • -
      -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional keepPreviousData

-
keepPreviousData: boolean
- -
-
-

Set this to true to keep the previous data when fetching based on a new query key. - Defaults to false.

-
-
-
-
- -

Optional notifyOnChangeProps

-
notifyOnChangeProps: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[] | "tracked"
- -
-
-

If set, the component will only re-render if any of the listed properties change. - When set to ['data', 'error'], the component will only re-render when the data or error properties change. - When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

-
-
-
-
- -

Optional notifyOnChangePropsExclusions

-
notifyOnChangePropsExclusions: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[]
- -
-
-

If set, the component will not re-render if any of the listed properties change.

-
-
-
-
- -

Optional onError

-
onError: (err: TError) => void
- -
-
-

This callback will fire if the query encounters an error and will be passed the error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (err: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        err: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError) => void
- -
-
-

This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData) => void
- -
-
-

This callback will fire any time the query successfully fetches new data.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional optimisticResults

-
optimisticResults: boolean
- -
-
-

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. - This is to make sure the results are not lagging behind. - Defaults to true.

-
-
-
-
- -

Optional placeholderData

-
placeholderData: TData | PlaceholderDataFunction<TData>
- -
-
-

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

-
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional refetchInterval

-
refetchInterval: number | false
- -
-
-

If set to a number, the query will continuously refetch at this frequency in milliseconds. - Defaults to false.

-
-
-
-
- -

Optional refetchIntervalInBackground

-
refetchIntervalInBackground: boolean
- -
-
-

If set to true, the query will continue to refetch while their tab/window is in the background. - Defaults to false.

-
-
-
-
- -

Optional refetchOnMount

-
refetchOnMount: boolean | "always"
- -
-
-

If set to true, the query will refetch on mount if the data is stale. - If set to false, will disable additional instances of a query to trigger background refetches. - If set to 'always', the query will always refetch on mount. - Defaults to true.

-
-
-
-
- -

Optional refetchOnReconnect

-
refetchOnReconnect: boolean | "always"
- -
-
-

If set to true, the query will refetch on reconnect if the data is stale. - If set to false, the query will not refetch on reconnect. - If set to 'always', the query will always refetch on reconnect. - Defaults to true.

-
-
-
-
- -

Optional refetchOnWindowFocus

-
refetchOnWindowFocus: boolean | "always"
- -
-
-

If set to true, the query will refetch on window focus if the data is stale. - If set to false, the query will not refetch on window focus. - If set to 'always', the query will always refetch on window focus. - Defaults to true.

-
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional retryOnMount

-
retryOnMount: boolean
- -
-
-

If set to false, the query will not be retried on mount if it contains an error. - Defaults to true.

-
-
-
-
- -

Optional select

-
select: (data: TQueryData) => TData
- -
-
-

This option can be used to transform or select a part of the data returned by the query function.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TQueryData): TData
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TQueryData
        -
        • -
      -

      Returns TData

      -
      • -
    -
    • -
-
-
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If set to Infinity, the data will never be considered stale.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
- -

Optional suspense

-
suspense: boolean
- -
-
-

If set to true, the query will suspend when status === 'loading' - and throw errors when status === 'error'. - Defaults to false.

-
-
-
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-

Whether errors should be thrown instead of setting the error property. - Defaults to false.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TQueryData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional enabled

enabled?: boolean
+

Set this to false to disable automatic refetching when the query mounts or changes query keys. +To refetch the query, use the refetch method returned from the useQuery instance. +Defaults to true.

+

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: TQueryData | InitialDataFunction<TQueryData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional keepPreviousData

keepPreviousData?: boolean
+

Set this to true to keep the previous data when fetching based on a new query key. +Defaults to false.

+

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional notifyOnChangeProps

notifyOnChangeProps?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[] | "tracked"
+

If set, the component will only re-render if any of the listed properties change. +When set to ['data', 'error'], the component will only re-render when the data or error properties change. +When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

+

Optional notifyOnChangePropsExclusions

notifyOnChangePropsExclusions?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[]
+

If set, the component will not re-render if any of the listed properties change.

+

Optional optimisticResults

optimisticResults?: boolean
+

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. +This is to make sure the results are not lagging behind. +Defaults to true.

+

Optional placeholderData

placeholderData?: TQueryData | PlaceholderDataFunction<TQueryData>
+

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional refetchInterval

refetchInterval?: number | false | ((data: TData, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false)
+

If set to a number, the query will continuously refetch at this frequency in milliseconds. +If set to a function, the function will be executed with the latest data and query to compute a frequency +Defaults to false.

+

Optional refetchIntervalInBackground

refetchIntervalInBackground?: boolean
+

If set to true, the query will continue to refetch while their tab/window is in the background. +Defaults to false.

+

Optional refetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on mount if the data is stale. +If set to false, will disable additional instances of a query to trigger background refetches. +If set to 'always', the query will always refetch on mount. +If set to a function, the function will be executed with the latest data and query to compute the value +Defaults to true.

+

Optional refetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on reconnect if the data is stale. +If set to false, the query will not refetch on reconnect. +If set to 'always', the query will always refetch on reconnect. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional refetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on window focus if the data is stale. +If set to false, the query will not refetch on window focus. +If set to 'always', the query will always refetch on window focus. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional retryOnMount

retryOnMount?: boolean
+

If set to false, the query will not be retried on mount if it contains an error. +Defaults to true.

+

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If set to Infinity, the data will never be considered stale.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Optional suspense

suspense?: boolean
+

If set to true, the query will suspend when status === 'loading' +and throw errors when status === 'error'. +Defaults to false.

+

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean)
+

Whether errors should be thrown instead of setting the error property. +If set to true or suspense is true, all errors will be thrown to the error boundary. +If set to false and suspense is false, errors are returned as state. +If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). +Defaults to false.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Optional onError

  • onError(err: TError): void
  • +

    This callback will fire if the query encounters an error and will be passed the error.

    +

    Parameters

    • err: TError

    Returns void

Optional onSettled

  • onSettled(data: TData, error: TError): void
  • +

    This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

    +

    Parameters

    • data: TData
    • error: TError

    Returns void

Optional onSuccess

  • onSuccess(data: TData): void
  • +

    This callback will fire any time the query successfully fetches new data or the cache is updated via setQueryData.

    +

    Parameters

    • data: TData

    Returns void

Optional select

  • select(data: TQueryData): TData
  • +

    This option can be used to transform or select a part of the data returned by the query function.

    +

    Parameters

    • data: TQueryData

    Returns TData

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserverrefetcherrorresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserverrefetcherrorresult.html index 7f9ca0cfc..3245e7005 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserverrefetcherrorresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserverrefetcherrorresult.html @@ -1,501 +1 @@ - - - - - - QueryObserverRefetchErrorResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverRefetchErrorResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: TData
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: TError
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: true
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: true
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: false
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "error"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverRefetchErrorResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverRefetchErrorResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: TData

dataUpdatedAt

dataUpdatedAt: number

error

error: TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: true

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: true

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: false

status

status: "error"

Methods

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryobserversuccessresult.html b/packages/xarc-react-query/docs/interfaces/browser.queryobserversuccessresult.html index 4a59b795b..7d5ab9bfb 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryobserversuccessresult.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryobserversuccessresult.html @@ -1,501 +1 @@ - - - - - - QueryObserverSuccessResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryObserverSuccessResult<TData, TError>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

data

-
data: TData
- -
-
- -

dataUpdatedAt

-
dataUpdatedAt: number
- -
-
- -

error

-
error: null
- -
-
- -

errorUpdatedAt

-
errorUpdatedAt: number
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: false
- -
-
- -

isFetched

-
isFetched: boolean
- -
-
- -

isFetchedAfterMount

-
isFetchedAfterMount: boolean
- -
-
- -

isFetching

-
isFetching: boolean
- -
-
- -

isIdle

-
isIdle: false
- -
-
- -

isLoading

-
isLoading: false
- -
-
- -

isLoadingError

-
isLoadingError: false
- -
-
- -

isPlaceholderData

-
isPlaceholderData: boolean
- -
-
- -

isPreviousData

-
isPreviousData: boolean
- -
-
- -

isRefetchError

-
isRefetchError: false
- -
-
- -

isStale

-
isStale: boolean
- -
-
- -

isSuccess

-
isSuccess: true
- -
-
- -

refetch

-
refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>
- -
-

Type declaration

- -
-
-
- -

remove

-
remove: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: "success"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryObserverSuccessResult | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryObserverSuccessResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Index

Properties

Methods

Properties

data

data: TData

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isIdle

isIdle: false

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: true

status

status: "success"

Methods

refetch

remove

  • remove(): void

  • Returns void

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.queryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.queryoptions.html index 80920d15f..693269914 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.queryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.queryoptions.html @@ -1,434 +1,18 @@ - - - - - - QueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface QueryOptions<TQueryFnData, TError, TData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, TData, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: TData | InitialDataFunction<TData>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: TData, newData: TData) => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (oldData: TData, newData: TData): boolean
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        oldData: TData
        -
        • -
      • -
        newData: TData
        -
        • -
      -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +QueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryOptions<TQueryFnData, TError, TData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: TData | InitialDataFunction<TData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.refetchoptions.html b/packages/xarc-react-query/docs/interfaces/browser.refetchoptions.html index c63a0e37f..861088c6a 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.refetchoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.refetchoptions.html @@ -1,183 +1 @@ - - - - - - RefetchOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface RefetchOptions

-
-
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional cancelRefetch

-
cancelRefetch: boolean
- -
-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +RefetchOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefetchOptions

Hierarchy

Index

Properties

Properties

Optional cancelRefetch

cancelRefetch?: boolean

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.resetoptions.html b/packages/xarc-react-query/docs/interfaces/browser.resetoptions.html index 01ef169d7..f4ad43c8a 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.resetoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.resetoptions.html @@ -1,163 +1 @@ - - - - - - ResetOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ResetOptions

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - ResetOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ResetOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResetOptions

Hierarchy

Index

Properties

Properties

Optional cancelRefetch

cancelRefetch?: boolean

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.resultoptions.html b/packages/xarc-react-query/docs/interfaces/browser.resultoptions.html index b7b0736fe..3d958f315 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.resultoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.resultoptions.html @@ -1,174 +1 @@ - - - - - - ResultOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ResultOptions

-
-
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional throwOnError

-
throwOnError: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ResultOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResultOptions

Hierarchy

Index

Properties

Properties

Optional throwOnError

throwOnError?: boolean

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.usebasequeryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.usebasequeryoptions.html index 4f75d4938..d10ad95b2 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.usebasequeryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.usebasequeryoptions.html @@ -1,944 +1,86 @@ - - - - - - UseBaseQueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, TQueryData, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional enabled

-
enabled: boolean
- -
-
-

Set this to false to disable automatic refetching when the query mounts or changes query keys. - To refetch the query, use the refetch method returned from the useQuery instance. - Defaults to true.

-
-
-
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: TQueryData | InitialDataFunction<TQueryData>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: TQueryData, newData: TQueryData) => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (oldData: TQueryData, newData: TQueryData): boolean
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        oldData: TQueryData
        -
        • -
      • -
        newData: TQueryData
        -
        • -
      -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional keepPreviousData

-
keepPreviousData: boolean
- -
-
-

Set this to true to keep the previous data when fetching based on a new query key. - Defaults to false.

-
-
-
-
- -

Optional notifyOnChangeProps

-
notifyOnChangeProps: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[] | "tracked"
- -
-
-

If set, the component will only re-render if any of the listed properties change. - When set to ['data', 'error'], the component will only re-render when the data or error properties change. - When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

-
-
-
-
- -

Optional notifyOnChangePropsExclusions

-
notifyOnChangePropsExclusions: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[]
- -
-
-

If set, the component will not re-render if any of the listed properties change.

-
-
-
-
- -

Optional onError

-
onError: (err: TError) => void
- -
-
-

This callback will fire if the query encounters an error and will be passed the error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (err: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        err: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError) => void
- -
-
-

This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData) => void
- -
-
-

This callback will fire any time the query successfully fetches new data.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional optimisticResults

-
optimisticResults: boolean
- -
-
-

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. - This is to make sure the results are not lagging behind. - Defaults to true.

-
-
-
-
- -

Optional placeholderData

-
placeholderData: TData | PlaceholderDataFunction<TData>
- -
-
-

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

-
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional refetchInterval

-
refetchInterval: number | false
- -
-
-

If set to a number, the query will continuously refetch at this frequency in milliseconds. - Defaults to false.

-
-
-
-
- -

Optional refetchIntervalInBackground

-
refetchIntervalInBackground: boolean
- -
-
-

If set to true, the query will continue to refetch while their tab/window is in the background. - Defaults to false.

-
-
-
-
- -

Optional refetchOnMount

-
refetchOnMount: boolean | "always"
- -
-
-

If set to true, the query will refetch on mount if the data is stale. - If set to false, will disable additional instances of a query to trigger background refetches. - If set to 'always', the query will always refetch on mount. - Defaults to true.

-
-
-
-
- -

Optional refetchOnReconnect

-
refetchOnReconnect: boolean | "always"
- -
-
-

If set to true, the query will refetch on reconnect if the data is stale. - If set to false, the query will not refetch on reconnect. - If set to 'always', the query will always refetch on reconnect. - Defaults to true.

-
-
-
-
- -

Optional refetchOnWindowFocus

-
refetchOnWindowFocus: boolean | "always"
- -
-
-

If set to true, the query will refetch on window focus if the data is stale. - If set to false, the query will not refetch on window focus. - If set to 'always', the query will always refetch on window focus. - Defaults to true.

-
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional retryOnMount

-
retryOnMount: boolean
- -
-
-

If set to false, the query will not be retried on mount if it contains an error. - Defaults to true.

-
-
-
-
- -

Optional select

-
select: (data: TQueryData) => TData
- -
-
-

This option can be used to transform or select a part of the data returned by the query function.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TQueryData): TData
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TQueryData
        -
        • -
      -

      Returns TData

      -
      • -
    -
    • -
-
-
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If set to Infinity, the data will never be considered stale.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
- -

Optional suspense

-
suspense: boolean
- -
-
-

If set to true, the query will suspend when status === 'loading' - and throw errors when status === 'error'. - Defaults to false.

-
-
-
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-

Whether errors should be thrown instead of setting the error property. - Defaults to false.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +UseBaseQueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TQueryData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional enabled

enabled?: boolean
+

Set this to false to disable automatic refetching when the query mounts or changes query keys. +To refetch the query, use the refetch method returned from the useQuery instance. +Defaults to true.

+

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: TQueryData | InitialDataFunction<TQueryData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional keepPreviousData

keepPreviousData?: boolean
+

Set this to true to keep the previous data when fetching based on a new query key. +Defaults to false.

+

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional notifyOnChangeProps

notifyOnChangeProps?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[] | "tracked"
+

If set, the component will only re-render if any of the listed properties change. +When set to ['data', 'error'], the component will only re-render when the data or error properties change. +When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

+

Optional notifyOnChangePropsExclusions

notifyOnChangePropsExclusions?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[]
+

If set, the component will not re-render if any of the listed properties change.

+

Optional optimisticResults

optimisticResults?: boolean
+

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. +This is to make sure the results are not lagging behind. +Defaults to true.

+

Optional placeholderData

placeholderData?: TQueryData | PlaceholderDataFunction<TQueryData>
+

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional refetchInterval

refetchInterval?: number | false | ((data: TData, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false)
+

If set to a number, the query will continuously refetch at this frequency in milliseconds. +If set to a function, the function will be executed with the latest data and query to compute a frequency +Defaults to false.

+

Optional refetchIntervalInBackground

refetchIntervalInBackground?: boolean
+

If set to true, the query will continue to refetch while their tab/window is in the background. +Defaults to false.

+

Optional refetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on mount if the data is stale. +If set to false, will disable additional instances of a query to trigger background refetches. +If set to 'always', the query will always refetch on mount. +If set to a function, the function will be executed with the latest data and query to compute the value +Defaults to true.

+

Optional refetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on reconnect if the data is stale. +If set to false, the query will not refetch on reconnect. +If set to 'always', the query will always refetch on reconnect. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional refetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on window focus if the data is stale. +If set to false, the query will not refetch on window focus. +If set to 'always', the query will always refetch on window focus. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional retryOnMount

retryOnMount?: boolean
+

If set to false, the query will not be retried on mount if it contains an error. +Defaults to true.

+

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If set to Infinity, the data will never be considered stale.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Optional suspense

suspense?: boolean
+

If set to true, the query will suspend when status === 'loading' +and throw errors when status === 'error'. +Defaults to false.

+

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean)
+

Whether errors should be thrown instead of setting the error property. +If set to true or suspense is true, all errors will be thrown to the error boundary. +If set to false and suspense is false, errors are returned as state. +If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). +Defaults to false.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Optional onError

  • onError(err: TError): void
  • +

    This callback will fire if the query encounters an error and will be passed the error.

    +

    Parameters

    • err: TError

    Returns void

Optional onSettled

  • onSettled(data: TData, error: TError): void
  • +

    This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

    +

    Parameters

    • data: TData
    • error: TError

    Returns void

Optional onSuccess

  • onSuccess(data: TData): void
  • +

    This callback will fire any time the query successfully fetches new data or the cache is updated via setQueryData.

    +

    Parameters

    • data: TData

    Returns void

Optional select

  • select(data: TQueryData): TData
  • +

    This option can be used to transform or select a part of the data returned by the query function.

    +

    Parameters

    • data: TQueryData

    Returns TData

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.useinfinitequeryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.useinfinitequeryoptions.html index f73735f68..3f73b9825 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.useinfinitequeryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.useinfinitequeryoptions.html @@ -1,939 +1,86 @@ - - - - - - UseInfiniteQueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, InfiniteData<TQueryData>, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional enabled

-
enabled: boolean
- -
-
-

Set this to false to disable automatic refetching when the query mounts or changes query keys. - To refetch the query, use the refetch method returned from the useQuery instance. - Defaults to true.

-
-
-
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: InfiniteData<TQueryData> | InitialDataFunction<InfiniteData<TQueryData>>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: InfiniteData<TQueryData>, newData: InfiniteData<TQueryData>) => boolean
- -
-

Type declaration

- -
-
-
- -

Optional keepPreviousData

-
keepPreviousData: boolean
- -
-
-

Set this to true to keep the previous data when fetching based on a new query key. - Defaults to false.

-
-
-
-
- -

Optional notifyOnChangeProps

-
notifyOnChangeProps: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[] | "tracked"
- -
-
-

If set, the component will only re-render if any of the listed properties change. - When set to ['data', 'error'], the component will only re-render when the data or error properties change. - When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

-
-
-
-
- -

Optional notifyOnChangePropsExclusions

-
notifyOnChangePropsExclusions: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[]
- -
-
-

If set, the component will not re-render if any of the listed properties change.

-
-
-
-
- -

Optional onError

-
onError: (err: TError) => void
- -
-
-

This callback will fire if the query encounters an error and will be passed the error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (err: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        err: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: InfiniteData<TData>, error: TError) => void
- -
-
-

This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

-
-
-
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      - -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: InfiniteData<TData>) => void
- -
-
-

This callback will fire any time the query successfully fetches new data.

-
-
-
-

Type declaration

- -
-
-
- -

Optional optimisticResults

-
optimisticResults: boolean
- -
-
-

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. - This is to make sure the results are not lagging behind. - Defaults to true.

-
-
-
-
- -

Optional placeholderData

-
placeholderData: InfiniteData<TData> | PlaceholderDataFunction<InfiniteData<TData>>
- -
-
-

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

-
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional refetchInterval

-
refetchInterval: number | false
- -
-
-

If set to a number, the query will continuously refetch at this frequency in milliseconds. - Defaults to false.

-
-
-
-
- -

Optional refetchIntervalInBackground

-
refetchIntervalInBackground: boolean
- -
-
-

If set to true, the query will continue to refetch while their tab/window is in the background. - Defaults to false.

-
-
-
-
- -

Optional refetchOnMount

-
refetchOnMount: boolean | "always"
- -
-
-

If set to true, the query will refetch on mount if the data is stale. - If set to false, will disable additional instances of a query to trigger background refetches. - If set to 'always', the query will always refetch on mount. - Defaults to true.

-
-
-
-
- -

Optional refetchOnReconnect

-
refetchOnReconnect: boolean | "always"
- -
-
-

If set to true, the query will refetch on reconnect if the data is stale. - If set to false, the query will not refetch on reconnect. - If set to 'always', the query will always refetch on reconnect. - Defaults to true.

-
-
-
-
- -

Optional refetchOnWindowFocus

-
refetchOnWindowFocus: boolean | "always"
- -
-
-

If set to true, the query will refetch on window focus if the data is stale. - If set to false, the query will not refetch on window focus. - If set to 'always', the query will always refetch on window focus. - Defaults to true.

-
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional retryOnMount

-
retryOnMount: boolean
- -
-
-

If set to false, the query will not be retried on mount if it contains an error. - Defaults to true.

-
-
-
-
- -

Optional select

-
select: (data: InfiniteData<TQueryData>) => InfiniteData<TData>
- -
-
-

This option can be used to transform or select a part of the data returned by the query function.

-
-
-
-

Type declaration

- -
-
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If set to Infinity, the data will never be considered stale.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
- -

Optional suspense

-
suspense: boolean
- -
-
-

If set to true, the query will suspend when status === 'loading' - and throw errors when status === 'error'. - Defaults to false.

-
-
-
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-

Whether errors should be thrown instead of setting the error property. - Defaults to false.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +UseInfiniteQueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, InfiniteData<TQueryData>, QueryKey>

Optional cacheTime

cacheTime?: number

Optional enabled

enabled?: boolean
+

Set this to false to disable automatic refetching when the query mounts or changes query keys. +To refetch the query, use the refetch method returned from the useQuery instance. +Defaults to true.

+

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: InfiniteData<TQueryData> | InitialDataFunction<InfiniteData<TQueryData>>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional keepPreviousData

keepPreviousData?: boolean
+

Set this to true to keep the previous data when fetching based on a new query key. +Defaults to false.

+

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional notifyOnChangeProps

notifyOnChangeProps?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[] | "tracked"
+

If set, the component will only re-render if any of the listed properties change. +When set to ['data', 'error'], the component will only re-render when the data or error properties change. +When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

+

Optional notifyOnChangePropsExclusions

notifyOnChangePropsExclusions?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[]
+

If set, the component will not re-render if any of the listed properties change.

+

Optional optimisticResults

optimisticResults?: boolean
+

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. +This is to make sure the results are not lagging behind. +Defaults to true.

+

Optional placeholderData

placeholderData?: InfiniteData<TQueryData> | PlaceholderDataFunction<InfiniteData<TQueryData>>
+

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional refetchInterval

refetchInterval?: number | false | ((data: InfiniteData<TData>, query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => number | false)
+

If set to a number, the query will continuously refetch at this frequency in milliseconds. +If set to a function, the function will be executed with the latest data and query to compute a frequency +Defaults to false.

+

Optional refetchIntervalInBackground

refetchIntervalInBackground?: boolean
+

If set to true, the query will continue to refetch while their tab/window is in the background. +Defaults to false.

+

Optional refetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on mount if the data is stale. +If set to false, will disable additional instances of a query to trigger background refetches. +If set to 'always', the query will always refetch on mount. +If set to a function, the function will be executed with the latest data and query to compute the value +Defaults to true.

+

Optional refetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on reconnect if the data is stale. +If set to false, the query will not refetch on reconnect. +If set to 'always', the query will always refetch on reconnect. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional refetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on window focus if the data is stale. +If set to false, the query will not refetch on window focus. +If set to 'always', the query will always refetch on window focus. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional retryOnMount

retryOnMount?: boolean
+

If set to false, the query will not be retried on mount if it contains an error. +Defaults to true.

+

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If set to Infinity, the data will never be considered stale.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Optional suspense

suspense?: boolean
+

If set to true, the query will suspend when status === 'loading' +and throw errors when status === 'error'. +Defaults to false.

+

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError, query: Query<TQueryFnData, TError, InfiniteData<TQueryData>, TQueryKey>) => boolean)
+

Whether errors should be thrown instead of setting the error property. +If set to true or suspense is true, all errors will be thrown to the error boundary. +If set to false and suspense is false, errors are returned as state. +If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). +Defaults to false.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Optional onError

  • onError(err: TError): void
  • +

    This callback will fire if the query encounters an error and will be passed the error.

    +

    Parameters

    • err: TError

    Returns void

Optional onSettled

  • onSettled(data: TData, error: TError): void
  • +

    This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

    +

    Parameters

    • data: TData
    • error: TError

    Returns void

Optional onSuccess

  • onSuccess(data: TData): void
  • +

    This callback will fire any time the query successfully fetches new data or the cache is updated via setQueryData.

    +

    Parameters

    • data: TData

    Returns void

Optional select

  • select(data: TQueryData): TData
  • +

    This option can be used to transform or select a part of the data returned by the query function.

    +

    Parameters

    • data: TQueryData

    Returns TData

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.usemutationoptions.html b/packages/xarc-react-query/docs/interfaces/browser.usemutationoptions.html index 048b670b0..41c64c77d 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.usemutationoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.usemutationoptions.html @@ -1,383 +1 @@ - - - - - - UseMutationOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface UseMutationOptions<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - UseMutationOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional mutationKey

-
mutationKey: string | unknown[]
- -
-
- -

Optional onError

-
onError: (error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onMutate

-
onMutate: (variables: TVariables) => Promise<undefined> | TContext | Promise<TContext>
- -
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables): Promise<undefined> | TContext | Promise<TContext>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      -

      Returns Promise<undefined> | TContext | Promise<TContext>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData, variables: TVariables, context: TContext) => void | Promise<void>
- -
-

Type declaration

-
    -
  • -
      -
    • (data: TData, variables: TVariables, context: TContext): void | Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        variables: TVariables
        -
        • -
      • -
        context: TContext
        -
        • -
      -

      Returns void | Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +UseMutationOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseMutationOptions<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional meta

meta?: MutationMeta

Optional mutationFn

mutationFn?: MutationFunction<TData, TVariables>

Optional mutationKey

mutationKey?: MutationKey

Optional retry

retry?: RetryValue<TError>

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError) => boolean)

Methods

Optional onError

  • onError(error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onMutate

  • onMutate(variables: TVariables): TContext | Promise<TContext>

  • Parameters

    • variables: TVariables

    Returns TContext | Promise<TContext>

Optional onSettled

  • onSettled(data: TData, error: TError, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • error: TError
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Optional onSuccess

  • onSuccess(data: TData, variables: TVariables, context: TContext): void | Promise<unknown>

  • Parameters

    • data: TData
    • variables: TVariables
    • context: TContext

    Returns void | Promise<unknown>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.usemutationresult.html b/packages/xarc-react-query/docs/interfaces/browser.usemutationresult.html deleted file mode 100644 index d6c4b112f..000000000 --- a/packages/xarc-react-query/docs/interfaces/browser.usemutationresult.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - UseMutationResult | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface UseMutationResult<TData, TError, TVariables, TContext>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = unknown

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-
-

Hierarchy

-
    -
  • - UseMutationResult -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

context

-
context: TContext
- -
-
- -

data

-
data: TData
- -
-
- -

error

-
error: TError
- -
-
- -

failureCount

-
failureCount: number
- -
-
- -

isError

-
isError: boolean
- -
-
- -

isIdle

-
isIdle: boolean
- -
-
- -

isLoading

-
isLoading: boolean
- -
-
- -

isPaused

-
isPaused: boolean
- -
-
- -

isSuccess

-
isSuccess: boolean
- -
-
- -

mutate

-
mutate: UseMutateFunction<TData, TError, TVariables, TContext>
- -
-
- -

mutateAsync

-
mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>
- -
-
- -

reset

-
reset: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

status

-
status: MutationStatus
- -
-
- -

variables

-
variables: TVariables
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/packages/xarc-react-query/docs/interfaces/browser.usequeryoptions.html b/packages/xarc-react-query/docs/interfaces/browser.usequeryoptions.html index 6f0b56835..ad69f544e 100644 --- a/packages/xarc-react-query/docs/interfaces/browser.usequeryoptions.html +++ b/packages/xarc-react-query/docs/interfaces/browser.usequeryoptions.html @@ -1,936 +1,86 @@ - - - - - - UseQueryOptions | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TData = TQueryFnData

    -
    • -
  • -

    TQueryKey: QueryKey = QueryKey

    -
    • -
-
-
-

Hierarchy

-
    -
  • - UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> -
      -
    • - UseQueryOptions -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional _defaulted

-
_defaulted: boolean
- -
-
- -

Optional behavior

-
behavior: QueryBehavior<TQueryFnData, TError, TQueryFnData, QueryKey>
- -
-
- -

Optional cacheTime

-
cacheTime: number
- -
-
- -

Optional enabled

-
enabled: boolean
- -
-
-

Set this to false to disable automatic refetching when the query mounts or changes query keys. - To refetch the query, use the refetch method returned from the useQuery instance. - Defaults to true.

-
-
-
-
- -

Optional getNextPageParam

-
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the next cursor for infinite queries. - The result will also be used to determine the value of hasNextPage.

-
-
-
-
- -

Optional getPreviousPageParam

-
getPreviousPageParam: GetPreviousPageParamFunction<TQueryFnData>
- -
-
-

This function can be set to automatically get the previous cursor for infinite queries. - The result will also be used to determine the value of hasPreviousPage.

-
-
-
-
- -

Optional initialData

-
initialData: TQueryFnData | InitialDataFunction<TQueryFnData>
- -
-
- -

Optional initialDataUpdatedAt

-
initialDataUpdatedAt: number | (() => number)
- -
-
- -

Optional isDataEqual

-
isDataEqual: (oldData: TQueryFnData, newData: TQueryFnData) => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (oldData: TQueryFnData, newData: TQueryFnData): boolean
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        oldData: TQueryFnData
        -
        • -
      • -
        newData: TQueryFnData
        -
        • -
      -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

Optional keepPreviousData

-
keepPreviousData: boolean
- -
-
-

Set this to true to keep the previous data when fetching based on a new query key. - Defaults to false.

-
-
-
-
- -

Optional notifyOnChangeProps

-
notifyOnChangeProps: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[] | "tracked"
- -
-
-

If set, the component will only re-render if any of the listed properties change. - When set to ['data', 'error'], the component will only re-render when the data or error properties change. - When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

-
-
-
-
- -

Optional notifyOnChangePropsExclusions

-
notifyOnChangePropsExclusions: ("data" | "error" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "status" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isStale" | "refetch" | "remove")[]
- -
-
-

If set, the component will not re-render if any of the listed properties change.

-
-
-
-
- -

Optional onError

-
onError: (err: TError) => void
- -
-
-

This callback will fire if the query encounters an error and will be passed the error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (err: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        err: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSettled

-
onSettled: (data: TData, error: TError) => void
- -
-
-

This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData, error: TError): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      • -
        error: TError
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional onSuccess

-
onSuccess: (data: TData) => void
- -
-
-

This callback will fire any time the query successfully fetches new data.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TData): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TData
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Optional optimisticResults

-
optimisticResults: boolean
- -
-
-

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. - This is to make sure the results are not lagging behind. - Defaults to true.

-
-
-
-
- -

Optional placeholderData

-
placeholderData: TData | PlaceholderDataFunction<TData>
- -
-
-

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

-
-
-
-
- -

Optional queryFn

-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
- -
-
- -

Optional queryHash

-
queryHash: string
- -
-
- -

Optional queryKey

-
queryKey: TQueryKey
- -
-
- -

Optional queryKeyHashFn

-
queryKeyHashFn: QueryKeyHashFunction<TQueryKey>
- -
-
- -

Optional refetchInterval

-
refetchInterval: number | false
- -
-
-

If set to a number, the query will continuously refetch at this frequency in milliseconds. - Defaults to false.

-
-
-
-
- -

Optional refetchIntervalInBackground

-
refetchIntervalInBackground: boolean
- -
-
-

If set to true, the query will continue to refetch while their tab/window is in the background. - Defaults to false.

-
-
-
-
- -

Optional refetchOnMount

-
refetchOnMount: boolean | "always"
- -
-
-

If set to true, the query will refetch on mount if the data is stale. - If set to false, will disable additional instances of a query to trigger background refetches. - If set to 'always', the query will always refetch on mount. - Defaults to true.

-
-
-
-
- -

Optional refetchOnReconnect

-
refetchOnReconnect: boolean | "always"
- -
-
-

If set to true, the query will refetch on reconnect if the data is stale. - If set to false, the query will not refetch on reconnect. - If set to 'always', the query will always refetch on reconnect. - Defaults to true.

-
-
-
-
- -

Optional refetchOnWindowFocus

-
refetchOnWindowFocus: boolean | "always"
- -
-
-

If set to true, the query will refetch on window focus if the data is stale. - If set to false, the query will not refetch on window focus. - If set to 'always', the query will always refetch on window focus. - Defaults to true.

-
-
-
-
- -

Optional retry

-
retry: RetryValue<TError>
- -
-
-

If false, failed queries will not retry by default. - If true, failed queries will retry infinitely., failureCount: num - If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. - If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

-
-
-
-
- -

Optional retryDelay

-
retryDelay: RetryDelayValue<TError>
- -
-
- -

Optional retryOnMount

-
retryOnMount: boolean
- -
-
-

If set to false, the query will not be retried on mount if it contains an error. - Defaults to true.

-
-
-
-
- -

Optional select

-
select: (data: TQueryFnData) => TData
- -
-
-

This option can be used to transform or select a part of the data returned by the query function.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (data: TQueryFnData): TData
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        data: TQueryFnData
        -
        • -
      -

      Returns TData

      -
      • -
    -
    • -
-
-
-
- -

Optional staleTime

-
staleTime: number
- -
-
-

The time in milliseconds after data is considered stale. - If set to Infinity, the data will never be considered stale.

-
-
-
-
- -

Optional structuralSharing

-
structuralSharing: boolean
- -
-
-

Set this to false to disable structural sharing between query results. - Defaults to true.

-
-
-
-
- -

Optional suspense

-
suspense: boolean
- -
-
-

If set to true, the query will suspend when status === 'loading' - and throw errors when status === 'error'. - Defaults to false.

-
-
-
-
- -

Optional useErrorBoundary

-
useErrorBoundary: boolean
- -
-
-

Whether errors should be thrown instead of setting the error property. - Defaults to false.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +UseQueryOptions | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Index

Properties

Methods

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TQueryFnData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional enabled

enabled?: boolean
+

Set this to false to disable automatic refetching when the query mounts or changes query keys. +To refetch the query, use the refetch method returned from the useQuery instance. +Defaults to true.

+

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the next cursor for infinite queries. +The result will also be used to determine the value of hasNextPage.

+

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
+

This function can be set to automatically get the previous cursor for infinite queries. +The result will also be used to determine the value of hasPreviousPage.

+

Optional initialData

initialData?: TQueryFnData | InitialDataFunction<TQueryFnData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => number)

Optional keepPreviousData

keepPreviousData?: boolean
+

Set this to true to keep the previous data when fetching based on a new query key. +Defaults to false.

+

Optional meta

meta?: QueryMeta
+

Additional payload to be stored on each query. +Use this property to pass information that can be used in other places.

+

Optional notifyOnChangeProps

notifyOnChangeProps?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[] | "tracked"
+

If set, the component will only re-render if any of the listed properties change. +When set to ['data', 'error'], the component will only re-render when the data or error properties change. +When set to tracked, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

+

Optional notifyOnChangePropsExclusions

notifyOnChangePropsExclusions?: ("data" | "error" | "remove" | "status" | "isError" | "isIdle" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchingNextPage" | "isFetchingPreviousPage" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isPlaceholderData" | "isPreviousData" | "isRefetching" | "isStale" | "refetch")[]
+

If set, the component will not re-render if any of the listed properties change.

+

Optional optimisticResults

optimisticResults?: boolean
+

If set, the observer will optimistically set the result in fetching state before the query has actually started fetching. +This is to make sure the results are not lagging behind. +Defaults to true.

+

Optional placeholderData

placeholderData?: TQueryFnData | PlaceholderDataFunction<TQueryFnData>
+

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

+

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

Optional refetchInterval

refetchInterval?: number | false | ((data: TData, query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => number | false)
+

If set to a number, the query will continuously refetch at this frequency in milliseconds. +If set to a function, the function will be executed with the latest data and query to compute a frequency +Defaults to false.

+

Optional refetchIntervalInBackground

refetchIntervalInBackground?: boolean
+

If set to true, the query will continue to refetch while their tab/window is in the background. +Defaults to false.

+

Optional refetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on mount if the data is stale. +If set to false, will disable additional instances of a query to trigger background refetches. +If set to 'always', the query will always refetch on mount. +If set to a function, the function will be executed with the latest data and query to compute the value +Defaults to true.

+

Optional refetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on reconnect if the data is stale. +If set to false, the query will not refetch on reconnect. +If set to 'always', the query will always refetch on reconnect. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional refetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always")
+

If set to true, the query will refetch on window focus if the data is stale. +If set to false, the query will not refetch on window focus. +If set to 'always', the query will always refetch on window focus. +If set to a function, the function will be executed with the latest data and query to compute the value. +Defaults to true.

+

Optional retry

retry?: RetryValue<TError>
+

If false, failed queries will not retry by default. +If true, failed queries will retry infinitely., failureCount: num +If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. +If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

+

Optional retryDelay

retryDelay?: RetryDelayValue<TError>

Optional retryOnMount

retryOnMount?: boolean
+

If set to false, the query will not be retried on mount if it contains an error. +Defaults to true.

+

Optional staleTime

staleTime?: number
+

The time in milliseconds after data is considered stale. +If set to Infinity, the data will never be considered stale.

+

Optional structuralSharing

structuralSharing?: boolean
+

Set this to false to disable structural sharing between query results. +Defaults to true.

+

Optional suspense

suspense?: boolean
+

If set to true, the query will suspend when status === 'loading' +and throw errors when status === 'error'. +Defaults to false.

+

Optional useErrorBoundary

useErrorBoundary?: boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean)
+

Whether errors should be thrown instead of setting the error property. +If set to true or suspense is true, all errors will be thrown to the error boundary. +If set to false and suspense is false, errors are returned as state. +If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). +Defaults to false.

+

Methods

Optional isDataEqual

  • isDataEqual(oldData: TData, newData: TData): boolean

  • Parameters

    • oldData: TData
    • newData: TData

    Returns boolean

Optional onError

  • onError(err: TError): void
  • +

    This callback will fire if the query encounters an error and will be passed the error.

    +

    Parameters

    • err: TError

    Returns void

Optional onSettled

  • onSettled(data: TData, error: TError): void
  • +

    This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.

    +

    Parameters

    • data: TData
    • error: TError

    Returns void

Optional onSuccess

  • onSuccess(data: TData): void
  • +

    This callback will fire any time the query successfully fetches new data or the cache is updated via setQueryData.

    +

    Parameters

    • data: TData

    Returns void

Optional select

  • select(data: TQueryData): TData
  • +

    This option can be used to transform or select a part of the data returned by the query function.

    +

    Parameters

    • data: TQueryData

    Returns TData

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/modules.html b/packages/xarc-react-query/docs/modules.html index a0ec95272..4ef30102b 100644 --- a/packages/xarc-react-query/docs/modules.html +++ b/packages/xarc-react-query/docs/modules.html @@ -1,122 +1 @@ - - - - - - @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
-

@xarc/react-query

-
-
-
-
-
-
-
-

Index

-
-
-
-

Modules

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +@xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

@xarc/react-query

Index

Modules

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/modules/browser.html b/packages/xarc-react-query/docs/modules/browser.html index 7f93ce34e..42b16766b 100644 --- a/packages/xarc-react-query/docs/modules/browser.html +++ b/packages/xarc-react-query/docs/modules/browser.html @@ -1,1804 +1,10 @@ - - - - - - browser | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module browser

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Type aliases

- -
-
-

Variables

- -
-
-

Functions

- -
-
-
-
-
-

References

-
- -

PrefetchQueryServerModule

- Re-exports PrefetchQueryServerModule -
-
- -

ReactQueryFeature

- Re-exports ReactQueryFeature -
-
- -

ReactQueryFeatureOptions

- Re-exports ReactQueryFeatureOptions -
-
- -

prefetchQueryMethod

- Re-exports prefetchQueryMethod -
-
-
-

Type aliases

-
- -

GetNextPageParamFunction

-
GetNextPageParamFunction<TQueryFnData>: (lastPage: TQueryFnData, allPages: TQueryFnData[]) => unknown
- -

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (lastPage: TQueryFnData, allPages: TQueryFnData[]): unknown
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        lastPage: TQueryFnData
        -
        • -
      • -
        allPages: TQueryFnData[]
        -
        • -
      -

      Returns unknown

      -
      • -
    -
    • -
-
-
-
- -

GetPreviousPageParamFunction

-
GetPreviousPageParamFunction<TQueryFnData>: (firstPage: TQueryFnData, allPages: TQueryFnData[]) => unknown
- -

Type parameters

-
    -
  • -

    TQueryFnData = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (firstPage: TQueryFnData, allPages: TQueryFnData[]): unknown
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        firstPage: TQueryFnData
        -
        • -
      • -
        allPages: TQueryFnData[]
        -
        • -
      -

      Returns unknown

      -
      • -
    -
    • -
-
-
-
- -

InfiniteQueryObserverResult

-
InfiniteQueryObserverResult<TData, TError>: InfiniteQueryObserverIdleResult<TData, TError> | InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
- -

InitialDataFunction

-
InitialDataFunction<T>: () => T | undefined
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (): T | undefined
      • -
    -
      -
    • -

      Returns T | undefined

      -
      • -
    -
    • -
-
-
-
- -

InitialStaleFunction

-
InitialStaleFunction: () => boolean
- -
-

Type declaration

-
    -
  • -
      -
    • (): boolean
      • -
    -
      -
    • -

      Returns boolean

      -
      • -
    -
    • -
-
-
-
- -

MutateFunction

-
MutateFunction<TData, TError, TVariables, TContext>: (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      • -
        Optional options: MutateOptions<TData, TError, TVariables, TContext>
        -
        • -
      -

      Returns Promise<TData>

      -
      • -
    -
    • -
-
-
-
- -

MutationFunction

-
MutationFunction<TData, TVariables>: (variables: TVariables) => Promise<TData>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TVariables = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables): Promise<TData>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      -

      Returns Promise<TData>

      -
      • -
    -
    • -
-
-
-
- -

MutationKey

-
MutationKey: string | readonly unknown[]
- -
-
- -

MutationStatus

-
MutationStatus: "idle" | "loading" | "success" | "error"
- -
-
- -

PlaceholderDataFunction

-
PlaceholderDataFunction<TResult>: () => TResult | undefined
- -

Type parameters

-
    -
  • -

    TResult

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (): TResult | undefined
      • -
    -
      -
    • -

      Returns TResult | undefined

      -
      • -
    -
    • -
-
-
-
- -

QueryFunction

-
QueryFunction<T, TQueryKey>: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
- -

Type parameters

- -
-

Type declaration

- -
-
-
- -

QueryKey

-
QueryKey: string | readonly unknown[]
- -
-
- -

QueryKeyHashFunction

-
QueryKeyHashFunction<TQueryKey>: (queryKey: TQueryKey) => string
- -

Type parameters

- -
-

Type declaration

-
    -
  • -
      -
    • (queryKey: TQueryKey): string
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        queryKey: TQueryKey
        -
        • -
      -

      Returns string

      -
      • -
    -
    • -
-
-
-
- -

QueryObserverResult

-
QueryObserverResult<TData, TError>: QueryObserverIdleResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
- -

QueryStatus

-
QueryStatus: "idle" | "loading" | "error" | "success"
- -
-
- -

UseBaseQueryResult

-
UseBaseQueryResult<TData, TError>: QueryObserverResult<TData, TError>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
- -

UseInfiniteQueryResult

-
UseInfiniteQueryResult<TData, TError>: InfiniteQueryObserverResult<TData, TError>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
- -

UseMutateAsyncFunction

-
UseMutateAsyncFunction<TData, TError, TVariables, TContext>: (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      • -
        Optional options: MutateOptions<TData, TError, TVariables, TContext>
        -
        • -
      -

      Returns Promise<TData>

      -
      • -
    -
    • -
-
-
-
- -

UseMutateFunction

-
UseMutateFunction<TData, TError, TVariables, TContext>: (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => void
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
  • -

    TVariables = void

    -
    • -
  • -

    TContext = unknown

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        variables: TVariables
        -
        • -
      • -
        Optional options: MutateOptions<TData, TError, TVariables, TContext>
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

UseQueryResult

-
UseQueryResult<TData, TError>: UseBaseQueryResult<TData, TError>
- -

Type parameters

-
    -
  • -

    TData = unknown

    -
    • -
  • -

    TError = unknown

    -
    • -
-
-
-
-

Variables

-
- -

Const Hydrate

-
Hydrate: React.FC<HydrateProps>
- -
-
- -

Const QueryClientProvider

-
QueryClientProvider: React.FC<QueryClientProviderProps>
- -
-
- -

Const QueryErrorResetBoundary

-
QueryErrorResetBoundary: React.FC<QueryErrorResetBoundaryProps>
- -
-
- -

Const focusManager

-
focusManager: FocusManager
- -
-
- -

Const notifyManager

-
notifyManager: NotifyManager
- -
-
- -

Const onlineManager

-
onlineManager: OnlineManager
- -
-
-
-

Functions

-
- -

dehydrate

-
    -
  • dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      client: QueryClient
      -
      • -
    • -
      Optional options: DehydrateOptions
      -
      • -
    -

    Returns DehydratedState

    -
    • -
-
-
- -

hashQueryKey

-
    -
  • hashQueryKey(queryKey: QueryKey): string
    • -
-
    -
  • - -
    -
    -

    Default query keys hash function.

    -
    -
    -

    Parameters

    - -

    Returns string

    -
    • -
-
-
- -

isCancelledError

- -
    -
  • - -

    Parameters

    -
      -
    • -
      value: any
      -
      • -
    -

    Returns value is CancelledError

    -
    • -
-
-
- -

isError

-
    -
  • isError(value: any): value is Error
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      value: any
      -
      • -
    -

    Returns value is Error

    -
    • -
-
-
- -

reactQueryFeature

- - -
-
- -

setLogger

-
    -
  • setLogger(newLogger: Logger): void
    • -
-
    -
  • - -

    Parameters

    - -

    Returns void

    -
    • -
-
-
- -

useInfiniteQuery

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns UseInfiniteQueryResult<TData, TError>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      Optional options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
      -
      • -
    -

    Returns UseInfiniteQueryResult<TData, TError>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      queryFn: QueryFunction<TQueryFnData, TQueryKey>
      -
      • -
    • -
      Optional options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
      -
      • -
    -

    Returns UseInfiniteQueryResult<TData, TError>

    -
    • -
-
-
- -

useIsFetching

-
    -
  • useIsFetching(filters?: QueryFilters): number
    • -
  • useIsFetching(queryKey?: QueryKey, filters?: QueryFilters): number
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns number

    -
    • -
  • - -

    Parameters

    -
      -
    • -
      Optional queryKey: QueryKey
      -
      • -
    • -
      Optional filters: QueryFilters
      -
      • -
    -

    Returns number

    -
    • -
-
-
- -

useIsMutating

-
    -
  • useIsMutating(filters?: MutationFilters): number
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional filters: MutationFilters
      -
      • -
    -

    Returns number

    -
    • -
-
-
- -

useMutation

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns UseMutationResult<TData, TError, TVariables, TContext>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns UseMutationResult<TData, TError, TVariables, TContext>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns UseMutationResult<TData, TError, TVariables, TContext>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TVariables = void

      -
      • -
    • -

      TContext = unknown

      -
      • -
    -

    Parameters

    - -

    Returns UseMutationResult<TData, TError, TVariables, TContext>

    -
    • -
-
-
- -

useQueries

- -
    -
  • - -

    Parameters

    - -

    Returns UseQueryResult[]

    -
    • -
-
-
- -

useQuery

-
    -
  • useQuery<TQueryFnData, TError, TData, TQueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>
    • -
  • useQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>
    • -
  • useQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    - -

    Returns UseQueryResult<TData, TError>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      Optional options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns UseQueryResult<TData, TError>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      TQueryFnData = unknown

      -
      • -
    • -

      TError = unknown

      -
      • -
    • -

      TData = TQueryFnData

      -
      • -
    • -

      TQueryKey: QueryKey = QueryKey

      -
      • -
    -

    Parameters

    -
      -
    • -
      queryKey: TQueryKey
      -
      • -
    • -
      queryFn: QueryFunction<TQueryFnData, TQueryKey>
      -
      • -
    • -
      Optional options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
      -
      • -
    -

    Returns UseQueryResult<TData, TError>

    -
    • -
-
-
- -

Const useQueryClient

- -
    -
  • - -

    Returns QueryClient

    -
    • -
-
-
- -

Const useQueryErrorResetBoundary

-
    -
  • useQueryErrorResetBoundary(): QueryErrorResetBoundaryValue
    • -
-
    -
  • - -

    Returns QueryErrorResetBoundaryValue

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +browser | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module browser

Index

References

Classes

Interfaces

Type Aliases

Variables

Functions

References

PrefetchQueryServerModule

Re-exports PrefetchQueryServerModule

ReactQueryFeature

Re-exports ReactQueryFeature

ReactQueryFeatureOptions

Re-exports ReactQueryFeatureOptions

prefetchQueryMethod

Re-exports prefetchQueryMethod

Type Aliases

EnsuredQueryKey

EnsuredQueryKey<T>: T extends string ? [T] : Exclude<T, string>

Type Parameters

GetNextPageParamFunction

GetNextPageParamFunction<TQueryFnData>: ((lastPage: TQueryFnData, allPages: TQueryFnData[]) => unknown)

Type Parameters

  • TQueryFnData = unknown

Type declaration

    • (lastPage: TQueryFnData, allPages: TQueryFnData[]): unknown

    • Parameters

      • lastPage: TQueryFnData
      • allPages: TQueryFnData[]

      Returns unknown

GetPreviousPageParamFunction

GetPreviousPageParamFunction<TQueryFnData>: ((firstPage: TQueryFnData, allPages: TQueryFnData[]) => unknown)

Type Parameters

  • TQueryFnData = unknown

Type declaration

    • (firstPage: TQueryFnData, allPages: TQueryFnData[]): unknown

    • Parameters

      • firstPage: TQueryFnData
      • allPages: TQueryFnData[]

      Returns unknown

InfiniteQueryObserverResult

InfiniteQueryObserverResult<TData, TError>: InfiniteQueryObserverIdleResult<TData, TError> | InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

InitialDataFunction

InitialDataFunction<T>: (() => T | undefined)

Type Parameters

  • T

Type declaration

    • (): T | undefined

    • Returns T | undefined

MutateFunction

MutateFunction<TData, TError, TVariables, TContext>: ((variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>)

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Type declaration

    • (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>

    • Parameters

      • variables: TVariables
      • Optional options: MutateOptions<TData, TError, TVariables, TContext>

      Returns Promise<TData>

MutationFunction

MutationFunction<TData, TVariables>: ((variables: TVariables) => Promise<TData>)

Type Parameters

  • TData = unknown

  • TVariables = unknown

Type declaration

    • (variables: TVariables): Promise<TData>

    • Parameters

      • variables: TVariables

      Returns Promise<TData>

MutationKey

MutationKey: string | readonly unknown[]

MutationMeta

MutationMeta: Record<string, unknown>

MutationObserverResult

MutationObserverResult<TData, TError, TVariables, TContext>: MutationObserverIdleResult<TData, TError, TVariables, TContext> | MutationObserverLoadingResult<TData, TError, TVariables, TContext> | MutationObserverErrorResult<TData, TError, TVariables, TContext> | MutationObserverSuccessResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

MutationStatus

MutationStatus: "idle" | "loading" | "success" | "error"

PlaceholderDataFunction

PlaceholderDataFunction<TResult>: (() => TResult | undefined)

Type Parameters

  • TResult

Type declaration

    • (): TResult | undefined

    • Returns TResult | undefined

QueriesOptions

QueriesOptions<T, Result, Depth>: Depth["length"] extends MAXIMUM_DEPTH ? UseQueryOptions[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...(infer Tail)] ? QueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends UseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions[]
+

QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param

+

Type Parameters

  • T extends any[]

  • Result extends any[] = []

  • Depth extends ReadonlyArray<number> = []

QueriesResults

QueriesResults<T, Result, Depth>: Depth["length"] extends MAXIMUM_DEPTH ? UseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...(infer Tail)] ? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends UseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>[] ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>[] : UseQueryResult[]
+

QueriesResults reducer recursively maps type param to results

+

Type Parameters

  • T extends any[]

  • Result extends any[] = []

  • Depth extends ReadonlyArray<number> = []

QueryFunction

QueryFunction<T, TQueryKey>: ((context: QueryFunctionContext<TQueryKey>) => T | Promise<T>)

Type Parameters

Type declaration

QueryKey

QueryKey: string | readonly unknown[]

QueryKeyHashFunction

QueryKeyHashFunction<TQueryKey>: ((queryKey: TQueryKey) => string)

Type Parameters

Type declaration

    • (queryKey: TQueryKey): string

    • Parameters

      • queryKey: TQueryKey

      Returns string

QueryMeta

QueryMeta: Record<string, unknown>

QueryObserverResult

QueryObserverResult<TData, TError>: QueryObserverIdleResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

QueryStatus

QueryStatus: "idle" | "loading" | "error" | "success"

ShouldDehydrateMutationFunction

ShouldDehydrateMutationFunction: ((mutation: Mutation) => boolean)

Type declaration

ShouldDehydrateQueryFunction

ShouldDehydrateQueryFunction: ((query: Query) => boolean)

Type declaration

    • Parameters

      Returns boolean

UseBaseMutationResult

UseBaseMutationResult<TData, TError, TVariables, TContext>: Override<MutationObserverResult<TData, TError, TVariables, TContext>, { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = unknown

  • TContext = unknown

UseBaseQueryResult

UseBaseQueryResult<TData, TError>: QueryObserverResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

UseInfiniteQueryResult

UseInfiniteQueryResult<TData, TError>: InfiniteQueryObserverResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

UseMutateAsyncFunction

UseMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunction<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

UseMutateFunction

UseMutateFunction<TData, TError, TVariables, TContext>: ((...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void)

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Type declaration

    • (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>): void

    • Parameters

      • Rest ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>

      Returns void

UseMutationResult

UseMutationResult<TData, TError, TVariables, TContext>: UseBaseMutationResult<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = unknown

  • TContext = unknown

UseQueryResult

UseQueryResult<TData, TError>: UseBaseQueryResult<TData, TError>

Type Parameters

  • TData = unknown

  • TError = unknown

Variables

Const focusManager

focusManager: FocusManager

Const notifyManager

notifyManager: NotifyManager

Const onlineManager

onlineManager: OnlineManager

Functions

Hydrate

  • Hydrate(__namedParameters: HydrateProps): ReactElement<any, string | ((props: any) => ReactElement<any, any>) | (new (props: any) => Component<any, any, any>)>

  • Parameters

    Returns ReactElement<any, string | ((props: any) => ReactElement<any, any>) | (new (props: any) => Component<any, any, any>)>

QueryClientProvider

  • Parameters

    Returns Element

QueryErrorResetBoundary

  • Parameters

    Returns Element

dehydrate

  • Parameters

    Returns DehydratedState

hashQueryKey

  • hashQueryKey(queryKey: QueryKey): string
  • +

    Default query keys hash function.

    +

    Parameters

    Returns string

hydrate

  • Parameters

    Returns void

isCancelledError

  • Parameters

    • value: any

    Returns value is CancelledError

isError

  • isError(value: any): value is Error

  • Parameters

    • value: any

    Returns value is Error

reactQueryFeature

setLogger

  • setLogger(newLogger: Logger): void

  • Parameters

    Returns void

useHydrate

  • Parameters

    Returns void

useInfiniteQuery

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns UseInfiniteQueryResult<TData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • Optional options: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, "queryKey">

    Returns UseInfiniteQueryResult<TData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • queryFn: QueryFunction<TQueryFnData, TQueryKey>
    • Optional options: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, "queryKey" | "queryFn">

    Returns UseInfiniteQueryResult<TData, TError>

useIsFetching

  • useIsFetching(filters?: QueryFilters): number
  • useIsFetching(queryKey?: QueryKey, filters?: QueryFilters): number

  • Parameters

    • Optional filters: QueryFilters

    Returns number

  • Parameters

    • Optional queryKey: QueryKey
    • Optional filters: QueryFilters

    Returns number

useIsMutating

  • useIsMutating(filters?: MutationFilters): number
  • useIsMutating(mutationKey?: MutationKey, filters?: Omit<MutationFilters, "mutationKey">): number

  • Parameters

    • Optional filters: MutationFilters

    Returns number

  • Parameters

    • Optional mutationKey: MutationKey
    • Optional filters: Omit<MutationFilters, "mutationKey">

    Returns number

useMutation

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns UseMutationResult<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns UseMutationResult<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns UseMutationResult<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns UseMutationResult<TData, TError, TVariables, TContext>

useQueries

  • useQueries<T>(queries: readonly [T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends T ? T : T extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[]]): QueriesResults<T>

  • Type Parameters

    • T extends any[]

    Parameters

    • queries: readonly [T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends [...Tail[]] ? [...Tail[]] : [...Tail[]] extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[] : unknown[] extends T ? T : T extends UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptions<unknown, unknown, unknown, QueryKey>[]]

    Returns QueriesResults<T>

useQuery

  • useQuery<TQueryFnData, TError, TData, TQueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>
  • useQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">): UseQueryResult<TData, TError>
  • useQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey" | "queryFn">): UseQueryResult<TData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns UseQueryResult<TData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • Optional options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">

    Returns UseQueryResult<TData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    • queryKey: TQueryKey
    • queryFn: QueryFunction<TQueryFnData, TQueryKey>
    • Optional options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey" | "queryFn">

    Returns UseQueryResult<TData, TError>

useQueryClient

  • Returns QueryClient

useQueryErrorResetBoundary

  • useQueryErrorResetBoundary(): QueryErrorResetBoundaryValue

  • Returns QueryErrorResetBoundaryValue

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/modules/common.html b/packages/xarc-react-query/docs/modules/common.html index 93e823152..f9009a6b1 100644 --- a/packages/xarc-react-query/docs/modules/common.html +++ b/packages/xarc-react-query/docs/modules/common.html @@ -1,1076 +1,33 @@ - - - - - - common | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module common

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Type aliases

- -
-
-
-
-
-

References

-
- -

CancelledError

- Re-exports CancelledError -
-
- -

DefaultOptions

- Re-exports DefaultOptions -
-
- -

FetchInfiniteQueryOptions

- Re-exports FetchInfiniteQueryOptions -
-
- -

FetchNextPageOptions

- Re-exports FetchNextPageOptions -
-
- -

FetchPreviousPageOptions

- Re-exports FetchPreviousPageOptions -
-
- -

FetchQueryOptions

- Re-exports FetchQueryOptions -
-
- -

GetNextPageParamFunction

- Re-exports GetNextPageParamFunction -
-
- -

GetPreviousPageParamFunction

- Re-exports GetPreviousPageParamFunction -
-
- -

Hydrate

- Re-exports Hydrate -
-
- -

InfiniteData

- Re-exports InfiniteData -
-
- -

InfiniteQueryObserver

- Re-exports InfiniteQueryObserver -
-
- -

InfiniteQueryObserverBaseResult

- Re-exports InfiniteQueryObserverBaseResult -
-
- -

InfiniteQueryObserverIdleResult

- Re-exports InfiniteQueryObserverIdleResult -
-
- -

InfiniteQueryObserverLoadingErrorResult

- Re-exports InfiniteQueryObserverLoadingErrorResult -
-
- -

InfiniteQueryObserverLoadingResult

- Re-exports InfiniteQueryObserverLoadingResult -
-
- -

InfiniteQueryObserverOptions

- Re-exports InfiniteQueryObserverOptions -
-
- -

InfiniteQueryObserverRefetchErrorResult

- Re-exports InfiniteQueryObserverRefetchErrorResult -
-
- -

InfiniteQueryObserverResult

- Re-exports InfiniteQueryObserverResult -
-
- -

InfiniteQueryObserverSuccessResult

- Re-exports InfiniteQueryObserverSuccessResult -
-
- -

InitialDataFunction

- Re-exports InitialDataFunction -
-
- -

InitialStaleFunction

- Re-exports InitialStaleFunction -
-
- -

InvalidateOptions

- Re-exports InvalidateOptions -
-
- -

InvalidateQueryFilters

- Re-exports InvalidateQueryFilters -
-
- -

Logger

- Re-exports Logger -
-
- -

MutateFunction

- Re-exports MutateFunction -
-
- -

MutateOptions

- Re-exports MutateOptions -
-
- -

MutationCache

- Re-exports MutationCache -
-
- -

MutationFunction

- Re-exports MutationFunction -
-
- -

MutationKey

- Re-exports MutationKey -
-
- -

MutationObserver

- Re-exports MutationObserver -
-
- -

MutationObserverOptions

- Re-exports MutationObserverOptions -
-
- -

MutationObserverResult

- Re-exports MutationObserverResult -
-
- -

MutationOptions

- Re-exports MutationOptions -
-
- -

MutationStatus

- Re-exports MutationStatus -
-
- -

PlaceholderDataFunction

- Re-exports PlaceholderDataFunction -
-
- -

QueriesObserver

- Re-exports QueriesObserver -
-
- -

Query

- Re-exports Query -
-
- -

QueryCache

- Re-exports QueryCache -
-
- -

QueryClient

- Re-exports QueryClient -
-
- -

QueryClientProvider

- Re-exports QueryClientProvider -
-
- -

QueryClientProviderProps

- Re-exports QueryClientProviderProps -
-
- -

QueryErrorResetBoundary

- Re-exports QueryErrorResetBoundary -
-
- -

QueryErrorResetBoundaryProps

- Re-exports QueryErrorResetBoundaryProps -
-
- -

QueryFunction

- Re-exports QueryFunction -
-
- -

QueryFunctionContext

- Re-exports QueryFunctionContext -
-
- -

QueryKey

- Re-exports QueryKey -
-
- -

QueryKeyHashFunction

- Re-exports QueryKeyHashFunction -
-
- -

QueryObserver

- Re-exports QueryObserver -
-
- -

QueryObserverBaseResult

- Re-exports QueryObserverBaseResult -
-
- -

QueryObserverIdleResult

- Re-exports QueryObserverIdleResult -
-
- -

QueryObserverLoadingErrorResult

- Re-exports QueryObserverLoadingErrorResult -
-
- -

QueryObserverLoadingResult

- Re-exports QueryObserverLoadingResult -
-
- -

QueryObserverOptions

- Re-exports QueryObserverOptions -
-
- -

QueryObserverRefetchErrorResult

- Re-exports QueryObserverRefetchErrorResult -
-
- -

QueryObserverResult

- Re-exports QueryObserverResult -
-
- -

QueryObserverSuccessResult

- Re-exports QueryObserverSuccessResult -
-
- -

QueryOptions

- Re-exports QueryOptions -
-
- -

QueryStatus

- Re-exports QueryStatus -
-
- -

RefetchOptions

- Re-exports RefetchOptions -
-
- -

ResetOptions

- Re-exports ResetOptions -
-
- -

ResultOptions

- Re-exports ResultOptions -
-
- -

UseBaseQueryOptions

- Re-exports UseBaseQueryOptions -
-
- -

UseBaseQueryResult

- Re-exports UseBaseQueryResult -
-
- -

UseInfiniteQueryOptions

- Re-exports UseInfiniteQueryOptions -
-
- -

UseInfiniteQueryResult

- Re-exports UseInfiniteQueryResult -
-
- -

UseMutateAsyncFunction

- Re-exports UseMutateAsyncFunction -
-
- -

UseMutateFunction

- Re-exports UseMutateFunction -
-
- -

UseMutationOptions

- Re-exports UseMutationOptions -
-
- -

UseMutationResult

- Re-exports UseMutationResult -
-
- -

UseQueryOptions

- Re-exports UseQueryOptions -
-
- -

UseQueryResult

- Re-exports UseQueryResult -
-
- -

dehydrate

- Re-exports dehydrate -
-
- -

focusManager

- Re-exports focusManager -
-
- -

hashQueryKey

- Re-exports hashQueryKey -
-
- -

isCancelledError

- Re-exports isCancelledError -
-
- -

isError

- Re-exports isError -
-
- -

notifyManager

- Re-exports notifyManager -
-
- -

onlineManager

- Re-exports onlineManager -
-
- -

setLogger

- Re-exports setLogger -
-
- -

useInfiniteQuery

- Re-exports useInfiniteQuery -
-
- -

useIsFetching

- Re-exports useIsFetching -
-
- -

useIsMutating

- Re-exports useIsMutating -
-
- -

useMutation

- Re-exports useMutation -
-
- -

useQueries

- Re-exports useQueries -
-
- -

useQuery

- Re-exports useQuery -
-
- -

useQueryClient

- Re-exports useQueryClient -
-
- -

useQueryErrorResetBoundary

- Re-exports useQueryErrorResetBoundary -
-
-
-

Type aliases

-
- -

PrefetchQueryServerModule

-
PrefetchQueryServerModule: { prefetchQuery: prefetchQueryMethod }
- -
-
-

Server module for exporting the prefetchQuery method

-
-
-
-

Type declaration

- -
-
-
- -

ReactQueryFeature

-
ReactQueryFeature: SubAppFeature & { options: ReactQueryFeatureOptions; wrap: (_: any) => any }
- -
-
- -

ReactQueryFeatureOptions

-
ReactQueryFeatureOptions: { React: Partial<{ createElement: unknown }>; exportName?: string; queryClient?: QueryClient; serverModule?: string }
- -
-
-

react-query feature options

-
-
-
-

Type declaration

-

prefetchQueryMethod

prefetchQueryMethod: (({ + queryClient, + ssrData +}: { queryClient: QueryClient; ssrData: SubAppSSRData }) => Promise<{ dehydratedState: unknown; queryClient: QueryClient }>)

Type declaration

    • ({ + queryClient, + ssrData +}: { queryClient: QueryClient; ssrData: SubAppSSRData }): Promise<{ dehydratedState: unknown; queryClient: QueryClient }>

    • Parameters

      • { + queryClient, + ssrData +}: { queryClient: QueryClient; ssrData: SubAppSSRData }

      Returns Promise<{ dehydratedState: unknown; queryClient: QueryClient }>

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/modules/common_feature_info.html b/packages/xarc-react-query/docs/modules/common_feature_info.html index 687938928..0f7e3f1b0 100644 --- a/packages/xarc-react-query/docs/modules/common_feature_info.html +++ b/packages/xarc-react-query/docs/modules/common_feature_info.html @@ -1,157 +1 @@ - - - - - - common/feature-info | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module common/feature-info

-
-
-
-
-
-
-
-

Index

-
-
-
-

Variables

- -
-
-
-
-
-

Variables

-
- -

Const featureId

-
featureId: "state-provider" = "state-provider"
- -
-
- -

Const featureSubId

-
featureSubId: "react-query" = "react-query"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +common/feature-info | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module common/feature-info

Index

Variables

Variables

Const featureId

featureId: "state-provider" = "state-provider"

Const featureSubId

featureSubId: "react-query" = "react-query"

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/docs/modules/node.html b/packages/xarc-react-query/docs/modules/node.html index 06bf7805d..07bdff1cc 100644 --- a/packages/xarc-react-query/docs/modules/node.html +++ b/packages/xarc-react-query/docs/modules/node.html @@ -1,989 +1,4 @@ - - - - - - node | @xarc/react-query - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module node

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Functions

- -
-
-
-
-
-

References

-
- -

CancelledError

- Re-exports CancelledError -
-
- -

DefaultOptions

- Re-exports DefaultOptions -
-
- -

FetchInfiniteQueryOptions

- Re-exports FetchInfiniteQueryOptions -
-
- -

FetchNextPageOptions

- Re-exports FetchNextPageOptions -
-
- -

FetchPreviousPageOptions

- Re-exports FetchPreviousPageOptions -
-
- -

FetchQueryOptions

- Re-exports FetchQueryOptions -
-
- -

GetNextPageParamFunction

- Re-exports GetNextPageParamFunction -
-
- -

GetPreviousPageParamFunction

- Re-exports GetPreviousPageParamFunction -
-
- -

Hydrate

- Re-exports Hydrate -
-
- -

InfiniteData

- Re-exports InfiniteData -
-
- -

InfiniteQueryObserver

- Re-exports InfiniteQueryObserver -
-
- -

InfiniteQueryObserverBaseResult

- Re-exports InfiniteQueryObserverBaseResult -
-
- -

InfiniteQueryObserverIdleResult

- Re-exports InfiniteQueryObserverIdleResult -
-
- -

InfiniteQueryObserverLoadingErrorResult

- Re-exports InfiniteQueryObserverLoadingErrorResult -
-
- -

InfiniteQueryObserverLoadingResult

- Re-exports InfiniteQueryObserverLoadingResult -
-
- -

InfiniteQueryObserverOptions

- Re-exports InfiniteQueryObserverOptions -
-
- -

InfiniteQueryObserverRefetchErrorResult

- Re-exports InfiniteQueryObserverRefetchErrorResult -
-
- -

InfiniteQueryObserverResult

- Re-exports InfiniteQueryObserverResult -
-
- -

InfiniteQueryObserverSuccessResult

- Re-exports InfiniteQueryObserverSuccessResult -
-
- -

InitialDataFunction

- Re-exports InitialDataFunction -
-
- -

InitialStaleFunction

- Re-exports InitialStaleFunction -
-
- -

InvalidateOptions

- Re-exports InvalidateOptions -
-
- -

InvalidateQueryFilters

- Re-exports InvalidateQueryFilters -
-
- -

Logger

- Re-exports Logger -
-
- -

MutateFunction

- Re-exports MutateFunction -
-
- -

MutateOptions

- Re-exports MutateOptions -
-
- -

MutationCache

- Re-exports MutationCache -
-
- -

MutationFunction

- Re-exports MutationFunction -
-
- -

MutationKey

- Re-exports MutationKey -
-
- -

MutationObserver

- Re-exports MutationObserver -
-
- -

MutationObserverOptions

- Re-exports MutationObserverOptions -
-
- -

MutationObserverResult

- Re-exports MutationObserverResult -
-
- -

MutationOptions

- Re-exports MutationOptions -
-
- -

MutationStatus

- Re-exports MutationStatus -
-
- -

PlaceholderDataFunction

- Re-exports PlaceholderDataFunction -
-
- -

PrefetchQueryServerModule

- Re-exports PrefetchQueryServerModule -
-
- -

QueriesObserver

- Re-exports QueriesObserver -
-
- -

Query

- Re-exports Query -
-
- -

QueryCache

- Re-exports QueryCache -
-
- -

QueryClient

- Re-exports QueryClient -
-
- -

QueryClientProvider

- Re-exports QueryClientProvider -
-
- -

QueryClientProviderProps

- Re-exports QueryClientProviderProps -
-
- -

QueryErrorResetBoundary

- Re-exports QueryErrorResetBoundary -
-
- -

QueryErrorResetBoundaryProps

- Re-exports QueryErrorResetBoundaryProps -
-
- -

QueryFunction

- Re-exports QueryFunction -
-
- -

QueryFunctionContext

- Re-exports QueryFunctionContext -
-
- -

QueryKey

- Re-exports QueryKey -
-
- -

QueryKeyHashFunction

- Re-exports QueryKeyHashFunction -
-
- -

QueryObserver

- Re-exports QueryObserver -
-
- -

QueryObserverBaseResult

- Re-exports QueryObserverBaseResult -
-
- -

QueryObserverIdleResult

- Re-exports QueryObserverIdleResult -
-
- -

QueryObserverLoadingErrorResult

- Re-exports QueryObserverLoadingErrorResult -
-
- -

QueryObserverLoadingResult

- Re-exports QueryObserverLoadingResult -
-
- -

QueryObserverOptions

- Re-exports QueryObserverOptions -
-
- -

QueryObserverRefetchErrorResult

- Re-exports QueryObserverRefetchErrorResult -
-
- -

QueryObserverResult

- Re-exports QueryObserverResult -
-
- -

QueryObserverSuccessResult

- Re-exports QueryObserverSuccessResult -
-
- -

QueryOptions

- Re-exports QueryOptions -
-
- -

QueryStatus

- Re-exports QueryStatus -
-
- -

ReactQueryFeature

- Re-exports ReactQueryFeature -
-
- -

ReactQueryFeatureOptions

- Re-exports ReactQueryFeatureOptions -
-
- -

RefetchOptions

- Re-exports RefetchOptions -
-
- -

ResetOptions

- Re-exports ResetOptions -
-
- -

ResultOptions

- Re-exports ResultOptions -
-
- -

UseBaseQueryOptions

- Re-exports UseBaseQueryOptions -
-
- -

UseBaseQueryResult

- Re-exports UseBaseQueryResult -
-
- -

UseInfiniteQueryOptions

- Re-exports UseInfiniteQueryOptions -
-
- -

UseInfiniteQueryResult

- Re-exports UseInfiniteQueryResult -
-
- -

UseMutateAsyncFunction

- Re-exports UseMutateAsyncFunction -
-
- -

UseMutateFunction

- Re-exports UseMutateFunction -
-
- -

UseMutationOptions

- Re-exports UseMutationOptions -
-
- -

UseMutationResult

- Re-exports UseMutationResult -
-
- -

UseQueryOptions

- Re-exports UseQueryOptions -
-
- -

UseQueryResult

- Re-exports UseQueryResult -
-
- -

dehydrate

- Re-exports dehydrate -
-
- -

focusManager

- Re-exports focusManager -
-
- -

hashQueryKey

- Re-exports hashQueryKey -
-
- -

isCancelledError

- Re-exports isCancelledError -
-
- -

isError

- Re-exports isError -
-
- -

notifyManager

- Re-exports notifyManager -
-
- -

onlineManager

- Re-exports onlineManager -
-
- -

prefetchQueryMethod

- Re-exports prefetchQueryMethod -
-
- -

setLogger

- Re-exports setLogger -
-
- -

useInfiniteQuery

- Re-exports useInfiniteQuery -
-
- -

useIsFetching

- Re-exports useIsFetching -
-
- -

useIsMutating

- Re-exports useIsMutating -
-
- -

useMutation

- Re-exports useMutation -
-
- -

useQueries

- Re-exports useQueries -
-
- -

useQuery

- Re-exports useQuery -
-
- -

useQueryClient

- Re-exports useQueryClient -
-
- -

useQueryErrorResetBoundary

- Re-exports useQueryErrorResetBoundary -
-
-
-

Functions

-
- -

reactQueryFeature

- - -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Variable
    • -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +node | @xarc/react-query
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module node

Index

References

Functions

References

CancelOptions

Re-exports CancelOptions

CancelledError

Re-exports CancelledError

DefaultOptions

Re-exports DefaultOptions

DehydrateOptions

Re-exports DehydrateOptions

DehydratedState

Re-exports DehydratedState

EnsuredQueryKey

Re-exports EnsuredQueryKey

FetchInfiniteQueryOptions

Re-exports FetchInfiniteQueryOptions

FetchNextPageOptions

Re-exports FetchNextPageOptions

FetchPreviousPageOptions

Re-exports FetchPreviousPageOptions

FetchQueryOptions

Re-exports FetchQueryOptions

GetNextPageParamFunction

Re-exports GetNextPageParamFunction

GetPreviousPageParamFunction

Re-exports GetPreviousPageParamFunction

Hydrate

Re-exports Hydrate

HydrateOptions

Re-exports HydrateOptions

HydrateProps

Re-exports HydrateProps

InfiniteData

Re-exports InfiniteData

InfiniteQueryObserver

Re-exports InfiniteQueryObserver

InfiniteQueryObserverBaseResult

Re-exports InfiniteQueryObserverBaseResult

InfiniteQueryObserverIdleResult

Re-exports InfiniteQueryObserverIdleResult

InfiniteQueryObserverLoadingErrorResult

Re-exports InfiniteQueryObserverLoadingErrorResult

InfiniteQueryObserverLoadingResult

Re-exports InfiniteQueryObserverLoadingResult

InfiniteQueryObserverOptions

Re-exports InfiniteQueryObserverOptions

InfiniteQueryObserverRefetchErrorResult

Re-exports InfiniteQueryObserverRefetchErrorResult

InfiniteQueryObserverResult

Re-exports InfiniteQueryObserverResult

InfiniteQueryObserverSuccessResult

Re-exports InfiniteQueryObserverSuccessResult

InitialDataFunction

Re-exports InitialDataFunction

InvalidateOptions

Re-exports InvalidateOptions

InvalidateQueryFilters

Re-exports InvalidateQueryFilters

Logger

Re-exports Logger

MutateFunction

Re-exports MutateFunction

MutateOptions

Re-exports MutateOptions

Mutation

Re-exports Mutation

MutationCache

Re-exports MutationCache

MutationFunction

Re-exports MutationFunction

MutationKey

Re-exports MutationKey

MutationMeta

Re-exports MutationMeta

MutationObserver

Re-exports MutationObserver

MutationObserverBaseResult

Re-exports MutationObserverBaseResult

MutationObserverErrorResult

Re-exports MutationObserverErrorResult

MutationObserverIdleResult

Re-exports MutationObserverIdleResult

MutationObserverLoadingResult

Re-exports MutationObserverLoadingResult

MutationObserverOptions

Re-exports MutationObserverOptions

MutationObserverResult

Re-exports MutationObserverResult

MutationObserverSuccessResult

Re-exports MutationObserverSuccessResult

MutationOptions

Re-exports MutationOptions

MutationStatus

Re-exports MutationStatus

PlaceholderDataFunction

Re-exports PlaceholderDataFunction

PrefetchQueryServerModule

Re-exports PrefetchQueryServerModule

QueriesObserver

Re-exports QueriesObserver

QueriesOptions

Re-exports QueriesOptions

QueriesResults

Re-exports QueriesResults

Query

Re-exports Query

QueryCache

Re-exports QueryCache

QueryClient

Re-exports QueryClient

QueryClientConfig

Re-exports QueryClientConfig

QueryClientProvider

Re-exports QueryClientProvider

QueryClientProviderProps

Re-exports QueryClientProviderProps

QueryErrorResetBoundary

Re-exports QueryErrorResetBoundary

QueryErrorResetBoundaryProps

Re-exports QueryErrorResetBoundaryProps

QueryFunction

Re-exports QueryFunction

QueryFunctionContext

Re-exports QueryFunctionContext

QueryKey

Re-exports QueryKey

QueryKeyHashFunction

Re-exports QueryKeyHashFunction

QueryMeta

Re-exports QueryMeta

QueryObserver

Re-exports QueryObserver

QueryObserverBaseResult

Re-exports QueryObserverBaseResult

QueryObserverIdleResult

Re-exports QueryObserverIdleResult

QueryObserverLoadingErrorResult

Re-exports QueryObserverLoadingErrorResult

QueryObserverLoadingResult

Re-exports QueryObserverLoadingResult

QueryObserverOptions

Re-exports QueryObserverOptions

QueryObserverRefetchErrorResult

Re-exports QueryObserverRefetchErrorResult

QueryObserverResult

Re-exports QueryObserverResult

QueryObserverSuccessResult

Re-exports QueryObserverSuccessResult

QueryOptions

Re-exports QueryOptions

QueryStatus

Re-exports QueryStatus

ReactQueryFeature

Re-exports ReactQueryFeature

ReactQueryFeatureOptions

Re-exports ReactQueryFeatureOptions

RefetchOptions

Re-exports RefetchOptions

RefetchPageFilters

Re-exports RefetchPageFilters

RefetchQueryFilters

Re-exports RefetchQueryFilters

ResetOptions

Re-exports ResetOptions

ResetQueryFilters

Re-exports ResetQueryFilters

ResultOptions

Re-exports ResultOptions

SetDataOptions

Re-exports SetDataOptions

ShouldDehydrateMutationFunction

Re-exports ShouldDehydrateMutationFunction

ShouldDehydrateQueryFunction

Re-exports ShouldDehydrateQueryFunction

UseBaseMutationResult

Re-exports UseBaseMutationResult

UseBaseQueryOptions

Re-exports UseBaseQueryOptions

UseBaseQueryResult

Re-exports UseBaseQueryResult

UseInfiniteQueryOptions

Re-exports UseInfiniteQueryOptions

UseInfiniteQueryResult

Re-exports UseInfiniteQueryResult

UseMutateAsyncFunction

Re-exports UseMutateAsyncFunction

UseMutateFunction

Re-exports UseMutateFunction

UseMutationOptions

Re-exports UseMutationOptions

UseMutationResult

Re-exports UseMutationResult

UseQueryOptions

Re-exports UseQueryOptions

UseQueryResult

Re-exports UseQueryResult

dehydrate

Re-exports dehydrate

focusManager

Re-exports focusManager

hashQueryKey

Re-exports hashQueryKey

hydrate

Re-exports hydrate

isCancelledError

Re-exports isCancelledError

isError

Re-exports isError

notifyManager

Re-exports notifyManager

onlineManager

Re-exports onlineManager

prefetchQueryMethod

Re-exports prefetchQueryMethod

setLogger

Re-exports setLogger

useHydrate

Re-exports useHydrate

useInfiniteQuery

Re-exports useInfiniteQuery

useIsFetching

Re-exports useIsFetching

useIsMutating

Re-exports useIsMutating

useMutation

Re-exports useMutation

useQueries

Re-exports useQueries

useQuery

Re-exports useQuery

useQueryClient

Re-exports useQueryClient

useQueryErrorResetBoundary

Re-exports useQueryErrorResetBoundary

Functions

reactQueryFeature

Legend

  • Variable
  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-query/package.json b/packages/xarc-react-query/package.json index 77a06df9e..a97fdeabd 100644 --- a/packages/xarc-react-query/package.json +++ b/packages/xarc-react-query/package.json @@ -1,6 +1,6 @@ { "name": "@xarc/react-query", - "version": "1.0.2", + "version": "1.0.3", "description": "xarc React.js application react-query support", "main": "dist-node-cjs/node/index.js", "module": "dist-node-esm/node/index.js", diff --git a/packages/xarc-react-query/src/browser/index.tsx b/packages/xarc-react-query/src/browser/index.tsx index e37451694..be36dedb6 100644 --- a/packages/xarc-react-query/src/browser/index.tsx +++ b/packages/xarc-react-query/src/browser/index.tsx @@ -4,7 +4,6 @@ import { SubAppDef, SubAppFeatureFactory, SubAppFeature, envHooks } from "@xarc/ import { QueryClient, QueryClientProvider } from "react-query"; import { Hydrate } from "react-query/hydration"; import { featureId, featureSubId } from "../common/feature-info"; - import { ReactQueryFeature, ReactQueryFeatureOptions } from "../common"; // diff --git a/packages/xarc-react-recoil/CHANGELOG.json b/packages/xarc-react-recoil/CHANGELOG.json index 612aa839a..e1f418649 100644 --- a/packages/xarc-react-recoil/CHANGELOG.json +++ b/packages/xarc-react-recoil/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@xarc/react-recoil", "entries": [ + { + "version": "1.1.2", + "tag": "@xarc/react-recoil_v1.1.2", + "date": "Thu, 07 Sep 2023 22:19:14 GMT", + "comments": { + "patch": [ + { + "comment": "Minor change to force publish esm bundles" + } + ] + } + }, { "version": "1.1.1", "tag": "@xarc/react-recoil_v1.1.1", diff --git a/packages/xarc-react-recoil/CHANGELOG.md b/packages/xarc-react-recoil/CHANGELOG.md index 6610c24ef..210114f37 100644 --- a/packages/xarc-react-recoil/CHANGELOG.md +++ b/packages/xarc-react-recoil/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @xarc/react-recoil -This log was last generated on Tue, 29 Aug 2023 14:57:37 GMT and should not be manually modified. +This log was last generated on Thu, 07 Sep 2023 22:19:14 GMT and should not be manually modified. + +## 1.1.2 +Thu, 07 Sep 2023 22:19:14 GMT + +### Patches + +- Minor change to force publish esm bundles ## 1.1.1 Tue, 29 Aug 2023 14:57:37 GMT diff --git a/packages/xarc-react-recoil/docs/.nojekyll b/packages/xarc-react-recoil/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/packages/xarc-react-recoil/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/assets/css/main.css b/packages/xarc-react-recoil/docs/assets/css/main.css deleted file mode 100644 index 46571c27c..000000000 --- a/packages/xarc-react-recoil/docs/assets/css/main.css +++ /dev/null @@ -1,2660 +0,0 @@ -:root { - --color-background: #fdfdfd; - --color-text: #222; - --color-text-aside: #707070; - --color-link: #4da6ff; - --color-menu-divider: #eee; - --color-menu-divider-focus: #000; - --color-menu-label: #707070; - --color-panel: #fff; - --color-panel-divider: #eee; - --color-comment-tag: #707070; - --color-comment-tag-text: #fff; - --color-code-background: rgba(0, 0, 0, 0.04); - --color-ts: #9600ff; - --color-ts-interface: #647f1b; - --color-ts-enum: #937210; - --color-ts-class: #0672de; - --color-ts-private: #707070; - --color-toolbar: #fff; - --color-toolbar-text: #333; -} - -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * * HTML5 display definitions - * * ========================================================================== */ -/** - * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; -} - -/** - * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; -} - -/** - * * Prevent modern browsers from displaying `audio` without controls. - * * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * * Known issue: no IE 6 support. */ -[hidden] { - display: none; -} - -/* ========================================================================== - * * Base - * * ========================================================================== */ -/** - * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * * `em` units. - * * 2. Prevent iOS text size adjust after orientation change, without disabling - * * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; -} - -/** - * * Address `font-family` inconsistency between `textarea` and other form - * * elements. */ -button, input, select, textarea { - font-family: sans-serif; -} - -/** - * * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; -} - -/* ========================================================================== - * * Links - * * ========================================================================== */ -/** - * * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; -} -a:active, a:hover { - outline: 0; -} - -/** - * * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * * Typography - * * ========================================================================== */ -/** - * * Address font sizes and margins set differently in IE 6/7. - * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -/** - * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; -} - -blockquote { - margin: 1em 40px; -} - -/** - * * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; -} - -/** - * * Address differences between Firefox and other browsers. - * * Known issue: no IE 6/7 normalization. */ -hr { - -moz-box-sizing: content-box; - box-sizing: content-box; - height: 0; -} - -/** - * * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; -} - -/** - * * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; -} - -/** - * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: "courier new", monospace; - font-size: 1em; -} - -/** - * * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -/** - * * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; -} -q:before, q:after { - content: ""; - content: none; -} - -/** - * * Address `quotes` property not supported in Safari 4. */ -/** - * * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; -} - -/** - * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* ========================================================================== - * * Lists - * * ========================================================================== */ -/** - * * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -/** - * * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; -} - -/** - * * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; -} - -/* ========================================================================== - * * Embedded content - * * ========================================================================== */ -/** - * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; -} - -/* 2 */ -/** - * * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; -} - -/* ========================================================================== - * * Figures - * * ========================================================================== */ -/** - * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; -} - -/* ========================================================================== - * * Forms - * * ========================================================================== */ -/** - * * Correct margin displayed oddly in IE 6/7. */ -/** - * * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * * 1. Correct color not being inherited in IE 6/7/8/9. - * * 2. Correct text not wrapping in Firefox 3. - * * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; -} - -/* 3 */ -/** - * * 1. Correct font size not being inherited in all browsers. - * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * * and Chrome. - * * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; -} - -/* 3 */ -/** - * * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * * the UA stylesheet. */ -button, input { - line-height: normal; -} - -/** - * * Address inconsistent `text-transform` inheritance for `button` and `select`. - * * All other form control elements do not inherit `text-transform` values. - * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; -} - -/** - * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * * and `video` controls. - * * 2. Correct inability to style clickable `input` types in iOS. - * * 3. Improve usability and consistency of cursor style between image-type - * * `input` and others. - * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * * Known issue: inner spacing remains in IE 6. */ -button, html input[type=button] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -input[type=reset], input[type=submit] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -/** - * * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; -} - -/** - * * 1. Address box sizing set to content-box in IE 8/9. - * * 2. Remove excess padding in IE 8/9. - * * 3. Remove excess padding in IE 7. - * * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ -} -input[type=checkbox], input[type=radio] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; -} -input[type=search] { - -webkit-appearance: textfield; - /* 1 */ - -moz-box-sizing: content-box; - -webkit-box-sizing: content-box; - /* 2 */ - box-sizing: content-box; -} -input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * * (include `-moz` to future-proof). */ -/** - * * Remove inner padding and search cancel button in Safari 5 and Chrome - * * on OS X. */ -/** - * * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; -} - -/* 2 */ -/* ========================================================================== - * * Tables - * * ========================================================================== */ -/** - * * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; -} - -ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-1 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-1 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-1 { - width: 8.3333333333%; -} - -.offset-1 { - margin-left: 8.3333333333%; -} - -.col-2 { - width: 16.6666666667%; -} - -.offset-2 { - margin-left: 16.6666666667%; -} - -.col-3 { - width: 25%; -} - -.offset-3 { - margin-left: 25%; -} - -.col-4 { - width: 33.3333333333%; -} - -.offset-4 { - margin-left: 33.3333333333%; -} - -.col-5 { - width: 41.6666666667%; -} - -.offset-5 { - margin-left: 41.6666666667%; -} - -.col-6 { - width: 50%; -} - -.offset-6 { - margin-left: 50%; -} - -.col-7 { - width: 58.3333333333%; -} - -.offset-7 { - margin-left: 58.3333333333%; -} - -.col-8 { - width: 66.6666666667%; -} - -.offset-8 { - margin-left: 66.6666666667%; -} - -.col-9 { - width: 75%; -} - -.offset-9 { - margin-left: 75%; -} - -.col-10 { - width: 83.3333333333%; -} - -.offset-10 { - margin-left: 83.3333333333%; -} - -.col-11 { - width: 91.6666666667%; -} - -.offset-11 { - margin-left: 91.6666666667%; -} - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: var(--color-code-background); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, .tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; - } - html.default .col-menu { - width: 28%; - } - html.default .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; - } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html.default .col-menu > *:last-child { - padding-bottom: 20px; - } - html.default .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; - } - html.default.to-has-menu header, -html.default.to-has-menu footer, -html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; - } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; - } - html.default.from-has-menu header, -html.default.from-has-menu footer, -html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; - } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - html.default.has-menu body { - overflow: hidden; - } - html.default.has-menu .overlay { - visibility: visible; - } - html.default.has-menu header, -html.default.has-menu footer, -html.default.has-menu .col-content { - transform: translate(-25%, 0); - } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -html.minimal .container { - margin: 0; -} -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; -} -html.minimal .content-wrap { - padding-left: 300px; -} -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; -} -html.minimal .tsd-member .tsd-member { - margin-left: 0; -} -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; -} -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; -} -html.minimal footer { - background-color: transparent; -} -html.minimal footer .container { - padding: 0; -} -html.minimal .tsd-generator { - padding: 0; -} -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; - } - html.minimal .content-wrap { - padding-left: 0; - } -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, -#tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member a[data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member a[data-tsd-kind=Interface] { - color: var(--color-ts-interface); -} -.tsd-member a[data-tsd-kind=Enum] { - color: var(--color-ts-enum); -} -.tsd-member a[data-tsd-kind=Class] { - color: var(--color-ts-class); -} -.tsd-member a[data-tsd-kind=Private] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; -} -.tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; -} -.tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, .tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.8; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, .tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; - } -} -input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; -} -input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} diff --git a/packages/xarc-react-recoil/docs/assets/highlight.css b/packages/xarc-react-recoil/docs/assets/highlight.css new file mode 100644 index 000000000..6dd4eef7e --- /dev/null +++ b/packages/xarc-react-recoil/docs/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +body.light { + --code-background: var(--light-code-background); +} + +body.dark { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/packages/xarc-react-recoil/docs/assets/icons.css b/packages/xarc-react-recoil/docs/assets/icons.css new file mode 100644 index 000000000..776a3562d --- /dev/null +++ b/packages/xarc-react-recoil/docs/assets/icons.css @@ -0,0 +1,1043 @@ +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(./icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(./icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -187px; +} diff --git a/packages/xarc-react-recoil/docs/assets/images/icons.png b/packages/xarc-react-recoil/docs/assets/icons.png similarity index 100% rename from packages/xarc-react-recoil/docs/assets/images/icons.png rename to packages/xarc-react-recoil/docs/assets/icons.png diff --git a/packages/xarc-react-recoil/docs/assets/images/icons@2x.png b/packages/xarc-react-recoil/docs/assets/icons@2x.png similarity index 100% rename from packages/xarc-react-recoil/docs/assets/images/icons@2x.png rename to packages/xarc-react-recoil/docs/assets/icons@2x.png diff --git a/packages/xarc-react-recoil/docs/assets/js/main.js b/packages/xarc-react-recoil/docs/assets/js/main.js deleted file mode 100644 index dc257a868..000000000 --- a/packages/xarc-react-recoil/docs/assets/js/main.js +++ /dev/null @@ -1,248 +0,0 @@ -/* - * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). - * This devtool is not neither made for production nor for readable output files. - * It uses "eval()" calls to create a separate source file in the browser devtools. - * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) - * or disable the default devtool with "devtool: false". - * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). - */ -/******/ (() => { // webpackBootstrap -/******/ var __webpack_modules__ = ({ - -/***/ "../node_modules/lunr/lunr.js": -/*!************************************!*\ - !*** ../node_modules/lunr/lunr.js ***! - \************************************/ -/***/ ((module, exports, __webpack_require__) => { - -eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); - -/***/ }), - -/***/ "./default/assets/css/main.sass": -/*!**************************************!*\ - !*** ./default/assets/css/main.sass ***! - \**************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); - -/***/ }), - -/***/ "./default/assets/js/src/bootstrap.ts": -/*!********************************************!*\ - !*** ./default/assets/js/src/bootstrap.ts ***! - \********************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Application.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/Application.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Component.ts": -/*!****************************************************!*\ - !*** ./default/assets/js/src/typedoc/Component.ts ***! - \****************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/EventTarget.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Filter.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": -/*!*******************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! - \*******************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Search.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Search.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Signature.ts": -/*!***************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! - \***************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": -/*!*********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! - \*********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); - -/***/ }) - -/******/ }); -/************************************************************************/ -/******/ // The module cache -/******/ var __webpack_module_cache__ = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ // Check if module is in cache -/******/ if(__webpack_module_cache__[moduleId]) { -/******/ return __webpack_module_cache__[moduleId].exports; -/******/ } -/******/ // Create a new module (and put it into the cache) -/******/ var module = __webpack_module_cache__[moduleId] = { -/******/ // no module.id needed -/******/ // no module.loaded needed -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/************************************************************************/ -/******/ /* webpack/runtime/compat get default export */ -/******/ (() => { -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = (module) => { -/******/ var getter = module && module.__esModule ? -/******/ () => module['default'] : -/******/ () => module; -/******/ __webpack_require__.d(getter, { a: getter }); -/******/ return getter; -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/define property getters */ -/******/ (() => { -/******/ // define getter functions for harmony exports -/******/ __webpack_require__.d = (exports, definition) => { -/******/ for(var key in definition) { -/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { -/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); -/******/ } -/******/ } -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/hasOwnProperty shorthand */ -/******/ (() => { -/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) -/******/ })(); -/******/ -/******/ /* webpack/runtime/make namespace object */ -/******/ (() => { -/******/ // define __esModule on exports -/******/ __webpack_require__.r = (exports) => { -/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { -/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); -/******/ } -/******/ Object.defineProperty(exports, '__esModule', { value: true }); -/******/ }; -/******/ })(); -/******/ -/************************************************************************/ -/******/ // startup -/******/ // Load entry module -/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); -/******/ // This entry module used 'exports' so it can't be inlined -/******/ })() -; \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/assets/js/search.js b/packages/xarc-react-recoil/docs/assets/js/search.js deleted file mode 100644 index 2cf974949..000000000 --- a/packages/xarc-react-recoil/docs/assets/js/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = {"kinds":{"1":"Module","64":"Function","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":1,"name":"browser","url":"modules/browser.html","classes":"tsd-kind-module"},{"id":1,"kind":1,"name":"common","url":"modules/common.html","classes":"tsd-kind-module"},{"id":2,"kind":64,"name":"recoilFeature","url":"modules/common.html#recoilfeature-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"common"},{"id":3,"kind":4194304,"name":"RecoilFeatureOptions","url":"modules/common.html#recoilfeatureoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":4,"kind":65536,"name":"__type","url":"modules/common.html#recoilfeatureoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"common.RecoilFeatureOptions"},{"id":5,"kind":1024,"name":"React","url":"modules/common.html#recoilfeatureoptions.__type.react","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.RecoilFeatureOptions.__type"},{"id":6,"kind":2048,"name":"prepare","url":"modules/common.html#recoilfeatureoptions.__type.prepare","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"common.RecoilFeatureOptions.__type"},{"id":7,"kind":4194304,"name":"RecoilFeature","url":"modules/common.html#recoilfeature","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":8,"kind":1,"name":"node","url":"modules/node.html","classes":"tsd-kind-module"},{"id":9,"kind":16777216,"name":"recoilFeature","url":"modules/browser.html#recoilfeature-1","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":10,"kind":16777216,"name":"RecoilFeatureOptions","url":"modules/browser.html#recoilfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":11,"kind":16777216,"name":"RecoilFeature","url":"modules/browser.html#recoilfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":12,"kind":16777216,"name":"Recoil","url":"modules/common.html#recoil","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":13,"kind":16777216,"name":"recoilFeature","url":"modules/node.html#recoilfeature-1","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":14,"kind":16777216,"name":"Recoil","url":"modules/node.html#recoil","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":15,"kind":16777216,"name":"RecoilFeatureOptions","url":"modules/node.html#recoilfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":16,"kind":16777216,"name":"RecoilFeature","url":"modules/node.html#recoilfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,13.863]],["parent/0",[]],["name/1",[1,11.856]],["parent/1",[]],["name/2",[2,10.186]],["parent/2",[1,1.09]],["name/3",[3,16.376]],["parent/3",[1,1.09]],["name/4",[4,24.849]],["parent/4",[5,2.285]],["name/5",[6,24.849]],["parent/5",[7,1.815]],["name/6",[8,24.849]],["parent/6",[7,1.815]],["name/7",[2,10.186]],["parent/7",[1,1.09]],["name/8",[9,11.856]],["parent/8",[]],["name/9",[2,10.186]],["parent/9",[0,1.275]],["name/10",[3,16.376]],["parent/10",[0,1.275]],["name/11",[2,10.186]],["parent/11",[0,1.275]],["name/12",[10,19.741]],["parent/12",[1,1.09]],["name/13",[2,10.186]],["parent/13",[9,1.09]],["name/14",[10,19.741]],["parent/14",[9,1.09]],["name/15",[3,16.376]],["parent/15",[9,1.09]],["name/16",[2,10.186]],["parent/16",[9,1.09]]],"invertedIndex":[["__type",{"_index":4,"name":{"4":{}},"parent":{}}],["browser",{"_index":0,"name":{"0":{}},"parent":{"9":{},"10":{},"11":{}}}],["common",{"_index":1,"name":{"1":{}},"parent":{"2":{},"3":{},"7":{},"12":{}}}],["common.recoilfeatureoptions",{"_index":5,"name":{},"parent":{"4":{}}}],["common.recoilfeatureoptions.__type",{"_index":7,"name":{},"parent":{"5":{},"6":{}}}],["node",{"_index":9,"name":{"8":{}},"parent":{"13":{},"14":{},"15":{},"16":{}}}],["prepare",{"_index":8,"name":{"6":{}},"parent":{}}],["react",{"_index":6,"name":{"5":{}},"parent":{}}],["recoil",{"_index":10,"name":{"12":{},"14":{}},"parent":{}}],["recoilfeature",{"_index":2,"name":{"2":{},"7":{},"9":{},"11":{},"13":{},"16":{}},"parent":{}}],["recoilfeatureoptions",{"_index":3,"name":{"3":{},"10":{},"15":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/assets/main.js b/packages/xarc-react-recoil/docs/assets/main.js new file mode 100644 index 000000000..bd45452db --- /dev/null +++ b/packages/xarc-react-recoil/docs/assets/main.js @@ -0,0 +1,52 @@ +(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,u],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/packages/xarc-react-recoil/docs/assets/search.js b/packages/xarc-react-recoil/docs/assets/search.js new file mode 100644 index 000000000..531f22d49 --- /dev/null +++ b/packages/xarc-react-recoil/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"64\":\"Function\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\",\"16777216\":\"Reference\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"browser\",\"url\":\"modules/browser.html\",\"classes\":\"tsd-kind-module\"},{\"id\":1,\"kind\":2,\"name\":\"common\",\"url\":\"modules/common.html\",\"classes\":\"tsd-kind-module\"},{\"id\":2,\"kind\":64,\"name\":\"recoilFeature\",\"url\":\"modules/common.html#recoilFeature\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":3,\"kind\":4194304,\"name\":\"RecoilFeatureOptions\",\"url\":\"modules/common.html#RecoilFeatureOptions\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":4,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/common.html#RecoilFeatureOptions.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"common.RecoilFeatureOptions\"},{\"id\":5,\"kind\":1024,\"name\":\"React\",\"url\":\"modules/common.html#RecoilFeatureOptions.__type.React\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.RecoilFeatureOptions.__type\"},{\"id\":6,\"kind\":2048,\"name\":\"prepare\",\"url\":\"modules/common.html#RecoilFeatureOptions.__type.prepare\",\"classes\":\"tsd-kind-method tsd-parent-kind-type-literal\",\"parent\":\"common.RecoilFeatureOptions.__type\"},{\"id\":7,\"kind\":4194304,\"name\":\"RecoilFeature\",\"url\":\"modules/common.html#RecoilFeature\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":8,\"kind\":2,\"name\":\"node\",\"url\":\"modules/node.html\",\"classes\":\"tsd-kind-module\"},{\"id\":9,\"kind\":16777216,\"name\":\"recoilFeature\",\"url\":\"modules/browser.html#recoilFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":10,\"kind\":16777216,\"name\":\"RecoilFeatureOptions\",\"url\":\"modules/browser.html#RecoilFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":11,\"kind\":16777216,\"name\":\"RecoilFeature\",\"url\":\"modules/browser.html#RecoilFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":12,\"kind\":16777216,\"name\":\"Recoil\",\"url\":\"modules/common.html#Recoil\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":13,\"kind\":16777216,\"name\":\"recoilFeature\",\"url\":\"modules/node.html#recoilFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":14,\"kind\":16777216,\"name\":\"Recoil\",\"url\":\"modules/node.html#Recoil\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":15,\"kind\":16777216,\"name\":\"RecoilFeatureOptions\",\"url\":\"modules/node.html#RecoilFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":16,\"kind\":16777216,\"name\":\"RecoilFeature\",\"url\":\"modules/node.html#RecoilFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,13.863]],[\"parent/0\",[]],[\"name/1\",[1,11.856]],[\"parent/1\",[]],[\"name/2\",[2,10.186]],[\"parent/2\",[1,1.09]],[\"name/3\",[3,16.376]],[\"parent/3\",[1,1.09]],[\"name/4\",[4,24.849]],[\"parent/4\",[5,2.285]],[\"name/5\",[6,24.849]],[\"parent/5\",[7,1.815]],[\"name/6\",[8,24.849]],[\"parent/6\",[7,1.815]],[\"name/7\",[2,10.186]],[\"parent/7\",[1,1.09]],[\"name/8\",[9,11.856]],[\"parent/8\",[]],[\"name/9\",[2,10.186]],[\"parent/9\",[0,1.275]],[\"name/10\",[3,16.376]],[\"parent/10\",[0,1.275]],[\"name/11\",[2,10.186]],[\"parent/11\",[0,1.275]],[\"name/12\",[10,19.741]],[\"parent/12\",[1,1.09]],[\"name/13\",[2,10.186]],[\"parent/13\",[9,1.09]],[\"name/14\",[10,19.741]],[\"parent/14\",[9,1.09]],[\"name/15\",[3,16.376]],[\"parent/15\",[9,1.09]],[\"name/16\",[2,10.186]],[\"parent/16\",[9,1.09]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}],[\"browser\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"9\":{},\"10\":{},\"11\":{}}}],[\"common\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{\"2\":{},\"3\":{},\"7\":{},\"12\":{}}}],[\"common.recoilfeatureoptions\",{\"_index\":5,\"name\":{},\"parent\":{\"4\":{}}}],[\"common.recoilfeatureoptions.__type\",{\"_index\":7,\"name\":{},\"parent\":{\"5\":{},\"6\":{}}}],[\"node\",{\"_index\":9,\"name\":{\"8\":{}},\"parent\":{\"13\":{},\"14\":{},\"15\":{},\"16\":{}}}],[\"prepare\",{\"_index\":8,\"name\":{\"6\":{}},\"parent\":{}}],[\"react\",{\"_index\":6,\"name\":{\"5\":{}},\"parent\":{}}],[\"recoil\",{\"_index\":10,\"name\":{\"12\":{},\"14\":{}},\"parent\":{}}],[\"recoilfeature\",{\"_index\":2,\"name\":{\"2\":{},\"7\":{},\"9\":{},\"11\":{},\"13\":{},\"16\":{}},\"parent\":{}}],[\"recoilfeatureoptions\",{\"_index\":3,\"name\":{\"3\":{},\"10\":{},\"15\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/assets/style.css b/packages/xarc-react-recoil/docs/assets/style.css new file mode 100644 index 000000000..6127b27cd --- /dev/null +++ b/packages/xarc-react-recoil/docs/assets/style.css @@ -0,0 +1,1414 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/packages/xarc-react-recoil/docs/assets/images/widgets.png b/packages/xarc-react-recoil/docs/assets/widgets.png similarity index 100% rename from packages/xarc-react-recoil/docs/assets/images/widgets.png rename to packages/xarc-react-recoil/docs/assets/widgets.png diff --git a/packages/xarc-react-recoil/docs/assets/images/widgets@2x.png b/packages/xarc-react-recoil/docs/assets/widgets@2x.png similarity index 100% rename from packages/xarc-react-recoil/docs/assets/images/widgets@2x.png rename to packages/xarc-react-recoil/docs/assets/widgets@2x.png diff --git a/packages/xarc-react-recoil/docs/classes/browser.recoil.defaultvalue.html b/packages/xarc-react-recoil/docs/classes/browser.recoil.defaultvalue.html index e72d39500..93ff9f670 100644 --- a/packages/xarc-react-recoil/docs/classes/browser.recoil.defaultvalue.html +++ b/packages/xarc-react-recoil/docs/classes/browser.recoil.defaultvalue.html @@ -1,179 +1 @@ - - - - - - DefaultValue | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class DefaultValue

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - DefaultValue -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Private __tag

-
__tag: "DefaultValue"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +DefaultValue | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefaultValue

Hierarchy

  • DefaultValue

Index

Constructors

Properties

Constructors

constructor

Properties

Private __tag

__tag: "DefaultValue"

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/classes/browser.recoil.mutablesnapshot.html b/packages/xarc-react-recoil/docs/classes/browser.recoil.mutablesnapshot.html index 3a216d759..3008e5e17 100644 --- a/packages/xarc-react-recoil/docs/classes/browser.recoil.mutablesnapshot.html +++ b/packages/xarc-react-recoil/docs/classes/browser.recoil.mutablesnapshot.html @@ -1,484 +1 @@ - - - - - - MutableSnapshot | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class MutableSnapshot

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Snapshot -
      -
    • - MutableSnapshot -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

reset

-
reset: ResetRecoilState
- -
-
- -

set

-
set: SetRecoilState
- -
-
-
-

Methods

-
- -

asyncMap

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<Snapshot>

    -
    • -
-
-
- -

getID

- -
    -
  • - -

    Returns SnapshotID

    -
    • -
-
-
- -

getInfo_UNSTABLE

-
    -
  • getInfo_UNSTABLE<T>(recoilValue: RecoilValue<T>): { deps: Iterable<RecoilValue<T>>; isActive: boolean; isModified: boolean; isSet: boolean; loadable?: Loadable<T>; subscribers: { nodes: Iterable<RecoilValue<T>> }; type: "atom" | "selector" }
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns { deps: Iterable<RecoilValue<T>>; isActive: boolean; isModified: boolean; isSet: boolean; loadable?: Loadable<T>; subscribers: { nodes: Iterable<RecoilValue<T>> }; type: "atom" | "selector" }

    -
      -
    • -
      deps: Iterable<RecoilValue<T>>
      -
      • -
    • -
      isActive: boolean
      -
      • -
    • -
      isModified: boolean
      -
      • -
    • -
      isSet: boolean
      -
      • -
    • -
      Optional loadable?: Loadable<T>
      -
      • -
    • -
      subscribers: { nodes: Iterable<RecoilValue<T>> }
      - -
      • -
    • -
      type: "atom" | "selector"
      -
      • -
    -
    • -
-
-
- -

getLoadable

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns Loadable<T>

    -
    • -
-
-
- -

getNodes_UNSTABLE

-
    -
  • getNodes_UNSTABLE(opts?: { isModified?: boolean }): Iterable<RecoilValue<unknown>>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional opts: { isModified?: boolean }
      -
        -
      • -
        Optional isModified?: boolean
        -
        • -
      -
      • -
    -

    Returns Iterable<RecoilValue<unknown>>

    -
    • -
-
-
- -

getPromise

-
    -
  • getPromise<T>(recoilValue: RecoilValue<T>): Promise<T>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns Promise<T>

    -
    • -
-
-
- -

map

- -
    -
  • - -

    Parameters

    - -

    Returns Snapshot

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +MutableSnapshot | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutableSnapshot

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

reset

reset: ResetRecoilState

set

set: SetRecoilState

Methods

asyncMap

  • Parameters

    Returns Promise<Snapshot>

getID

  • Returns SnapshotID

getInfo_UNSTABLE

  • getInfo_UNSTABLE<T>(recoilValue: RecoilValue<T>): RecoilStateInfo<T>

  • Type Parameters

    • T

    Parameters

    Returns RecoilStateInfo<T>

getLoadable

  • Type Parameters

    • T

    Parameters

    Returns Loadable<T>

getNodes_UNSTABLE

  • getNodes_UNSTABLE(opts?: { isInitialized?: boolean; isModified?: boolean }): Iterable<RecoilValue<unknown>>

  • Parameters

    • Optional opts: { isInitialized?: boolean; isModified?: boolean }
      • Optional isInitialized?: boolean
      • Optional isModified?: boolean

    Returns Iterable<RecoilValue<unknown>>

getPromise

  • Type Parameters

    • T

    Parameters

    Returns Promise<T>

isRetained

  • isRetained(): boolean

  • Returns boolean

map

retain

  • retain(): (() => void)

  • Returns (() => void)

      • (): void

      • Returns void

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilstate.html b/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilstate.html index a6c1f27c8..97e7f2467 100644 --- a/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilstate.html +++ b/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilstate.html @@ -1,260 +1 @@ - - - - - - RecoilState | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class RecoilState<T>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
-

Hierarchy

-
    -
  • - AbstractRecoilValue<T> -
      -
    • - RecoilState -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new RecoilState<T>(newKey: string): RecoilState<T>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    -
      -
    • -
      newKey: string
      -
      • -
    -

    Returns RecoilState<T>

    -
    • -
-
-
-
-

Properties

-
- -

__cTag

-
__cTag: (t: T) => void
- -
-

Type declaration

-
    -
  • -
      -
    • (t: T): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        t: T
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

__tag

-
__tag: [T]
- -
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +RecoilState | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecoilState<T>

Type Parameters

  • T

Hierarchy

  • AbstractRecoilValue<T>
    • RecoilState

Index

Constructors

Properties

Methods

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • newKey: string

    Returns RecoilState<T>

Properties

__cTag

__cTag: ((t: T) => void)

Type declaration

    • (t: T): void

    • Parameters

      • t: T

      Returns void

__tag

__tag: [T]

key

key: string

Methods

toJSON

  • toJSON(): { key: string }

  • Returns { key: string }

    • key: string

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilvaluereadonly.html b/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilvaluereadonly.html index 4fd3b734e..f8f963233 100644 --- a/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilvaluereadonly.html +++ b/packages/xarc-react-recoil/docs/classes/browser.recoil.recoilvaluereadonly.html @@ -1,224 +1 @@ - - - - - - RecoilValueReadOnly | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class RecoilValueReadOnly<T>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
-

Hierarchy

-
    -
  • - AbstractRecoilValueReadonly<T> -
      -
    • - RecoilValueReadOnly -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    -
      -
    • -
      newKey: string
      -
      • -
    -

    Returns RecoilValueReadOnly<T>

    -
    • -
-
-
-
-

Properties

-
- -

__tag

-
__tag: [T]
- -
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +RecoilValueReadOnly | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecoilValueReadOnly<T>

Type Parameters

  • T

Hierarchy

  • AbstractRecoilValueReadonly<T>
    • RecoilValueReadOnly

Index

Constructors

Properties

Methods

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • newKey: string

    Returns RecoilValueReadOnly<T>

Properties

__tag

__tag: [T]

key

key: string

Methods

toJSON

  • toJSON(): { key: string }

  • Returns { key: string }

    • key: string

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/classes/browser.recoil.snapshot.html b/packages/xarc-react-recoil/docs/classes/browser.recoil.snapshot.html index ab9e0bc65..ae1e017d0 100644 --- a/packages/xarc-react-recoil/docs/classes/browser.recoil.snapshot.html +++ b/packages/xarc-react-recoil/docs/classes/browser.recoil.snapshot.html @@ -1,440 +1 @@ - - - - - - Snapshot | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Class Snapshot

-
-
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Methods

-
- -

asyncMap

- -
    -
  • - -

    Parameters

    - -

    Returns Promise<Snapshot>

    -
    • -
-
-
- -

getID

- -
    -
  • - -

    Returns SnapshotID

    -
    • -
-
-
- -

getInfo_UNSTABLE

-
    -
  • getInfo_UNSTABLE<T>(recoilValue: RecoilValue<T>): { deps: Iterable<RecoilValue<T>>; isActive: boolean; isModified: boolean; isSet: boolean; loadable?: Loadable<T>; subscribers: { nodes: Iterable<RecoilValue<T>> }; type: "atom" | "selector" }
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns { deps: Iterable<RecoilValue<T>>; isActive: boolean; isModified: boolean; isSet: boolean; loadable?: Loadable<T>; subscribers: { nodes: Iterable<RecoilValue<T>> }; type: "atom" | "selector" }

    -
      -
    • -
      deps: Iterable<RecoilValue<T>>
      -
      • -
    • -
      isActive: boolean
      -
      • -
    • -
      isModified: boolean
      -
      • -
    • -
      isSet: boolean
      -
      • -
    • -
      Optional loadable?: Loadable<T>
      -
      • -
    • -
      subscribers: { nodes: Iterable<RecoilValue<T>> }
      - -
      • -
    • -
      type: "atom" | "selector"
      -
      • -
    -
    • -
-
-
- -

getLoadable

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns Loadable<T>

    -
    • -
-
-
- -

getNodes_UNSTABLE

-
    -
  • getNodes_UNSTABLE(opts?: { isModified?: boolean }): Iterable<RecoilValue<unknown>>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional opts: { isModified?: boolean }
      -
        -
      • -
        Optional isModified?: boolean
        -
        • -
      -
      • -
    -

    Returns Iterable<RecoilValue<unknown>>

    -
    • -
-
-
- -

getPromise

-
    -
  • getPromise<T>(recoilValue: RecoilValue<T>): Promise<T>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns Promise<T>

    -
    • -
-
-
- -

map

- -
    -
  • - -

    Parameters

    - -

    Returns Snapshot

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +Snapshot | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Snapshot

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

asyncMap

  • Parameters

    Returns Promise<Snapshot>

getID

  • Returns SnapshotID

getInfo_UNSTABLE

  • getInfo_UNSTABLE<T>(recoilValue: RecoilValue<T>): RecoilStateInfo<T>

  • Type Parameters

    • T

    Parameters

    Returns RecoilStateInfo<T>

getLoadable

  • Type Parameters

    • T

    Parameters

    Returns Loadable<T>

getNodes_UNSTABLE

  • getNodes_UNSTABLE(opts?: { isInitialized?: boolean; isModified?: boolean }): Iterable<RecoilValue<unknown>>

  • Parameters

    • Optional opts: { isInitialized?: boolean; isModified?: boolean }
      • Optional isInitialized?: boolean
      • Optional isModified?: boolean

    Returns Iterable<RecoilValue<unknown>>

getPromise

  • Type Parameters

    • T

    Parameters

    Returns Promise<T>

isRetained

  • isRetained(): boolean

  • Returns boolean

map

  • Parameters

    Returns Snapshot

retain

  • retain(): (() => void)

  • Returns (() => void)

      • (): void

      • Returns void

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/index.html b/packages/xarc-react-recoil/docs/index.html index 65d9b771a..1e7868901 100644 --- a/packages/xarc-react-recoil/docs/index.html +++ b/packages/xarc-react-recoil/docs/index.html @@ -1,108 +1,6 @@ - - - - - - @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
-

@xarc/react-recoil

-
-
-
-
-
-
-
- -

@xarc/react-recoil

- -

This module is part of the Electrode X React Web App platform for using [Recoil] in version 2 of its SubApp design.

-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +@xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

@xarc/react-recoil

+ +

@xarc/react-recoil

+ +

This module is part of the Electrode X React Web App platform for using [Recoil] in version 2 of its SubApp design.

+

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.CallbackInterface.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.CallbackInterface.html new file mode 100644 index 000000000..55672797f --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.CallbackInterface.html @@ -0,0 +1 @@ +CallbackInterface | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CallbackInterface

Hierarchy

Index

Properties

Methods

Properties

snapshot

snapshot: Snapshot

Methods

gotoSnapshot

  • Parameters

    Returns void

refresh

  • Parameters

    Returns void

reset

  • Parameters

    Returns void

set

  • set<T>(recoilVal: RecoilState<T>, valOrUpdater: T | ((currVal: T) => T)): void

  • Type Parameters

    • T

    Parameters

    • recoilVal: RecoilState<T>
    • valOrUpdater: T | ((currVal: T) => T)

    Returns void

transact_UNSTABLE

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.RecoilEnv.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.RecoilEnv.html new file mode 100644 index 000000000..23d214283 --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.RecoilEnv.html @@ -0,0 +1 @@ +RecoilEnv | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RecoilEnv

Hierarchy

  • RecoilEnv

Index

Properties

Properties

RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED

RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED: boolean

RECOIL_GKS_ENABLED

RECOIL_GKS_ENABLED: Set<string>

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.SelectorCallbackInterface.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.SelectorCallbackInterface.html new file mode 100644 index 000000000..29125db28 --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.SelectorCallbackInterface.html @@ -0,0 +1 @@ +SelectorCallbackInterface | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SelectorCallbackInterface

Hierarchy

Index

Properties

Methods

Properties

node

node: RecoilState<unknown>

snapshot

snapshot: Snapshot

Methods

gotoSnapshot

  • Parameters

    Returns void

refresh

  • Parameters

    Returns void

reset

  • Parameters

    Returns void

set

  • set<T>(recoilVal: RecoilState<T>, valOrUpdater: T | ((currVal: T) => T)): void

  • Type Parameters

    • T

    Parameters

    • recoilVal: RecoilState<T>
    • valOrUpdater: T | ((currVal: T) => T)

    Returns void

transact_UNSTABLE

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.StoreID.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.StoreID.html new file mode 100644 index 000000000..c4ea9b1a2 --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.StoreID.html @@ -0,0 +1 @@ +StoreID | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StoreID

Hierarchy

  • StoreID

Index

Properties

Properties

Readonly [StoreID_OPAQUE]

[StoreID_OPAQUE]: true

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.TransactionInterface_UNSTABLE.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.TransactionInterface_UNSTABLE.html new file mode 100644 index 000000000..ea09d0c87 --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.TransactionInterface_UNSTABLE.html @@ -0,0 +1 @@ +TransactionInterface_UNSTABLE | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionInterface_UNSTABLE

Hierarchy

  • TransactionInterface_UNSTABLE

Index

Methods

Methods

get

  • Type Parameters

    • T

    Parameters

    Returns T

reset

  • Parameters

    Returns void

set

  • set<T>(s: RecoilState<T>, u: T | ((currVal: T) => T)): void

  • Type Parameters

    • T

    Parameters

    Returns void

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.WrappedValue.html b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.WrappedValue.html new file mode 100644 index 000000000..737e3801c --- /dev/null +++ b/packages/xarc-react-recoil/docs/interfaces/browser.Recoil.WrappedValue.html @@ -0,0 +1 @@ +WrappedValue | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WrappedValue<T>

Type Parameters

  • T

Hierarchy

  • WrappedValue

Index

Properties

Properties

Readonly [WrappedValue_OPAQUE]

[WrappedValue_OPAQUE]: true

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomfamilyoptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomfamilyoptions.html deleted file mode 100644 index 351379753..000000000 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomfamilyoptions.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - AtomFamilyOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface AtomFamilyOptions<T, P>

-
-
-
-
-
-
-
-

Type parameters

- -
-
-

Hierarchy

-
    -
  • - AtomFamilyOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

default

-
default: T | RecoilValue<T> | Promise<T> | ((param: P) => T | RecoilValue<T> | Promise<T>)
- -
-
- -

Optional effects_UNSTABLE

-
effects_UNSTABLE: readonly AtomEffect<T>[] | ((param: P) => readonly AtomEffect<T>[])
- -
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomoptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomoptions.html deleted file mode 100644 index 660cf56f5..000000000 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.atomoptions.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - AtomOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface AtomOptions<T>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
-

Hierarchy

-
    -
  • - AtomOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

default

-
default: T | RecoilValue<T> | Promise<T>
- -
-
- -

Optional effects_UNSTABLE

-
effects_UNSTABLE: readonly AtomEffect<T>[]
- -
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectorfamilyoptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectorfamilyoptions.html index da9e168d5..220263ea6 100644 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectorfamilyoptions.html +++ b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectorfamilyoptions.html @@ -1,236 +1 @@ - - - - - - ReadOnlySelectorFamilyOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ReadOnlySelectorFamilyOptions<T, P>

-
-
-
-
-
-
-
-

Type parameters

- -
-
-

Hierarchy

-
    -
  • - ReadOnlySelectorFamilyOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

get

-
get: (param: P) => (opts: { get: GetRecoilValue }) => T | Promise<T> | RecoilValue<T>
- -
-

Type declaration

- -
-
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ReadOnlySelectorFamilyOptions | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadOnlySelectorFamilyOptions<T, P>

Type Parameters

Hierarchy

  • ReadOnlySelectorFamilyOptions

Index

Properties

Methods

Properties

Optional cachePolicy_UNSTABLE

cachePolicy_UNSTABLE?: CachePolicyWithoutEquality

Optional dangerouslyAllowMutability

dangerouslyAllowMutability?: boolean

key

key: string

Methods

get

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectoroptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectoroptions.html index 518536e55..e3e8a6d3a 100644 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectoroptions.html +++ b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readonlyselectoroptions.html @@ -1,220 +1 @@ - - - - - - ReadOnlySelectorOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ReadOnlySelectorOptions<T>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

get

-
get: (opts: { get: GetRecoilValue }) => T | Promise<T> | RecoilValue<T>
- -
-

Type declaration

- -
-
-
- -

key

-
key: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ReadOnlySelectorOptions | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadOnlySelectorOptions<T>

Type Parameters

  • T

Hierarchy

Index

Properties

Methods

Properties

Optional cachePolicy_UNSTABLE

cachePolicy_UNSTABLE?: CachePolicyWithoutEquality

Optional dangerouslyAllowMutability

dangerouslyAllowMutability?: boolean

key

key: string

Methods

get

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectorfamilyoptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectorfamilyoptions.html index e3fae79e9..6ec67cfd1 100644 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectorfamilyoptions.html +++ b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectorfamilyoptions.html @@ -1,303 +1 @@ - - - - - - ReadWriteSelectorFamilyOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ReadWriteSelectorFamilyOptions<T, P>

-
-
-
-
-
-
-
-

Type parameters

- -
-
-

Hierarchy

-
    -
  • - ReadWriteSelectorFamilyOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

get

-
get: (param: P) => (opts: { get: GetRecoilValue }) => T | Promise<T> | RecoilValue<T>
- -
-

Type declaration

- -
-
-
- -

key

-
key: string
- -
-
- -

set

-
set: (param: P) => (opts: { get: GetRecoilValue; reset: ResetRecoilState; set: SetRecoilState }, newValue: T | DefaultValue) => void
- -
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ReadWriteSelectorFamilyOptions | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadWriteSelectorFamilyOptions<T, P>

Type Parameters

Hierarchy

  • ReadWriteSelectorFamilyOptions

Index

Properties

Methods

Properties

Optional cachePolicy_UNSTABLE

cachePolicy_UNSTABLE?: CachePolicyWithoutEquality

Optional dangerouslyAllowMutability

dangerouslyAllowMutability?: boolean

key

key: string

Methods

get

set

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectoroptions.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectoroptions.html index 657e3b4b2..9caf77e3a 100644 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectoroptions.html +++ b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.readwriteselectoroptions.html @@ -1,272 +1 @@ - - - - - - ReadWriteSelectorOptions | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ReadWriteSelectorOptions<T>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional dangerouslyAllowMutability

-
dangerouslyAllowMutability: boolean
- -
-
- -

get

-
get: (opts: { get: GetRecoilValue }) => T | Promise<T> | RecoilValue<T>
- -
-

Type declaration

- -
-
-
- -

key

-
key: string
- -
-
- -

set

-
set: (opts: { get: GetRecoilValue; reset: ResetRecoilState; set: SetRecoilState }, newValue: T | DefaultValue) => void
- -
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +ReadWriteSelectorOptions | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadWriteSelectorOptions<T>

Type Parameters

  • T

Hierarchy

Index

Properties

Methods

Properties

Optional cachePolicy_UNSTABLE

cachePolicy_UNSTABLE?: CachePolicyWithoutEquality

Optional dangerouslyAllowMutability

dangerouslyAllowMutability?: boolean

key

key: string

Methods

get

set

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.recoilrootprops.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.recoilrootprops.html deleted file mode 100644 index d0a4482ce..000000000 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.recoilrootprops.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - RecoilRootProps | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface RecoilRootProps

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - RecoilRootProps -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional initializeState

-
initializeState: (mutableSnapshot: MutableSnapshot) => void
- -
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.snapshotid.html b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.snapshotid.html index 9c9b69087..415ae6a4f 100644 --- a/packages/xarc-react-recoil/docs/interfaces/browser.recoil.snapshotid.html +++ b/packages/xarc-react-recoil/docs/interfaces/browser.recoil.snapshotid.html @@ -1,153 +1 @@ - - - - - - SnapshotID | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface SnapshotID

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - SnapshotID -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Readonly [SnapshotID_OPAQUE]

-
[SnapshotID_OPAQUE]: true
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +SnapshotID | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SnapshotID

Hierarchy

  • SnapshotID

Index

Properties

Properties

Readonly [SnapshotID_OPAQUE]

[SnapshotID_OPAQUE]: true

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules.html b/packages/xarc-react-recoil/docs/modules.html index 553f3fde3..89ac9f596 100644 --- a/packages/xarc-react-recoil/docs/modules.html +++ b/packages/xarc-react-recoil/docs/modules.html @@ -1,117 +1 @@ - - - - - - @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
-

@xarc/react-recoil

-
-
-
-
-
-
-
-

Index

-
-
-
-

Modules

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +@xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

@xarc/react-recoil

Index

Modules

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/browser.Recoil.RecoilLoadable.html b/packages/xarc-react-recoil/docs/modules/browser.Recoil.RecoilLoadable.html new file mode 100644 index 000000000..aeca24b49 --- /dev/null +++ b/packages/xarc-react-recoil/docs/modules/browser.Recoil.RecoilLoadable.html @@ -0,0 +1,15 @@ +RecoilLoadable | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RecoilLoadable

Index

Functions

Functions

all

  • +

    Factory to make a Loadable which is resolved when all of the Loadables provided +to it are resolved or any one has an error. The value is an array of the values +of all of the provided Loadables. This is comparable to Promise.all() for Loadables. +Similar to Promise.all(), inputs may be Loadables, Promises, or literal values.

    +

    Type Parameters

    Parameters

    • inputs: Inputs

    Returns Loadable<UnwrapLoadables<Inputs>>

  • Type Parameters

    • Inputs extends {}

    Parameters

    • inputs: Inputs

    Returns Loadable<UnwrapLoadables<Inputs>>

error

  • error(x: any): ErrorLoadable<any>
  • +

    Factory to make a Loadable object in an error state.

    +

    Parameters

    • x: any

    Returns ErrorLoadable<any>

isLoadable

  • +

    Returns true if the provided parameter is a Loadable type.

    +

    Parameters

    • x: any

    Returns x is Loadable<any>

loading

  • loading(): LoadingLoadable<any>
  • +

    Factory to make a loading Loadable which never resolves.

    +

    Returns LoadingLoadable<any>

of

  • +

    Factory to make a Loadable object. If a Promise is provided the Loadable will +be in a 'loading' state until the Promise is either resolved or rejected.

    +

    Type Parameters

    • T

    Parameters

    Returns Loadable<T>

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/browser.Recoil.atom.html b/packages/xarc-react-recoil/docs/modules/browser.Recoil.atom.html new file mode 100644 index 000000000..256b8039b --- /dev/null +++ b/packages/xarc-react-recoil/docs/modules/browser.Recoil.atom.html @@ -0,0 +1 @@ +atom | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace atom

Index

Functions

Functions

value

  • Type Parameters

    • T

    Parameters

    • value: T

    Returns WrappedValue<T>

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/browser.Recoil.selector.html b/packages/xarc-react-recoil/docs/modules/browser.Recoil.selector.html new file mode 100644 index 000000000..62f95fa1e --- /dev/null +++ b/packages/xarc-react-recoil/docs/modules/browser.Recoil.selector.html @@ -0,0 +1 @@ +selector | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace selector

Index

Functions

Functions

value

  • Type Parameters

    • T

    Parameters

    • value: T

    Returns WrappedValue<T>

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/browser.html b/packages/xarc-react-recoil/docs/modules/browser.html index 65e8633d5..2f5baf902 100644 --- a/packages/xarc-react-recoil/docs/modules/browser.html +++ b/packages/xarc-react-recoil/docs/modules/browser.html @@ -1,158 +1 @@ - - - - - - browser | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module browser

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Namespaces

- -
-
-
-
-
-

References

-
- -

RecoilFeature

- Re-exports RecoilFeature -
-
- -

RecoilFeatureOptions

- Re-exports RecoilFeatureOptions -
-
- -

recoilFeature

- Re-exports recoilFeature -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +browser | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module browser

Index

References

Namespaces

References

RecoilFeature

Re-exports RecoilFeature

RecoilFeatureOptions

Re-exports RecoilFeatureOptions

recoilFeature

Re-exports recoilFeature

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/browser.recoil.html b/packages/xarc-react-recoil/docs/modules/browser.recoil.html index e6dbc6c54..9a43d67ea 100644 --- a/packages/xarc-react-recoil/docs/modules/browser.recoil.html +++ b/packages/xarc-react-recoil/docs/modules/browser.recoil.html @@ -1,1736 +1,93 @@ - - - - - - Recoil | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Namespace Recoil

-
-
-
-
-
-
-
-

Index

-
-
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Type aliases

- -
-
-

Variables

- -
-
-

Functions

- -
-
-
-
-
-

Type aliases

-
- -

AtomEffect

-
AtomEffect<T>: (param: { node: RecoilState<T>; onSet: (param: (newValue: T | DefaultValue, oldValue: T | DefaultValue) => void) => void; resetSelf: () => void; setSelf: (param: T | DefaultValue | Promise<T | DefaultValue> | ((param: T | DefaultValue) => T | DefaultValue)) => void; trigger: "set" | "get" }) => void | (() => void)
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-

Type declaration

- -
-
-
- -

CallbackInterface

-
CallbackInterface: Readonly<{ gotoSnapshot: (snapshot: Snapshot) => void; reset: (recoilVal: RecoilState<any>) => void; set: <T>(recoilVal: RecoilState<T>, valOrUpdater: ((currVal: T) => T) | T) => void; snapshot: Snapshot }>
- -
-
- -

GetRecoilValue

-
GetRecoilValue: <T>(recoilVal: RecoilValue<T>) => T
- -
-

Type declaration

-
    -
  • - -
      -
    • -

      Type parameters

      -
        -
      • -

        T

        -
        • -
      -

      Parameters

      - -

      Returns T

      -
      • -
    -
    • -
-
-
-
- -

Loadable

-
Loadable<T>: ValueLoadable<T> | LoadingLoadable<T> | ErrorLoadable<T>
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
- -

RecoilValue

-
RecoilValue<T>: RecoilValueReadOnly<T> | RecoilState<T>
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
- -

ResetRecoilState

-
ResetRecoilState: (recoilVal: RecoilState<any>) => void
- -
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      - -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

Resetter

-
Resetter: () => void
- -
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    -
      -
    • -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

SerializableParam

-
SerializableParam: Primitive | ReadonlyArray<SerializableParam> | Readonly<{}>
- -
-
- -

SetRecoilState

-
SetRecoilState: <T>(recoilVal: RecoilState<T>, newVal: T | DefaultValue | ((prevValue: T) => T | DefaultValue)) => void
- -
-

Type declaration

- -
-
-
- -

SetterOrUpdater

-
SetterOrUpdater<T>: (valOrUpdater: ((currVal: T) => T) | T) => void
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (valOrUpdater: ((currVal: T) => T) | T): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        valOrUpdater: ((currVal: T) => T) | T
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

UnwrapRecoilValue

-
UnwrapRecoilValue<T>: T extends RecoilValue<infer R> ? R : never
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
- -

UnwrapRecoilValueLoadables

-
UnwrapRecoilValueLoadables<T>: {[ P in keyof T]: Loadable<UnwrapRecoilValue<T[P]>> }
- -

Type parameters

- -
-
- -

UnwrapRecoilValues

-
UnwrapRecoilValues<T>: {[ P in keyof T]: UnwrapRecoilValue<T[P]> }
- -

Type parameters

- -
-
-
-

Variables

-
- -

Const RecoilBridge

-
RecoilBridge: React.FC
- -
-
- -

Const RecoilRoot

-
RecoilRoot: React.FC<RecoilRootProps>
- -
-
-
-

Functions

-
- -

atom

- -
    -
  • - -
    -
    -

    Creates an atom, which represents a piece of writeable state

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns RecoilState<T>

    -
    • -
-
-
- -

atomFamily

- -
    -
  • - -

    Type parameters

    - -

    Parameters

    - -

    Returns (param: P) => RecoilState<T>

    - -
    • -
-
-
- -

constSelector

- -
    -
  • - -

    Type parameters

    - -

    Parameters

    -
      -
    • -
      constant: T
      -
      • -
    -

    Returns RecoilValueReadOnly<T>

    -
    • -
-
-
- -

errorSelector

- -
    -
  • - -

    Parameters

    -
      -
    • -
      message: string
      -
      • -
    -

    Returns RecoilValueReadOnly<never>

    -
    • -
-
-
- -

isRecoilValue

-
    -
  • isRecoilValue(val: unknown): val is RecoilValue<any>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      val: unknown
      -
      • -
    -

    Returns val is RecoilValue<any>

    -
    • -
-
-
- -

noWait

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns RecoilValueReadOnly<Loadable<T>>

    -
    • -
-
-
- -

readOnlySelector

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns RecoilValueReadOnly<T>

    -
    • -
-
-
- -

selector

- -
    -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns RecoilState<T>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns RecoilValueReadOnly<T>

    -
    • -
-
-
- -

selectorFamily

- - -
-
- -

snapshot_UNSTABLE

- -
    -
  • - -

    Parameters

    - -

    Returns Snapshot

    -
    • -
-
-
- -

useGotoRecoilSnapshot

-
    -
  • useGotoRecoilSnapshot(): (snapshot: Snapshot) => void
    • -
-
    -
  • - -

    Returns (snapshot: Snapshot) => void

    -
      -
    • - -
        -
      • -

        Parameters

        - -

        Returns void

        -
        • -
      -
      • -
    -
    • -
-
-
- -

useRecoilBridgeAcrossReactRoots_UNSTABLE

-
    -
  • useRecoilBridgeAcrossReactRoots_UNSTABLE(): typeof RecoilBridge
    • -
-
    -
  • - -

    Returns typeof RecoilBridge

    -
    • -
-
-
- -

useRecoilCallback

-
    -
  • useRecoilCallback<Args, Return>(fn: (interface: CallbackInterface) => (...args: Args) => Return, deps?: ReadonlyArray<unknown>): (...args: Args) => Return
    • -
-
    -
  • - -
    -
    -

    Returns a function that will run the callback that was passed when - calling this hook. Useful for accessing Recoil state in response to - events.

    -
    -
    -

    Type parameters

    -
      -
    • -

      Args: readonly unknown[]

      -
      • -
    • -

      Return

      -
      • -
    -

    Parameters

    -
      -
    • -
      fn: (interface: CallbackInterface) => (...args: Args) => Return
      -
        -
      • - -
          -
        • -

          Parameters

          - -

          Returns (...args: Args) => Return

          -
            -
          • -
              -
            • (...args: Args): Return
              • -
            -
              -
            • -

              Parameters

              -
                -
              • -
                Rest ...args: Args
                -
                • -
              -

              Returns Return

              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    • -
      Optional deps: ReadonlyArray<unknown>
      -
      • -
    -

    Returns (...args: Args) => Return

    -
      -
    • -
        -
      • (...args: Args): Return
        • -
      -
        -
      • -

        Parameters

        -
          -
        • -
          Rest ...args: Args
          -
          • -
        -

        Returns Return

        -
        • -
      -
      • -
    -
    • -
-
-
- -

useRecoilSnapshot

- -
    -
  • - -

    Returns Snapshot

    -
    • -
-
-
- -

useRecoilState

- -
    -
  • - -
    -
    -

    Returns a tuple where the first element is the value of the recoil state - and the second is a setter to update that state. Subscribes component - to updates of the given state.

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns [T, SetterOrUpdater<T>]

    -
    • -
-
-
- -

useRecoilStateLoadable

- -
    -
  • - -
    -
    -

    Returns a tuple where the first element is a Loadable and the second - element is a setter function to update the given state. Subscribes - component to updates of the given state.

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns [Loadable<T>, SetterOrUpdater<T>]

    -
    • -
-
-
- -

useRecoilTransactionObserver_UNSTABLE

-
    -
  • useRecoilTransactionObserver_UNSTABLE(callback: (opts: { previousSnapshot: Snapshot; snapshot: Snapshot }) => void): void
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      callback: (opts: { previousSnapshot: Snapshot; snapshot: Snapshot }) => void
      -
        -
      • - -
          -
        • -

          Parameters

          - -

          Returns void

          -
          • -
        -
        • -
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

useRecoilValue

-
    -
  • useRecoilValue<T>(recoilValue: RecoilValue<T>): T
    • -
-
    -
  • - -
    -
    -

    Returns the value of an atom or selector (readonly or writeable) and - subscribes the components to future updates of that state.

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns T

    -
    • -
-
-
- -

useRecoilValueLoadable

- -
    -
  • - -
    -
    -

    Returns a Loadable representing the status of the given Recoil state - and subscribes the component to future updates of that state. Useful - for working with async selectors.

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns Loadable<T>

    -
    • -
-
-
- -

useResetRecoilState

- -
    -
  • - -
    -
    -

    Returns a function that will reset the given state to its default value.

    -
    -
    -

    Parameters

    - -

    Returns Resetter

    -
    • -
-
-
- -

useSetRecoilState

- -
    -
  • - -
    -
    -

    Returns a setter function for updating Recoil state. Does not subscribe - the component to the given state.

    -
    -
    -

    Type parameters

    -
      -
    • -

      T

      -
      • -
    -

    Parameters

    - -

    Returns SetterOrUpdater<T>

    -
    • -
-
-
- -

waitForAll

- -
    -
  • - -

    Type parameters

    - -

    Parameters

    -
      -
    • -
      param: RecoilValues
      -
      • -
    -

    Returns RecoilValueReadOnly<UnwrapRecoilValues<RecoilValues>>

    -
    • -
  • - -

    Type parameters

    -
      -
    • -

      RecoilValues: {}

      -
      • -
    -

    Parameters

    -
      -
    • -
      param: RecoilValues
      -
      • -
    -

    Returns RecoilValueReadOnly<UnwrapRecoilValues<RecoilValues>>

    -
    • -
-
-
- -

waitForAny

- - -
-
- -

waitForNone

- - -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +Recoil | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Recoil

+

Copyright (c) Meta Platforms, Inc. and affiliates.

+

This source code is licensed under the MIT license found in the +LICENSE file in the root directory of this source tree.

+
oncall

recoil

+

Index

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AtomEffect

AtomEffect<T>: ((param: { node: RecoilState<T>; parentStoreID_UNSTABLE?: StoreID; storeID: StoreID; trigger: "set" | "get"; getInfo_UNSTABLE: any; getLoadable: any; getPromise: any; onSet: any; resetSelf: any; setSelf: any }) => void | (() => void))

Type Parameters

  • T

Type declaration

    • (param: { node: RecoilState<T>; parentStoreID_UNSTABLE?: StoreID; storeID: StoreID; trigger: "set" | "get"; getInfo_UNSTABLE: any; getLoadable: any; getPromise: any; onSet: any; resetSelf: any; setSelf: any }): void | (() => void)

    • Parameters

      • param: { node: RecoilState<T>; parentStoreID_UNSTABLE?: StoreID; storeID: StoreID; trigger: "set" | "get"; getInfo_UNSTABLE: any; getLoadable: any; getPromise: any; onSet: any; resetSelf: any; setSelf: any }
        • node: RecoilState<T>
        • Optional parentStoreID_UNSTABLE?: StoreID
        • storeID: StoreID
        • trigger: "set" | "get"
        • getInfo_UNSTABLE:function
          • getInfo_UNSTABLE<S>(recoilValue: RecoilValue<S>): RecoilStateInfo<S>

          • Type Parameters

            • S

            Parameters

            Returns RecoilStateInfo<S>

        • getLoadable:function

          • Type Parameters

            • S

            Parameters

            Returns Loadable<S>

        • getPromise:function

          • Type Parameters

            • S

            Parameters

            Returns Promise<S>

        • onSet:function
          • onSet(param: ((newValue: T, oldValue: DefaultValue | T, isReset: boolean) => void)): void

          • Parameters

            • param: ((newValue: T, oldValue: DefaultValue | T, isReset: boolean) => void)
                • (newValue: T, oldValue: DefaultValue | T, isReset: boolean): void

                • Parameters

                  Returns void

            Returns void

        • resetSelf:function
          • resetSelf(): void

          • Returns void

        • setSelf:function

      Returns void | (() => void)

AtomFamilyOptions

AtomFamilyOptions<T, P>: AtomFamilyOptionsWithDefault<T, P> | AtomFamilyOptionsWithoutDefault<T, P>

Type Parameters

AtomOptions

AtomOptions<T>: AtomOptionsWithoutDefault<T> | AtomOptionsWithDefault<T>

Type Parameters

  • T

CachePolicyWithoutEquality

CachePolicyWithoutEquality: { eviction: "lru"; maxSize: number } | { eviction: "keep-all" } | { eviction: "most-recent" }

EvictionPolicy

EvictionPolicy: "lru" | "keep-all" | "most-recent"

GetCallback

GetCallback: (<Args, Return>(fn: ((interface: SelectorCallbackInterface) => ((...args: Args) => Return))) => ((...args: Args) => Return))

Type declaration

    • Type Parameters

      • Args extends ReadonlyArray<unknown>

      • Return

      Parameters

      Returns ((...args: Args) => Return)

        • (...args: Args): Return

        • Parameters

          • Rest ...args: Args

          Returns Return

GetRecoilValue

GetRecoilValue: (<T>(recoilVal: RecoilValue<T>) => T)

Type declaration

Loadable

Loadable<T>: ValueLoadable<T> | LoadingLoadable<T> | ErrorLoadable<T>

Type Parameters

  • T

RecoilRootProps

RecoilRootProps: { children: React.ReactNode; override?: true; initializeState?: any } | { children: React.ReactNode; override: false }

RecoilValue

RecoilValue<T>: RecoilValueReadOnly<T> | RecoilState<T>

Type Parameters

  • T

ResetRecoilState

ResetRecoilState: ((recoilVal: RecoilState<any>) => void)

Type declaration

Resetter

Resetter: (() => void)

Type declaration

    • (): void

    • Returns void

SerializableParam

SerializableParam: Primitive | HasToJSON | ReadonlyArray<SerializableParam> | ReadonlySet<SerializableParam> | ReadonlyMap<SerializableParam, SerializableParam> | Readonly<{}>

SetRecoilState

SetRecoilState: (<T>(recoilVal: RecoilState<T>, newVal: T | DefaultValue | ((prevValue: T) => T | DefaultValue)) => void)

Type declaration

SetterOrUpdater

SetterOrUpdater<T>: ((valOrUpdater: ((currVal: T) => T) | T) => void)

Type Parameters

  • T

Type declaration

    • (valOrUpdater: ((currVal: T) => T) | T): void

    • Parameters

      • valOrUpdater: ((currVal: T) => T) | T

      Returns void

UnwrapLoadable

UnwrapLoadable<T>: T extends Loadable<infer R> ? R : T extends Promise<infer P> ? P : T

Type Parameters

  • T

UnwrapLoadables

UnwrapLoadables<T>: { [ P in keyof T]: UnwrapLoadable<T[P]> }

Type Parameters

  • T extends any[] | {}

UnwrapRecoilValue

UnwrapRecoilValue<T>: T extends RecoilValue<infer R> ? R : never

Type Parameters

  • T

UnwrapRecoilValueLoadables

UnwrapRecoilValueLoadables<T>: { [ P in keyof T]: Loadable<UnwrapRecoilValue<T[P]>> }

Type Parameters

UnwrapRecoilValues

UnwrapRecoilValues<T>: { [ P in keyof T]: UnwrapRecoilValue<T[P]> }

Type Parameters

Variables

Const RecoilBridge

RecoilBridge: React.FC<{ children: React.ReactNode }>

RecoilEnv

RecoilEnv: Recoil.RecoilEnv

Const RecoilRoot

RecoilRoot: React.FC<RecoilRootProps>
+

Root component for managing Recoil state. Most Recoil hooks should be +called from a component nested in a

+

Functions

atom

  • +

    Creates an atom, which represents a piece of writeable state

    +

    Type Parameters

    • T

    Parameters

    Returns RecoilState<T>

atomFamily

  • +

    Returns a function which returns a memoized atom for each unique parameter value.

    +

    Type Parameters

    Parameters

    Returns ((param: P) => RecoilState<T>)

      • +

        Returns a function which returns a memoized atom for each unique parameter value.

        +

        Parameters

        • param: P

        Returns RecoilState<T>

constSelector

  • +

    Returns a selector that always has a constant value.

    +

    Type Parameters

    Parameters

    • constant: T

    Returns RecoilValueReadOnly<T>

errorSelector

  • +

    Returns a selector which is always in the provided error state.

    +

    Parameters

    • message: string

    Returns RecoilValueReadOnly<never>

isRecoilValue

  • +

    Returns true if the parameter is a Recoil atom or selector.

    +

    Parameters

    • val: unknown

    Returns val is RecoilValue<any>

noWait

  • +

    Returns a selector that has the value of the provided atom or selector as a Loadable. +This means you can use noWait() to avoid entering an error or suspense state in +order to manually handle those cases.

    +

    Type Parameters

    • T

    Parameters

    Returns RecoilValueReadOnly<Loadable<T>>

readOnlySelector

  • +

    Casts a selector to be a read-only selector

    +

    Type Parameters

    • T

    Parameters

    Returns RecoilValueReadOnly<T>

selector

  • +

    Creates a selector which represents derived state.

    +

    Type Parameters

    • T

    Parameters

    Returns RecoilState<T>

  • Type Parameters

    • T

    Parameters

    Returns RecoilValueReadOnly<T>

selectorFamily

  • +

    Returns a function which returns a memoized atom for each unique parameter value.

    +

    Type Parameters

    Parameters

    Returns ((param: P) => RecoilState<T>)

      • +

        Returns a function which returns a memoized atom for each unique parameter value.

        +

        Parameters

        • param: P

        Returns RecoilState<T>

  • +

    Returns a function which returns a memoized atom for each unique parameter value.

    +

    Type Parameters

    Parameters

    Returns ((param: P) => RecoilValueReadOnly<T>)

snapshot_UNSTABLE

  • +

    Factory to produce a Recoil snapshot object with all atoms in the default state.

    +

    Parameters

    Returns Snapshot

useGetRecoilValueInfo_UNSTABLE

  • useGetRecoilValueInfo_UNSTABLE(): (<T>(recoilValue: RecoilValue<T>) => RecoilStateInfo<T>)
  • +

    Returns current info about an atom

    +

    Returns (<T>(recoilValue: RecoilValue<T>) => RecoilStateInfo<T>)

      • +

        Returns current info about an atom

        +

        Type Parameters

        • T

        Parameters

        Returns RecoilStateInfo<T>

useGotoRecoilSnapshot

  • useGotoRecoilSnapshot(): ((snapshot: Snapshot) => void)
  • +

    Updates Recoil state to match the provided snapshot.

    +

    Returns ((snapshot: Snapshot) => void)

      • +

        Updates Recoil state to match the provided snapshot.

        +

        Parameters

        Returns void

useRecoilBridgeAcrossReactRoots_UNSTABLE

  • useRecoilBridgeAcrossReactRoots_UNSTABLE(): typeof RecoilBridge
  • +

    Returns a component that acts like a but shares the same store +as the current .

    +

    Returns typeof RecoilBridge

useRecoilCallback

  • useRecoilCallback<Args, Return>(fn: ((interface: CallbackInterface) => ((...args: Args) => Return)), deps?: readonly unknown[]): ((...args: Args) => Return)
  • +

    Returns a function that will run the callback that was passed when +calling this hook. Useful for accessing Recoil state in response to +events.

    +

    Type Parameters

    • Args extends readonly unknown[]

    • Return

    Parameters

    • fn: ((interface: CallbackInterface) => ((...args: Args) => Return))

        • Parameters

          Returns ((...args: Args) => Return)

            • (...args: Args): Return

            • Parameters

              • Rest ...args: Args

              Returns Return

    • Optional deps: readonly unknown[]

    Returns ((...args: Args) => Return)

      • (...args: Args): Return
      • +

        Returns a function that will run the callback that was passed when +calling this hook. Useful for accessing Recoil state in response to +events.

        +

        Parameters

        • Rest ...args: Args

        Returns Return

useRecoilRefresher_UNSTABLE

  • useRecoilRefresher_UNSTABLE(recoilValue: RecoilValue<any>): (() => void)
  • +

    Clears the cache for a selector causing it to be reevaluated.

    +

    Parameters

    Returns (() => void)

      • (): void
      • +

        Clears the cache for a selector causing it to be reevaluated.

        +

        Returns void

useRecoilSnapshot

  • +

    Returns a snapshot of the current Recoil state and subscribes the component +to re-render when any state is updated.

    +

    Returns Snapshot

useRecoilState

  • +

    Returns a tuple where the first element is the value of the recoil state +and the second is a setter to update that state. Subscribes component +to updates of the given state.

    +

    Type Parameters

    • T

    Parameters

    Returns [T, SetterOrUpdater<T>]

useRecoilStateLoadable

  • +

    Returns a tuple where the first element is a Loadable and the second +element is a setter function to update the given state. Subscribes +component to updates of the given state.

    +

    Type Parameters

    • T

    Parameters

    Returns [Loadable<T>, SetterOrUpdater<T>]

useRecoilState_TRANSITION_SUPPORT_UNSTABLE

  • Type Parameters

    • T

    Parameters

    Returns [T, SetterOrUpdater<T>]

useRecoilStoreID

  • +

    Returns an ID for the currently active state store of the host

    +

    Returns StoreID

useRecoilTransactionObserver_UNSTABLE

  • useRecoilTransactionObserver_UNSTABLE(callback: ((opts: { previousSnapshot: Snapshot; snapshot: Snapshot }) => void)): void

  • Parameters

    Returns void

useRecoilTransaction_UNSTABLE

  • useRecoilTransaction_UNSTABLE<Args>(fn: ((interface: TransactionInterface_UNSTABLE) => ((...args: Args) => void)), deps?: readonly unknown[]): ((...args: Args) => void)
  • +

    Returns a function that executes an atomic transaction for updating Recoil state.

    +

    Type Parameters

    • Args extends readonly unknown[]

    Parameters

    Returns ((...args: Args) => void)

      • (...args: Args): void
      • +

        Returns a function that executes an atomic transaction for updating Recoil state.

        +

        Parameters

        • Rest ...args: Args

        Returns void

useRecoilValue

  • +

    Returns the value of an atom or selector (readonly or writeable) and +subscribes the components to future updates of that state.

    +

    Type Parameters

    • T

    Parameters

    Returns T

useRecoilValueLoadable

  • +

    Returns a Loadable representing the status of the given Recoil state +and subscribes the component to future updates of that state. Useful +for working with async selectors.

    +

    Type Parameters

    • T

    Parameters

    Returns Loadable<T>

useRecoilValueLoadable_TRANSITION_SUPPORT_UNSTABLE

  • useRecoilValueLoadable_TRANSITION_SUPPORT_UNSTABLE<T>(recoilValue: RecoilValue<T>): Loadable<T>

  • Type Parameters

    • T

    Parameters

    Returns Loadable<T>

useRecoilValue_TRANSITION_SUPPORT_UNSTABLE

  • useRecoilValue_TRANSITION_SUPPORT_UNSTABLE<T>(recoilValue: RecoilValue<T>): T
  • +

    Experimental version of hooks for useTransition() support

    +

    Type Parameters

    • T

    Parameters

    Returns T

useResetRecoilState

  • +

    Returns a function that will reset the given state to its default value.

    +

    Parameters

    Returns Resetter

useSetRecoilState

  • +

    Returns a setter function for updating Recoil state. Does not subscribe +the component to the given state.

    +

    Type Parameters

    • T

    Parameters

    Returns SetterOrUpdater<T>

waitForAll

  • Type Parameters

    Parameters

    • param: RecoilValues

    Returns RecoilValueReadOnly<UnwrapRecoilValues<RecoilValues>>

  • Type Parameters

    • RecoilValues extends {}

    Parameters

    • param: RecoilValues

    Returns RecoilValueReadOnly<UnwrapRecoilValues<RecoilValues>>

waitForAllSettled

waitForAny

waitForNone

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/common.html b/packages/xarc-react-recoil/docs/modules/common.html index f77757c9d..1baf05cb4 100644 --- a/packages/xarc-react-recoil/docs/modules/common.html +++ b/packages/xarc-react-recoil/docs/modules/common.html @@ -1,271 +1,20 @@ - - - - - - common | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module common

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Type aliases

- -
-
-

Functions

- -
-
-
-
-
-

References

-
- -

Recoil

- Re-exports Recoil -
-
-
-

Type aliases

-
- -

RecoilFeature

-
RecoilFeature: SubAppFeature & { _store: any; options: RecoilFeatureOptions; prepare: any; wrap: (_: any) => any }
- -
-
-

recoil support for a subapp

-
-
-
-
- -

RecoilFeatureOptions

-
RecoilFeatureOptions: { React: Partial<{ createElement: unknown }>; prepare: any }
- -
-
-

options for recoil feature

-
-
-
-

Type declaration

-
    -
  • -
    React: Partial<{ createElement: unknown }>
    -
    -
    -

    The React module.

    -
    -

    This is needed for the recoil feature to wrap subapp's component inside - the recoil Provider component.

    -
    -
    • -
  • -
    prepare: function
    -
      -
    • prepare(initialState: any): Promise<any>
      • -
    -
      -
    • - -
      -
      -

      prepare recoil initial state

      -
      -
      -

      Parameters

      -
        -
      • -
        initialState: any
        -
        -

        when SSR sent initialState used, it will be passed. The client - prepare can just return {initialState} as is.

        -
        -
        • -
      -

      Returns Promise<any>

      -

      Promise<{initialState: any}>

      -
      • -
    -
    • -
-
-
-
-
-

Functions

-
- -

recoilFeature

- -
    -
  • - -
    -
    -

    Add support for recoil to a subapp

    -
    -
    -

    Parameters

    - -

    Returns SubAppFeatureFactory

    -

    unknown

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +common | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module common

Index

References

Type Aliases

Functions

References

Recoil

Re-exports Recoil

Type Aliases

RecoilFeature

RecoilFeature: SubAppFeature & { _store: any; options: RecoilFeatureOptions; prepare: any; wrap: any }
+

recoil support for a subapp

+

RecoilFeatureOptions

RecoilFeatureOptions: { React: Partial<{ createElement: unknown }>; prepare: any }
+

options for recoil feature

+

Type declaration

  • React: Partial<{ createElement: unknown }>
    +

    The React module.

    +

    This is needed for the recoil feature to wrap subapp's component inside +the recoil Provider component.

    +
  • prepare:function
    • prepare(initialState: any): Promise<any>
    • +

      prepare recoil initial state

      +

      Parameters

      • initialState: any
        +

        when SSR sent initialState used, it will be passed. The client + prepare can just return {initialState} as is.

        +

      Returns Promise<any>

      Promise<{initialState: any}>

      +

Functions

recoilFeature

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/docs/modules/node.html b/packages/xarc-react-recoil/docs/modules/node.html index 9e2734829..65df495e9 100644 --- a/packages/xarc-react-recoil/docs/modules/node.html +++ b/packages/xarc-react-recoil/docs/modules/node.html @@ -1,161 +1 @@ - - - - - - node | @xarc/react-recoil - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Module node

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

Recoil

- Re-exports Recoil -
-
- -

RecoilFeature

- Re-exports RecoilFeature -
-
- -

RecoilFeatureOptions

- Re-exports RecoilFeatureOptions -
-
- -

recoilFeature

- Re-exports recoilFeature -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Type alias
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +node | @xarc/react-recoil
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module node

Index

References

References

Recoil

Re-exports Recoil

RecoilFeature

Re-exports RecoilFeature

RecoilFeatureOptions

Re-exports RecoilFeatureOptions

recoilFeature

Re-exports recoilFeature

Legend

  • Function
  • Type alias

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/xarc-react-recoil/package.json b/packages/xarc-react-recoil/package.json index 29b6d6815..2fa9ea6a6 100644 --- a/packages/xarc-react-recoil/package.json +++ b/packages/xarc-react-recoil/package.json @@ -1,6 +1,6 @@ { "name": "@xarc/react-recoil", - "version": "1.1.1", + "version": "1.1.2", "description": "Electrode xarc React application recoil support", "main": "dist-node-cjs/node/index.js", "module": "dist-node-esm/node/index.js", diff --git a/packages/xarc-react-recoil/src/common/index.tsx b/packages/xarc-react-recoil/src/common/index.tsx index 7efc90a41..a68b669c6 100644 --- a/packages/xarc-react-recoil/src/common/index.tsx +++ b/packages/xarc-react-recoil/src/common/index.tsx @@ -1,7 +1,6 @@ /* eslint-disable prefer-const */ /* eslint-disable dot-notation */ /* eslint-disable max-statements, complexity */ - import { SubAppDef, SubAppFeatureFactory, SubAppFeature } from "@xarc/subapp"; import { atom, RecoilState, RecoilRoot } from "recoil"; diff --git a/packages/xarc-react-redux-observable/CHANGELOG.json b/packages/xarc-react-redux-observable/CHANGELOG.json index dfe959e3e..f443eb335 100644 --- a/packages/xarc-react-redux-observable/CHANGELOG.json +++ b/packages/xarc-react-redux-observable/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@xarc/react-redux-observable", "entries": [ + { + "version": "1.1.2", + "tag": "@xarc/react-redux-observable_v1.1.2", + "date": "Thu, 07 Sep 2023 22:19:14 GMT", + "comments": { + "patch": [ + { + "comment": "Minor change to force publish esm bundles" + } + ] + } + }, { "version": "1.1.1", "tag": "@xarc/react-redux-observable_v1.1.1", diff --git a/packages/xarc-react-redux-observable/CHANGELOG.md b/packages/xarc-react-redux-observable/CHANGELOG.md index e5c938da8..01e60da8e 100644 --- a/packages/xarc-react-redux-observable/CHANGELOG.md +++ b/packages/xarc-react-redux-observable/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @xarc/react-redux-observable -This log was last generated on Tue, 29 Aug 2023 14:57:37 GMT and should not be manually modified. +This log was last generated on Thu, 07 Sep 2023 22:19:14 GMT and should not be manually modified. + +## 1.1.2 +Thu, 07 Sep 2023 22:19:14 GMT + +### Patches + +- Minor change to force publish esm bundles ## 1.1.1 Tue, 29 Aug 2023 14:57:37 GMT diff --git a/packages/xarc-react-redux-observable/docs/modules/common.html b/packages/xarc-react-redux-observable/docs/modules/common.html index 71fc2f794..21b12b0d9 100644 --- a/packages/xarc-react-redux-observable/docs/modules/common.html +++ b/packages/xarc-react-redux-observable/docs/modules/common.html @@ -92,7 +92,7 @@

ReduxObservableOptions

ReduxObservableOptions: { rootEpic: Epic }
@@ -127,7 +127,7 @@

reduxObservableDecor

  • diff --git a/packages/xarc-react-redux-observable/package.json b/packages/xarc-react-redux-observable/package.json index 883e4e27c..1085c1b06 100644 --- a/packages/xarc-react-redux-observable/package.json +++ b/packages/xarc-react-redux-observable/package.json @@ -1,6 +1,6 @@ { "name": "@xarc/react-redux-observable", - "version": "1.1.1", + "version": "1.1.2", "description": "xarc React.js application redux observable support", "main": "dist-node-cjs/node/index.js", "module": "dist-node-esm/node/index.js", diff --git a/packages/xarc-react-redux-observable/src/common/index.tsx b/packages/xarc-react-redux-observable/src/common/index.tsx index cbd9ca405..19be5c81c 100644 --- a/packages/xarc-react-redux-observable/src/common/index.tsx +++ b/packages/xarc-react-redux-observable/src/common/index.tsx @@ -1,4 +1,5 @@ import { createEpicMiddleware, Epic } from "redux-observable"; + import { applyMiddleware, Reducer, diff --git a/packages/xarc-react-redux-saga/CHANGELOG.json b/packages/xarc-react-redux-saga/CHANGELOG.json index fbd37fc7e..4f52c1c6f 100644 --- a/packages/xarc-react-redux-saga/CHANGELOG.json +++ b/packages/xarc-react-redux-saga/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@xarc/react-redux-saga", "entries": [ + { + "version": "1.1.2", + "tag": "@xarc/react-redux-saga_v1.1.2", + "date": "Thu, 07 Sep 2023 22:19:14 GMT", + "comments": { + "patch": [ + { + "comment": "Minor change to force publish esm bundles" + } + ] + } + }, { "version": "1.1.1", "tag": "@xarc/react-redux-saga_v1.1.1", diff --git a/packages/xarc-react-redux-saga/CHANGELOG.md b/packages/xarc-react-redux-saga/CHANGELOG.md index 975b2d386..01fc9d370 100644 --- a/packages/xarc-react-redux-saga/CHANGELOG.md +++ b/packages/xarc-react-redux-saga/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @xarc/react-redux-saga -This log was last generated on Tue, 29 Aug 2023 14:57:37 GMT and should not be manually modified. +This log was last generated on Thu, 07 Sep 2023 22:19:14 GMT and should not be manually modified. + +## 1.1.2 +Thu, 07 Sep 2023 22:19:14 GMT + +### Patches + +- Minor change to force publish esm bundles ## 1.1.1 Tue, 29 Aug 2023 14:57:37 GMT diff --git a/packages/xarc-react-redux-saga/docs/modules/common.html b/packages/xarc-react-redux-saga/docs/modules/common.html index b08673301..3b2fbdcd8 100644 --- a/packages/xarc-react-redux-saga/docs/modules/common.html +++ b/packages/xarc-react-redux-saga/docs/modules/common.html @@ -92,7 +92,7 @@

    ReduxSagaOption

    ReduxSagaOption: { rootSaga: any }
    @@ -127,7 +127,7 @@

    reduxSagaDecor

  • diff --git a/packages/xarc-react-redux-saga/package.json b/packages/xarc-react-redux-saga/package.json index 3a61de693..d571d1e9b 100644 --- a/packages/xarc-react-redux-saga/package.json +++ b/packages/xarc-react-redux-saga/package.json @@ -1,6 +1,6 @@ { "name": "@xarc/react-redux-saga", - "version": "1.1.1", + "version": "1.1.2", "description": "xarc React.js application redux saga support", "main": "dist-node-cjs/node/index.js", "module": "dist-node-esm/node/index.js", diff --git a/packages/xarc-react-redux-saga/src/common/index.tsx b/packages/xarc-react-redux-saga/src/common/index.tsx index 5ce2df617..923d086ad 100644 --- a/packages/xarc-react-redux-saga/src/common/index.tsx +++ b/packages/xarc-react-redux-saga/src/common/index.tsx @@ -1,5 +1,4 @@ import createSagaMiddleware from "redux-saga"; - import { applyMiddleware, Reducer, diff --git a/packages/xarc-react-router/CHANGELOG.json b/packages/xarc-react-router/CHANGELOG.json index 3d13fa08d..056214421 100644 --- a/packages/xarc-react-router/CHANGELOG.json +++ b/packages/xarc-react-router/CHANGELOG.json @@ -1,6 +1,18 @@ { "name": "@xarc/react-router", "entries": [ + { + "version": "1.1.2", + "tag": "@xarc/react-router_v1.1.2", + "date": "Thu, 07 Sep 2023 22:19:14 GMT", + "comments": { + "patch": [ + { + "comment": "Minor change to force publish esm bundles" + } + ] + } + }, { "version": "1.1.1", "tag": "@xarc/react-router_v1.1.1", diff --git a/packages/xarc-react-router/CHANGELOG.md b/packages/xarc-react-router/CHANGELOG.md index b49524ce5..be4beab5f 100644 --- a/packages/xarc-react-router/CHANGELOG.md +++ b/packages/xarc-react-router/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log - @xarc/react-router -This log was last generated on Tue, 29 Aug 2023 14:57:37 GMT and should not be manually modified. +This log was last generated on Thu, 07 Sep 2023 22:19:14 GMT and should not be manually modified. + +## 1.1.2 +Thu, 07 Sep 2023 22:19:14 GMT + +### Patches + +- Minor change to force publish esm bundles ## 1.1.1 Tue, 29 Aug 2023 14:57:37 GMT diff --git a/packages/xarc-react-router/docs/.nojekyll b/packages/xarc-react-router/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/packages/xarc-react-router/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/xarc-react-router/docs/assets/css/main.css b/packages/xarc-react-router/docs/assets/css/main.css deleted file mode 100644 index 46571c27c..000000000 --- a/packages/xarc-react-router/docs/assets/css/main.css +++ /dev/null @@ -1,2660 +0,0 @@ -:root { - --color-background: #fdfdfd; - --color-text: #222; - --color-text-aside: #707070; - --color-link: #4da6ff; - --color-menu-divider: #eee; - --color-menu-divider-focus: #000; - --color-menu-label: #707070; - --color-panel: #fff; - --color-panel-divider: #eee; - --color-comment-tag: #707070; - --color-comment-tag-text: #fff; - --color-code-background: rgba(0, 0, 0, 0.04); - --color-ts: #9600ff; - --color-ts-interface: #647f1b; - --color-ts-enum: #937210; - --color-ts-class: #0672de; - --color-ts-private: #707070; - --color-toolbar: #fff; - --color-toolbar-text: #333; -} - -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * * HTML5 display definitions - * * ========================================================================== */ -/** - * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; -} - -/** - * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; -} - -/** - * * Prevent modern browsers from displaying `audio` without controls. - * * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * * Known issue: no IE 6 support. */ -[hidden] { - display: none; -} - -/* ========================================================================== - * * Base - * * ========================================================================== */ -/** - * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * * `em` units. - * * 2. Prevent iOS text size adjust after orientation change, without disabling - * * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; -} - -/** - * * Address `font-family` inconsistency between `textarea` and other form - * * elements. */ -button, input, select, textarea { - font-family: sans-serif; -} - -/** - * * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; -} - -/* ========================================================================== - * * Links - * * ========================================================================== */ -/** - * * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; -} -a:active, a:hover { - outline: 0; -} - -/** - * * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * * Typography - * * ========================================================================== */ -/** - * * Address font sizes and margins set differently in IE 6/7. - * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -/** - * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; -} - -blockquote { - margin: 1em 40px; -} - -/** - * * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; -} - -/** - * * Address differences between Firefox and other browsers. - * * Known issue: no IE 6/7 normalization. */ -hr { - -moz-box-sizing: content-box; - box-sizing: content-box; - height: 0; -} - -/** - * * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; -} - -/** - * * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; -} - -/** - * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: "courier new", monospace; - font-size: 1em; -} - -/** - * * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -/** - * * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; -} -q:before, q:after { - content: ""; - content: none; -} - -/** - * * Address `quotes` property not supported in Safari 4. */ -/** - * * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; -} - -/** - * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* ========================================================================== - * * Lists - * * ========================================================================== */ -/** - * * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -/** - * * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; -} - -/** - * * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; -} - -/* ========================================================================== - * * Embedded content - * * ========================================================================== */ -/** - * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; -} - -/* 2 */ -/** - * * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; -} - -/* ========================================================================== - * * Figures - * * ========================================================================== */ -/** - * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; -} - -/* ========================================================================== - * * Forms - * * ========================================================================== */ -/** - * * Correct margin displayed oddly in IE 6/7. */ -/** - * * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * * 1. Correct color not being inherited in IE 6/7/8/9. - * * 2. Correct text not wrapping in Firefox 3. - * * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; -} - -/* 3 */ -/** - * * 1. Correct font size not being inherited in all browsers. - * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * * and Chrome. - * * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; -} - -/* 3 */ -/** - * * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * * the UA stylesheet. */ -button, input { - line-height: normal; -} - -/** - * * Address inconsistent `text-transform` inheritance for `button` and `select`. - * * All other form control elements do not inherit `text-transform` values. - * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; -} - -/** - * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * * and `video` controls. - * * 2. Correct inability to style clickable `input` types in iOS. - * * 3. Improve usability and consistency of cursor style between image-type - * * `input` and others. - * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * * Known issue: inner spacing remains in IE 6. */ -button, html input[type=button] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -input[type=reset], input[type=submit] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -/** - * * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; -} - -/** - * * 1. Address box sizing set to content-box in IE 8/9. - * * 2. Remove excess padding in IE 8/9. - * * 3. Remove excess padding in IE 7. - * * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ -} -input[type=checkbox], input[type=radio] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; -} -input[type=search] { - -webkit-appearance: textfield; - /* 1 */ - -moz-box-sizing: content-box; - -webkit-box-sizing: content-box; - /* 2 */ - box-sizing: content-box; -} -input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * * (include `-moz` to future-proof). */ -/** - * * Remove inner padding and search cancel button in Safari 5 and Chrome - * * on OS X. */ -/** - * * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; -} - -/* 2 */ -/* ========================================================================== - * * Tables - * * ========================================================================== */ -/** - * * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; -} - -ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-1 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-1 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-1 { - width: 8.3333333333%; -} - -.offset-1 { - margin-left: 8.3333333333%; -} - -.col-2 { - width: 16.6666666667%; -} - -.offset-2 { - margin-left: 16.6666666667%; -} - -.col-3 { - width: 25%; -} - -.offset-3 { - margin-left: 25%; -} - -.col-4 { - width: 33.3333333333%; -} - -.offset-4 { - margin-left: 33.3333333333%; -} - -.col-5 { - width: 41.6666666667%; -} - -.offset-5 { - margin-left: 41.6666666667%; -} - -.col-6 { - width: 50%; -} - -.offset-6 { - margin-left: 50%; -} - -.col-7 { - width: 58.3333333333%; -} - -.offset-7 { - margin-left: 58.3333333333%; -} - -.col-8 { - width: 66.6666666667%; -} - -.offset-8 { - margin-left: 66.6666666667%; -} - -.col-9 { - width: 75%; -} - -.offset-9 { - margin-left: 75%; -} - -.col-10 { - width: 83.3333333333%; -} - -.offset-10 { - margin-left: 83.3333333333%; -} - -.col-11 { - width: 91.6666666667%; -} - -.offset-11 { - margin-left: 91.6666666667%; -} - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: var(--color-code-background); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, .tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; - } - html.default .col-menu { - width: 28%; - } - html.default .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; - } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html.default .col-menu > *:last-child { - padding-bottom: 20px; - } - html.default .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; - } - html.default.to-has-menu header, -html.default.to-has-menu footer, -html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; - } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; - } - html.default.from-has-menu header, -html.default.from-has-menu footer, -html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; - } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - html.default.has-menu body { - overflow: hidden; - } - html.default.has-menu .overlay { - visibility: visible; - } - html.default.has-menu header, -html.default.has-menu footer, -html.default.has-menu .col-content { - transform: translate(-25%, 0); - } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -html.minimal .container { - margin: 0; -} -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; -} -html.minimal .content-wrap { - padding-left: 300px; -} -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; -} -html.minimal .tsd-member .tsd-member { - margin-left: 0; -} -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; -} -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; -} -html.minimal footer { - background-color: transparent; -} -html.minimal footer .container { - padding: 0; -} -html.minimal .tsd-generator { - padding: 0; -} -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; - } - html.minimal .content-wrap { - padding-left: 0; - } -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, -#tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member a[data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member a[data-tsd-kind=Interface] { - color: var(--color-ts-interface); -} -.tsd-member a[data-tsd-kind=Enum] { - color: var(--color-ts-enum); -} -.tsd-member a[data-tsd-kind=Class] { - color: var(--color-ts-class); -} -.tsd-member a[data-tsd-kind=Private] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; -} -.tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; -} -.tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, .tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.8; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, .tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; - } -} -input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; -} -input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} diff --git a/packages/xarc-react-router/docs/assets/highlight.css b/packages/xarc-react-router/docs/assets/highlight.css new file mode 100644 index 000000000..6dd4eef7e --- /dev/null +++ b/packages/xarc-react-router/docs/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +body.light { + --code-background: var(--light-code-background); +} + +body.dark { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/packages/xarc-react-router/docs/assets/icons.css b/packages/xarc-react-router/docs/assets/icons.css new file mode 100644 index 000000000..776a3562d --- /dev/null +++ b/packages/xarc-react-router/docs/assets/icons.css @@ -0,0 +1,1043 @@ +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(./icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(./icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -187px; +} diff --git a/packages/xarc-react-router/docs/assets/images/icons.png b/packages/xarc-react-router/docs/assets/icons.png similarity index 100% rename from packages/xarc-react-router/docs/assets/images/icons.png rename to packages/xarc-react-router/docs/assets/icons.png diff --git a/packages/xarc-react-router/docs/assets/images/icons@2x.png b/packages/xarc-react-router/docs/assets/icons@2x.png similarity index 100% rename from packages/xarc-react-router/docs/assets/images/icons@2x.png rename to packages/xarc-react-router/docs/assets/icons@2x.png diff --git a/packages/xarc-react-router/docs/assets/js/main.js b/packages/xarc-react-router/docs/assets/js/main.js deleted file mode 100644 index dc257a868..000000000 --- a/packages/xarc-react-router/docs/assets/js/main.js +++ /dev/null @@ -1,248 +0,0 @@ -/* - * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). - * This devtool is not neither made for production nor for readable output files. - * It uses "eval()" calls to create a separate source file in the browser devtools. - * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) - * or disable the default devtool with "devtool: false". - * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). - */ -/******/ (() => { // webpackBootstrap -/******/ var __webpack_modules__ = ({ - -/***/ "../node_modules/lunr/lunr.js": -/*!************************************!*\ - !*** ../node_modules/lunr/lunr.js ***! - \************************************/ -/***/ ((module, exports, __webpack_require__) => { - -eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); - -/***/ }), - -/***/ "./default/assets/css/main.sass": -/*!**************************************!*\ - !*** ./default/assets/css/main.sass ***! - \**************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); - -/***/ }), - -/***/ "./default/assets/js/src/bootstrap.ts": -/*!********************************************!*\ - !*** ./default/assets/js/src/bootstrap.ts ***! - \********************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Application.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/Application.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Component.ts": -/*!****************************************************!*\ - !*** ./default/assets/js/src/typedoc/Component.ts ***! - \****************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/EventTarget.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Filter.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": -/*!*******************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! - \*******************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Search.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Search.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Signature.ts": -/*!***************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! - \***************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": -/*!*********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! - \*********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); - -/***/ }) - -/******/ }); -/************************************************************************/ -/******/ // The module cache -/******/ var __webpack_module_cache__ = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ // Check if module is in cache -/******/ if(__webpack_module_cache__[moduleId]) { -/******/ return __webpack_module_cache__[moduleId].exports; -/******/ } -/******/ // Create a new module (and put it into the cache) -/******/ var module = __webpack_module_cache__[moduleId] = { -/******/ // no module.id needed -/******/ // no module.loaded needed -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/************************************************************************/ -/******/ /* webpack/runtime/compat get default export */ -/******/ (() => { -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = (module) => { -/******/ var getter = module && module.__esModule ? -/******/ () => module['default'] : -/******/ () => module; -/******/ __webpack_require__.d(getter, { a: getter }); -/******/ return getter; -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/define property getters */ -/******/ (() => { -/******/ // define getter functions for harmony exports -/******/ __webpack_require__.d = (exports, definition) => { -/******/ for(var key in definition) { -/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { -/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); -/******/ } -/******/ } -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/hasOwnProperty shorthand */ -/******/ (() => { -/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) -/******/ })(); -/******/ -/******/ /* webpack/runtime/make namespace object */ -/******/ (() => { -/******/ // define __esModule on exports -/******/ __webpack_require__.r = (exports) => { -/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { -/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); -/******/ } -/******/ Object.defineProperty(exports, '__esModule', { value: true }); -/******/ }; -/******/ })(); -/******/ -/************************************************************************/ -/******/ // startup -/******/ // Load entry module -/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); -/******/ // This entry module used 'exports' so it can't be inlined -/******/ })() -; \ No newline at end of file diff --git a/packages/xarc-react-router/docs/assets/js/search.js b/packages/xarc-react-router/docs/assets/js/search.js deleted file mode 100644 index 6b791530b..000000000 --- a/packages/xarc-react-router/docs/assets/js/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = {"kinds":{"1":"Module","32":"Variable","64":"Function","1024":"Property","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":1,"name":"browser","url":"modules/browser.html","classes":"tsd-kind-module"},{"id":1,"kind":1,"name":"browser/react-router-browser","url":"modules/browser_react_router_browser.html","classes":"tsd-kind-module"},{"id":2,"kind":64,"name":"reactRouterFeature","url":"modules/browser_react_router_browser.html#reactrouterfeature","classes":"tsd-kind-function tsd-parent-kind-module","parent":"browser/react-router-browser"},{"id":3,"kind":1,"name":"common","url":"modules/common.html","classes":"tsd-kind-module"},{"id":4,"kind":4194304,"name":"ReactRouterFeatureOptions","url":"modules/common.html#reactrouterfeatureoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"common"},{"id":5,"kind":65536,"name":"__type","url":"modules/common.html#reactrouterfeatureoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"common.ReactRouterFeatureOptions"},{"id":6,"kind":1024,"name":"React","url":"modules/common.html#reactrouterfeatureoptions.__type.react","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactRouterFeatureOptions.__type"},{"id":7,"kind":1024,"name":"history","url":"modules/common.html#reactrouterfeatureoptions.__type.history","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"common.ReactRouterFeatureOptions.__type"},{"id":8,"kind":32,"name":"_id","url":"modules/common.html#_id","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"common"},{"id":9,"kind":32,"name":"_subId","url":"modules/common.html#_subid","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"common"},{"id":10,"kind":1,"name":"node","url":"modules/node.html","classes":"tsd-kind-module"},{"id":11,"kind":1,"name":"node/react-router-node","url":"modules/node_react_router_node.html","classes":"tsd-kind-module"},{"id":12,"kind":64,"name":"reactRouterFeature","url":"modules/node_react_router_node.html#reactrouterfeature","classes":"tsd-kind-function tsd-parent-kind-module","parent":"node/react-router-node"},{"id":13,"kind":16777216,"name":"reactRouterFeature","url":"modules/browser.html#reactrouterfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":14,"kind":16777216,"name":"ReactRouterFeatureOptions","url":"modules/browser.html#reactrouterfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":15,"kind":16777216,"name":"_id","url":"modules/browser.html#_id","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":16,"kind":16777216,"name":"_subId","url":"modules/browser.html#_subid","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":17,"kind":64,"name":"ReactRouterDom","url":"modules/browser.html#reactrouterdom","classes":"tsd-kind-function tsd-parent-kind-module","parent":"browser"},{"id":18,"kind":16777216,"name":"ReactRouter","url":"modules/browser.html#reactrouter","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"browser"},{"id":19,"kind":16777216,"name":"ReactRouterDom","url":"modules/common.html#reactrouterdom","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":20,"kind":16777216,"name":"ReactRouter","url":"modules/common.html#reactrouter","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"common"},{"id":21,"kind":16777216,"name":"reactRouterFeature","url":"modules/node.html#reactrouterfeature","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":22,"kind":16777216,"name":"ReactRouterFeatureOptions","url":"modules/node.html#reactrouterfeatureoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":23,"kind":16777216,"name":"_id","url":"modules/node.html#_id","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":24,"kind":16777216,"name":"_subId","url":"modules/node.html#_subid","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":25,"kind":16777216,"name":"ReactRouterDom","url":"modules/node.html#reactrouterdom","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"},{"id":26,"kind":16777216,"name":"ReactRouter","url":"modules/node.html#reactrouter","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"node"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,11.411]],["parent/0",[]],["name/1",[0,6.512,1,14.555,2,11.014]],["parent/1",[]],["name/2",[3,19.3]],["parent/2",[0,0.579,1,1.295,2,0.98]],["name/3",[4,15.418]],["parent/3",[]],["name/4",[5,21.953]],["parent/4",[4,1.438]],["name/5",[6,30.898]],["parent/5",[7,2.881]],["name/6",[8,30.898]],["parent/6",[9,2.378]],["name/7",[10,30.898]],["parent/7",[9,2.378]],["name/8",[11,21.953]],["parent/8",[4,1.438]],["name/9",[12,21.953]],["parent/9",[4,1.438]],["name/10",[13,11.411]],["parent/10",[]],["name/11",[2,11.014,13,6.512,14,14.555]],["parent/11",[]],["name/12",[3,19.3]],["parent/12",[2,0.98,13,0.579,14,1.295]],["name/13",[3,19.3]],["parent/13",[0,1.064]],["name/14",[5,21.953]],["parent/14",[0,1.064]],["name/15",[11,21.953]],["parent/15",[0,1.064]],["name/16",[12,21.953]],["parent/16",[0,1.064]],["name/17",[15,21.953]],["parent/17",[0,1.064]],["name/18",[16,21.953]],["parent/18",[0,1.064]],["name/19",[15,21.953]],["parent/19",[4,1.438]],["name/20",[16,21.953]],["parent/20",[4,1.438]],["name/21",[3,19.3]],["parent/21",[13,1.064]],["name/22",[5,21.953]],["parent/22",[13,1.064]],["name/23",[11,21.953]],["parent/23",[13,1.064]],["name/24",[12,21.953]],["parent/24",[13,1.064]],["name/25",[15,21.953]],["parent/25",[13,1.064]],["name/26",[16,21.953]],["parent/26",[13,1.064]]],"invertedIndex":[["__type",{"_index":6,"name":{"5":{}},"parent":{}}],["_id",{"_index":11,"name":{"8":{},"15":{},"23":{}},"parent":{}}],["_subid",{"_index":12,"name":{"9":{},"16":{},"24":{}},"parent":{}}],["browser",{"_index":0,"name":{"0":{},"1":{}},"parent":{"2":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{}}}],["browser/react",{"_index":1,"name":{"1":{}},"parent":{"2":{}}}],["common",{"_index":4,"name":{"3":{}},"parent":{"4":{},"8":{},"9":{},"19":{},"20":{}}}],["common.reactrouterfeatureoptions",{"_index":7,"name":{},"parent":{"5":{}}}],["common.reactrouterfeatureoptions.__type",{"_index":9,"name":{},"parent":{"6":{},"7":{}}}],["history",{"_index":10,"name":{"7":{}},"parent":{}}],["node",{"_index":13,"name":{"10":{},"11":{}},"parent":{"12":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{}}}],["node/react",{"_index":14,"name":{"11":{}},"parent":{"12":{}}}],["react",{"_index":8,"name":{"6":{}},"parent":{}}],["reactrouter",{"_index":16,"name":{"18":{},"20":{},"26":{}},"parent":{}}],["reactrouterdom",{"_index":15,"name":{"17":{},"19":{},"25":{}},"parent":{}}],["reactrouterfeature",{"_index":3,"name":{"2":{},"12":{},"13":{},"21":{}},"parent":{}}],["reactrouterfeatureoptions",{"_index":5,"name":{"4":{},"14":{},"22":{}},"parent":{}}],["router",{"_index":2,"name":{"1":{},"11":{}},"parent":{"2":{},"12":{}}}]],"pipeline":[]}} \ No newline at end of file diff --git a/packages/xarc-react-router/docs/assets/main.js b/packages/xarc-react-router/docs/assets/main.js new file mode 100644 index 000000000..bd45452db --- /dev/null +++ b/packages/xarc-react-router/docs/assets/main.js @@ -0,0 +1,52 @@ +(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,u],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/packages/xarc-react-router/docs/assets/search.js b/packages/xarc-react-router/docs/assets/search.js new file mode 100644 index 000000000..fd4d17764 --- /dev/null +++ b/packages/xarc-react-router/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\",\"16777216\":\"Reference\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"browser\",\"url\":\"modules/browser.html\",\"classes\":\"tsd-kind-module\"},{\"id\":1,\"kind\":2,\"name\":\"browser/react-router-browser\",\"url\":\"modules/browser_react_router_browser.html\",\"classes\":\"tsd-kind-module\"},{\"id\":2,\"kind\":64,\"name\":\"reactRouterFeature\",\"url\":\"modules/browser_react_router_browser.html#reactRouterFeature\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"browser/react-router-browser\"},{\"id\":3,\"kind\":2,\"name\":\"common\",\"url\":\"modules/common.html\",\"classes\":\"tsd-kind-module\"},{\"id\":4,\"kind\":4194304,\"name\":\"ReactRouterFeatureOptions\",\"url\":\"modules/common.html#ReactRouterFeatureOptions\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":5,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/common.html#ReactRouterFeatureOptions.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"common.ReactRouterFeatureOptions\"},{\"id\":6,\"kind\":1024,\"name\":\"React\",\"url\":\"modules/common.html#ReactRouterFeatureOptions.__type.React\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactRouterFeatureOptions.__type\"},{\"id\":7,\"kind\":1024,\"name\":\"history\",\"url\":\"modules/common.html#ReactRouterFeatureOptions.__type.history\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"common.ReactRouterFeatureOptions.__type\"},{\"id\":8,\"kind\":32,\"name\":\"_id\",\"url\":\"modules/common.html#_id\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":9,\"kind\":32,\"name\":\"_subId\",\"url\":\"modules/common.html#_subId\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":10,\"kind\":2,\"name\":\"node\",\"url\":\"modules/node.html\",\"classes\":\"tsd-kind-module\"},{\"id\":11,\"kind\":2,\"name\":\"node/react-router-node\",\"url\":\"modules/node_react_router_node.html\",\"classes\":\"tsd-kind-module\"},{\"id\":12,\"kind\":64,\"name\":\"reactRouterFeature\",\"url\":\"modules/node_react_router_node.html#reactRouterFeature\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"node/react-router-node\"},{\"id\":13,\"kind\":16777216,\"name\":\"reactRouterFeature\",\"url\":\"modules/browser.html#reactRouterFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":14,\"kind\":16777216,\"name\":\"ReactRouterFeatureOptions\",\"url\":\"modules/browser.html#ReactRouterFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":15,\"kind\":16777216,\"name\":\"_id\",\"url\":\"modules/browser.html#_id\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":16,\"kind\":16777216,\"name\":\"_subId\",\"url\":\"modules/browser.html#_subId\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":17,\"kind\":16777216,\"name\":\"FormEncType\",\"url\":\"modules/browser.html#FormEncType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":18,\"kind\":16777216,\"name\":\"FormMethod\",\"url\":\"modules/browser.html#FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":19,\"kind\":16777216,\"name\":\"GetScrollRestorationKeyFunction\",\"url\":\"modules/browser.html#GetScrollRestorationKeyFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":20,\"kind\":16777216,\"name\":\"ParamKeyValuePair\",\"url\":\"modules/browser.html#ParamKeyValuePair\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":21,\"kind\":16777216,\"name\":\"SubmitOptions\",\"url\":\"modules/browser.html#SubmitOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":22,\"kind\":16777216,\"name\":\"URLSearchParamsInit\",\"url\":\"modules/browser.html#URLSearchParamsInit\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":23,\"kind\":16777216,\"name\":\"V7_FormMethod\",\"url\":\"modules/browser.html#V7_FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":24,\"kind\":16777216,\"name\":\"createSearchParams\",\"url\":\"modules/browser.html#createSearchParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":25,\"kind\":16777216,\"name\":\"ActionFunction\",\"url\":\"modules/browser.html#ActionFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":26,\"kind\":16777216,\"name\":\"ActionFunctionArgs\",\"url\":\"modules/browser.html#ActionFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":27,\"kind\":16777216,\"name\":\"AwaitProps\",\"url\":\"modules/browser.html#AwaitProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":28,\"kind\":16777216,\"name\":\"unstable_Blocker\",\"url\":\"modules/browser.html#unstable_Blocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":29,\"kind\":16777216,\"name\":\"unstable_BlockerFunction\",\"url\":\"modules/browser.html#unstable_BlockerFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":30,\"kind\":16777216,\"name\":\"DataRouteMatch\",\"url\":\"modules/browser.html#DataRouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":31,\"kind\":16777216,\"name\":\"DataRouteObject\",\"url\":\"modules/browser.html#DataRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":32,\"kind\":16777216,\"name\":\"Fetcher\",\"url\":\"modules/browser.html#Fetcher\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":33,\"kind\":16777216,\"name\":\"Hash\",\"url\":\"modules/browser.html#Hash\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":34,\"kind\":16777216,\"name\":\"IndexRouteObject\",\"url\":\"modules/browser.html#IndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":35,\"kind\":16777216,\"name\":\"IndexRouteProps\",\"url\":\"modules/browser.html#IndexRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":36,\"kind\":16777216,\"name\":\"JsonFunction\",\"url\":\"modules/browser.html#JsonFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":37,\"kind\":16777216,\"name\":\"LazyRouteFunction\",\"url\":\"modules/browser.html#LazyRouteFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":38,\"kind\":16777216,\"name\":\"LayoutRouteProps\",\"url\":\"modules/browser.html#LayoutRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":39,\"kind\":16777216,\"name\":\"LoaderFunction\",\"url\":\"modules/browser.html#LoaderFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":40,\"kind\":16777216,\"name\":\"LoaderFunctionArgs\",\"url\":\"modules/browser.html#LoaderFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":41,\"kind\":16777216,\"name\":\"Location\",\"url\":\"modules/browser.html#Location\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":42,\"kind\":16777216,\"name\":\"MemoryRouterProps\",\"url\":\"modules/browser.html#MemoryRouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":43,\"kind\":16777216,\"name\":\"NavigateFunction\",\"url\":\"modules/browser.html#NavigateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":44,\"kind\":16777216,\"name\":\"NavigateOptions\",\"url\":\"modules/browser.html#NavigateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":45,\"kind\":16777216,\"name\":\"NavigateProps\",\"url\":\"modules/browser.html#NavigateProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":46,\"kind\":16777216,\"name\":\"Navigation\",\"url\":\"modules/browser.html#Navigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":47,\"kind\":16777216,\"name\":\"Navigator\",\"url\":\"modules/browser.html#Navigator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":48,\"kind\":16777216,\"name\":\"NonIndexRouteObject\",\"url\":\"modules/browser.html#NonIndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":49,\"kind\":16777216,\"name\":\"OutletProps\",\"url\":\"modules/browser.html#OutletProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":50,\"kind\":16777216,\"name\":\"Params\",\"url\":\"modules/browser.html#Params\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":51,\"kind\":16777216,\"name\":\"ParamParseKey\",\"url\":\"modules/browser.html#ParamParseKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":52,\"kind\":16777216,\"name\":\"Path\",\"url\":\"modules/browser.html#Path\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":53,\"kind\":16777216,\"name\":\"PathMatch\",\"url\":\"modules/browser.html#PathMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":54,\"kind\":16777216,\"name\":\"Pathname\",\"url\":\"modules/browser.html#Pathname\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":55,\"kind\":16777216,\"name\":\"PathPattern\",\"url\":\"modules/browser.html#PathPattern\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":56,\"kind\":16777216,\"name\":\"PathRouteProps\",\"url\":\"modules/browser.html#PathRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":57,\"kind\":16777216,\"name\":\"RedirectFunction\",\"url\":\"modules/browser.html#RedirectFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":58,\"kind\":16777216,\"name\":\"RelativeRoutingType\",\"url\":\"modules/browser.html#RelativeRoutingType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":59,\"kind\":16777216,\"name\":\"RouteMatch\",\"url\":\"modules/browser.html#RouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":60,\"kind\":16777216,\"name\":\"RouteObject\",\"url\":\"modules/browser.html#RouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":61,\"kind\":16777216,\"name\":\"RouteProps\",\"url\":\"modules/browser.html#RouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":62,\"kind\":16777216,\"name\":\"RouterProps\",\"url\":\"modules/browser.html#RouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":63,\"kind\":16777216,\"name\":\"RouterProviderProps\",\"url\":\"modules/browser.html#RouterProviderProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":64,\"kind\":16777216,\"name\":\"RoutesProps\",\"url\":\"modules/browser.html#RoutesProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":65,\"kind\":16777216,\"name\":\"Search\",\"url\":\"modules/browser.html#Search\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":66,\"kind\":16777216,\"name\":\"ShouldRevalidateFunction\",\"url\":\"modules/browser.html#ShouldRevalidateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":67,\"kind\":16777216,\"name\":\"To\",\"url\":\"modules/browser.html#To\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":68,\"kind\":16777216,\"name\":\"AbortedDeferredError\",\"url\":\"modules/browser.html#AbortedDeferredError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":69,\"kind\":16777216,\"name\":\"Await\",\"url\":\"modules/browser.html#Await\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":70,\"kind\":16777216,\"name\":\"MemoryRouter\",\"url\":\"modules/browser.html#MemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":71,\"kind\":16777216,\"name\":\"Navigate\",\"url\":\"modules/browser.html#Navigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":72,\"kind\":16777216,\"name\":\"NavigationType\",\"url\":\"modules/browser.html#NavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":73,\"kind\":16777216,\"name\":\"Outlet\",\"url\":\"modules/browser.html#Outlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":74,\"kind\":16777216,\"name\":\"Route\",\"url\":\"modules/browser.html#Route\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":75,\"kind\":16777216,\"name\":\"Router\",\"url\":\"modules/browser.html#Router\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":76,\"kind\":16777216,\"name\":\"RouterProvider\",\"url\":\"modules/browser.html#RouterProvider\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":77,\"kind\":16777216,\"name\":\"Routes\",\"url\":\"modules/browser.html#Routes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":78,\"kind\":16777216,\"name\":\"createMemoryRouter\",\"url\":\"modules/browser.html#createMemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":79,\"kind\":16777216,\"name\":\"createPath\",\"url\":\"modules/browser.html#createPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":80,\"kind\":16777216,\"name\":\"createRoutesFromChildren\",\"url\":\"modules/browser.html#createRoutesFromChildren\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":81,\"kind\":16777216,\"name\":\"createRoutesFromElements\",\"url\":\"modules/browser.html#createRoutesFromElements\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":82,\"kind\":16777216,\"name\":\"defer\",\"url\":\"modules/browser.html#defer\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":83,\"kind\":16777216,\"name\":\"isRouteErrorResponse\",\"url\":\"modules/browser.html#isRouteErrorResponse\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":84,\"kind\":16777216,\"name\":\"generatePath\",\"url\":\"modules/browser.html#generatePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":85,\"kind\":16777216,\"name\":\"json\",\"url\":\"modules/browser.html#json\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":86,\"kind\":16777216,\"name\":\"matchPath\",\"url\":\"modules/browser.html#matchPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":87,\"kind\":16777216,\"name\":\"matchRoutes\",\"url\":\"modules/browser.html#matchRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":88,\"kind\":16777216,\"name\":\"parsePath\",\"url\":\"modules/browser.html#parsePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":89,\"kind\":16777216,\"name\":\"redirect\",\"url\":\"modules/browser.html#redirect\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":90,\"kind\":16777216,\"name\":\"redirectDocument\",\"url\":\"modules/browser.html#redirectDocument\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":91,\"kind\":16777216,\"name\":\"renderMatches\",\"url\":\"modules/browser.html#renderMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":92,\"kind\":16777216,\"name\":\"resolvePath\",\"url\":\"modules/browser.html#resolvePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":93,\"kind\":16777216,\"name\":\"useActionData\",\"url\":\"modules/browser.html#useActionData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":94,\"kind\":16777216,\"name\":\"useAsyncError\",\"url\":\"modules/browser.html#useAsyncError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":95,\"kind\":16777216,\"name\":\"useAsyncValue\",\"url\":\"modules/browser.html#useAsyncValue\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":96,\"kind\":16777216,\"name\":\"unstable_useBlocker\",\"url\":\"modules/browser.html#unstable_useBlocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":97,\"kind\":16777216,\"name\":\"useHref\",\"url\":\"modules/browser.html#useHref\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":98,\"kind\":16777216,\"name\":\"useInRouterContext\",\"url\":\"modules/browser.html#useInRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":99,\"kind\":16777216,\"name\":\"useLoaderData\",\"url\":\"modules/browser.html#useLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":100,\"kind\":16777216,\"name\":\"useLocation\",\"url\":\"modules/browser.html#useLocation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":101,\"kind\":16777216,\"name\":\"useMatch\",\"url\":\"modules/browser.html#useMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":102,\"kind\":16777216,\"name\":\"useMatches\",\"url\":\"modules/browser.html#useMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":103,\"kind\":16777216,\"name\":\"useNavigate\",\"url\":\"modules/browser.html#useNavigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":104,\"kind\":16777216,\"name\":\"useNavigation\",\"url\":\"modules/browser.html#useNavigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":105,\"kind\":16777216,\"name\":\"useNavigationType\",\"url\":\"modules/browser.html#useNavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":106,\"kind\":16777216,\"name\":\"useOutlet\",\"url\":\"modules/browser.html#useOutlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":107,\"kind\":16777216,\"name\":\"useOutletContext\",\"url\":\"modules/browser.html#useOutletContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":108,\"kind\":16777216,\"name\":\"useParams\",\"url\":\"modules/browser.html#useParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":109,\"kind\":16777216,\"name\":\"useResolvedPath\",\"url\":\"modules/browser.html#useResolvedPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":110,\"kind\":16777216,\"name\":\"useRevalidator\",\"url\":\"modules/browser.html#useRevalidator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":111,\"kind\":16777216,\"name\":\"useRouteError\",\"url\":\"modules/browser.html#useRouteError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":112,\"kind\":16777216,\"name\":\"useRouteLoaderData\",\"url\":\"modules/browser.html#useRouteLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":113,\"kind\":16777216,\"name\":\"useRoutes\",\"url\":\"modules/browser.html#useRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":114,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterContext\",\"url\":\"modules/browser.html#UNSAFE_DataRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":115,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterStateContext\",\"url\":\"modules/browser.html#UNSAFE_DataRouterStateContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":116,\"kind\":16777216,\"name\":\"UNSAFE_NavigationContext\",\"url\":\"modules/browser.html#UNSAFE_NavigationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":117,\"kind\":16777216,\"name\":\"UNSAFE_LocationContext\",\"url\":\"modules/browser.html#UNSAFE_LocationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":118,\"kind\":16777216,\"name\":\"UNSAFE_RouteContext\",\"url\":\"modules/browser.html#UNSAFE_RouteContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":119,\"kind\":16777216,\"name\":\"UNSAFE_useRouteId\",\"url\":\"modules/browser.html#UNSAFE_useRouteId\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":120,\"kind\":16777216,\"name\":\"unstable_HistoryRouter\",\"url\":\"modules/browser.html#unstable_HistoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":121,\"kind\":16777216,\"name\":\"UNSAFE_useScrollRestoration\",\"url\":\"modules/browser.html#UNSAFE_useScrollRestoration\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":122,\"kind\":16777216,\"name\":\"unstable_usePrompt\",\"url\":\"modules/browser.html#unstable_usePrompt\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"browser\"},{\"id\":123,\"kind\":16777216,\"name\":\"ReactRouterDom\",\"url\":\"modules/common.html#ReactRouterDom\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":124,\"kind\":16777216,\"name\":\"ReactRouter\",\"url\":\"modules/common.html#ReactRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":125,\"kind\":16777216,\"name\":\"FormEncType\",\"url\":\"modules/common.html#FormEncType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":126,\"kind\":16777216,\"name\":\"FormMethod\",\"url\":\"modules/common.html#FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":127,\"kind\":16777216,\"name\":\"GetScrollRestorationKeyFunction\",\"url\":\"modules/common.html#GetScrollRestorationKeyFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":128,\"kind\":16777216,\"name\":\"ParamKeyValuePair\",\"url\":\"modules/common.html#ParamKeyValuePair\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":129,\"kind\":16777216,\"name\":\"SubmitOptions\",\"url\":\"modules/common.html#SubmitOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":130,\"kind\":16777216,\"name\":\"URLSearchParamsInit\",\"url\":\"modules/common.html#URLSearchParamsInit\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":131,\"kind\":16777216,\"name\":\"V7_FormMethod\",\"url\":\"modules/common.html#V7_FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":132,\"kind\":16777216,\"name\":\"createSearchParams\",\"url\":\"modules/common.html#createSearchParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":133,\"kind\":16777216,\"name\":\"ActionFunction\",\"url\":\"modules/common.html#ActionFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":134,\"kind\":16777216,\"name\":\"ActionFunctionArgs\",\"url\":\"modules/common.html#ActionFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":135,\"kind\":16777216,\"name\":\"AwaitProps\",\"url\":\"modules/common.html#AwaitProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":136,\"kind\":16777216,\"name\":\"unstable_Blocker\",\"url\":\"modules/common.html#unstable_Blocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":137,\"kind\":16777216,\"name\":\"unstable_BlockerFunction\",\"url\":\"modules/common.html#unstable_BlockerFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":138,\"kind\":16777216,\"name\":\"DataRouteMatch\",\"url\":\"modules/common.html#DataRouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":139,\"kind\":16777216,\"name\":\"DataRouteObject\",\"url\":\"modules/common.html#DataRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":140,\"kind\":16777216,\"name\":\"Fetcher\",\"url\":\"modules/common.html#Fetcher\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":141,\"kind\":16777216,\"name\":\"Hash\",\"url\":\"modules/common.html#Hash\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":142,\"kind\":16777216,\"name\":\"IndexRouteObject\",\"url\":\"modules/common.html#IndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":143,\"kind\":16777216,\"name\":\"IndexRouteProps\",\"url\":\"modules/common.html#IndexRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":144,\"kind\":16777216,\"name\":\"JsonFunction\",\"url\":\"modules/common.html#JsonFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":145,\"kind\":16777216,\"name\":\"LazyRouteFunction\",\"url\":\"modules/common.html#LazyRouteFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":146,\"kind\":16777216,\"name\":\"LayoutRouteProps\",\"url\":\"modules/common.html#LayoutRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":147,\"kind\":16777216,\"name\":\"LoaderFunction\",\"url\":\"modules/common.html#LoaderFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":148,\"kind\":16777216,\"name\":\"LoaderFunctionArgs\",\"url\":\"modules/common.html#LoaderFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":149,\"kind\":16777216,\"name\":\"Location\",\"url\":\"modules/common.html#Location\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":150,\"kind\":16777216,\"name\":\"MemoryRouterProps\",\"url\":\"modules/common.html#MemoryRouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":151,\"kind\":16777216,\"name\":\"NavigateFunction\",\"url\":\"modules/common.html#NavigateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":152,\"kind\":16777216,\"name\":\"NavigateOptions\",\"url\":\"modules/common.html#NavigateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":153,\"kind\":16777216,\"name\":\"NavigateProps\",\"url\":\"modules/common.html#NavigateProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":154,\"kind\":16777216,\"name\":\"Navigation\",\"url\":\"modules/common.html#Navigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":155,\"kind\":16777216,\"name\":\"Navigator\",\"url\":\"modules/common.html#Navigator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":156,\"kind\":16777216,\"name\":\"NonIndexRouteObject\",\"url\":\"modules/common.html#NonIndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":157,\"kind\":16777216,\"name\":\"OutletProps\",\"url\":\"modules/common.html#OutletProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":158,\"kind\":16777216,\"name\":\"Params\",\"url\":\"modules/common.html#Params\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":159,\"kind\":16777216,\"name\":\"ParamParseKey\",\"url\":\"modules/common.html#ParamParseKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":160,\"kind\":16777216,\"name\":\"Path\",\"url\":\"modules/common.html#Path\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":161,\"kind\":16777216,\"name\":\"PathMatch\",\"url\":\"modules/common.html#PathMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":162,\"kind\":16777216,\"name\":\"Pathname\",\"url\":\"modules/common.html#Pathname\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":163,\"kind\":16777216,\"name\":\"PathPattern\",\"url\":\"modules/common.html#PathPattern\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":164,\"kind\":16777216,\"name\":\"PathRouteProps\",\"url\":\"modules/common.html#PathRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":165,\"kind\":16777216,\"name\":\"RedirectFunction\",\"url\":\"modules/common.html#RedirectFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":166,\"kind\":16777216,\"name\":\"RelativeRoutingType\",\"url\":\"modules/common.html#RelativeRoutingType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":167,\"kind\":16777216,\"name\":\"RouteMatch\",\"url\":\"modules/common.html#RouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":168,\"kind\":16777216,\"name\":\"RouteObject\",\"url\":\"modules/common.html#RouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":169,\"kind\":16777216,\"name\":\"RouteProps\",\"url\":\"modules/common.html#RouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":170,\"kind\":16777216,\"name\":\"RouterProps\",\"url\":\"modules/common.html#RouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":171,\"kind\":16777216,\"name\":\"RouterProviderProps\",\"url\":\"modules/common.html#RouterProviderProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":172,\"kind\":16777216,\"name\":\"RoutesProps\",\"url\":\"modules/common.html#RoutesProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":173,\"kind\":16777216,\"name\":\"Search\",\"url\":\"modules/common.html#Search\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":174,\"kind\":16777216,\"name\":\"ShouldRevalidateFunction\",\"url\":\"modules/common.html#ShouldRevalidateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":175,\"kind\":16777216,\"name\":\"To\",\"url\":\"modules/common.html#To\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":176,\"kind\":16777216,\"name\":\"AbortedDeferredError\",\"url\":\"modules/common.html#AbortedDeferredError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":177,\"kind\":16777216,\"name\":\"Await\",\"url\":\"modules/common.html#Await\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":178,\"kind\":16777216,\"name\":\"MemoryRouter\",\"url\":\"modules/common.html#MemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":179,\"kind\":16777216,\"name\":\"Navigate\",\"url\":\"modules/common.html#Navigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":180,\"kind\":16777216,\"name\":\"NavigationType\",\"url\":\"modules/common.html#NavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":181,\"kind\":16777216,\"name\":\"Outlet\",\"url\":\"modules/common.html#Outlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":182,\"kind\":16777216,\"name\":\"Route\",\"url\":\"modules/common.html#Route\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":183,\"kind\":16777216,\"name\":\"Router\",\"url\":\"modules/common.html#Router\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":184,\"kind\":16777216,\"name\":\"RouterProvider\",\"url\":\"modules/common.html#RouterProvider\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":185,\"kind\":16777216,\"name\":\"Routes\",\"url\":\"modules/common.html#Routes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":186,\"kind\":16777216,\"name\":\"createMemoryRouter\",\"url\":\"modules/common.html#createMemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":187,\"kind\":16777216,\"name\":\"createPath\",\"url\":\"modules/common.html#createPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":188,\"kind\":16777216,\"name\":\"createRoutesFromChildren\",\"url\":\"modules/common.html#createRoutesFromChildren\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":189,\"kind\":16777216,\"name\":\"createRoutesFromElements\",\"url\":\"modules/common.html#createRoutesFromElements\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":190,\"kind\":16777216,\"name\":\"defer\",\"url\":\"modules/common.html#defer\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":191,\"kind\":16777216,\"name\":\"isRouteErrorResponse\",\"url\":\"modules/common.html#isRouteErrorResponse\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":192,\"kind\":16777216,\"name\":\"generatePath\",\"url\":\"modules/common.html#generatePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":193,\"kind\":16777216,\"name\":\"json\",\"url\":\"modules/common.html#json\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":194,\"kind\":16777216,\"name\":\"matchPath\",\"url\":\"modules/common.html#matchPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":195,\"kind\":16777216,\"name\":\"matchRoutes\",\"url\":\"modules/common.html#matchRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":196,\"kind\":16777216,\"name\":\"parsePath\",\"url\":\"modules/common.html#parsePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":197,\"kind\":16777216,\"name\":\"redirect\",\"url\":\"modules/common.html#redirect\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":198,\"kind\":16777216,\"name\":\"redirectDocument\",\"url\":\"modules/common.html#redirectDocument\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":199,\"kind\":16777216,\"name\":\"renderMatches\",\"url\":\"modules/common.html#renderMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":200,\"kind\":16777216,\"name\":\"resolvePath\",\"url\":\"modules/common.html#resolvePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":201,\"kind\":16777216,\"name\":\"useActionData\",\"url\":\"modules/common.html#useActionData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":202,\"kind\":16777216,\"name\":\"useAsyncError\",\"url\":\"modules/common.html#useAsyncError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":203,\"kind\":16777216,\"name\":\"useAsyncValue\",\"url\":\"modules/common.html#useAsyncValue\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":204,\"kind\":16777216,\"name\":\"unstable_useBlocker\",\"url\":\"modules/common.html#unstable_useBlocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":205,\"kind\":16777216,\"name\":\"useHref\",\"url\":\"modules/common.html#useHref\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":206,\"kind\":16777216,\"name\":\"useInRouterContext\",\"url\":\"modules/common.html#useInRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":207,\"kind\":16777216,\"name\":\"useLoaderData\",\"url\":\"modules/common.html#useLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":208,\"kind\":16777216,\"name\":\"useLocation\",\"url\":\"modules/common.html#useLocation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":209,\"kind\":16777216,\"name\":\"useMatch\",\"url\":\"modules/common.html#useMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":210,\"kind\":16777216,\"name\":\"useMatches\",\"url\":\"modules/common.html#useMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":211,\"kind\":16777216,\"name\":\"useNavigate\",\"url\":\"modules/common.html#useNavigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":212,\"kind\":16777216,\"name\":\"useNavigation\",\"url\":\"modules/common.html#useNavigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":213,\"kind\":16777216,\"name\":\"useNavigationType\",\"url\":\"modules/common.html#useNavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":214,\"kind\":16777216,\"name\":\"useOutlet\",\"url\":\"modules/common.html#useOutlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":215,\"kind\":16777216,\"name\":\"useOutletContext\",\"url\":\"modules/common.html#useOutletContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":216,\"kind\":16777216,\"name\":\"useParams\",\"url\":\"modules/common.html#useParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":217,\"kind\":16777216,\"name\":\"useResolvedPath\",\"url\":\"modules/common.html#useResolvedPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":218,\"kind\":16777216,\"name\":\"useRevalidator\",\"url\":\"modules/common.html#useRevalidator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":219,\"kind\":16777216,\"name\":\"useRouteError\",\"url\":\"modules/common.html#useRouteError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":220,\"kind\":16777216,\"name\":\"useRouteLoaderData\",\"url\":\"modules/common.html#useRouteLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":221,\"kind\":16777216,\"name\":\"useRoutes\",\"url\":\"modules/common.html#useRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":222,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterContext\",\"url\":\"modules/common.html#UNSAFE_DataRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":223,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterStateContext\",\"url\":\"modules/common.html#UNSAFE_DataRouterStateContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":224,\"kind\":16777216,\"name\":\"UNSAFE_NavigationContext\",\"url\":\"modules/common.html#UNSAFE_NavigationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":225,\"kind\":16777216,\"name\":\"UNSAFE_LocationContext\",\"url\":\"modules/common.html#UNSAFE_LocationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":226,\"kind\":16777216,\"name\":\"UNSAFE_RouteContext\",\"url\":\"modules/common.html#UNSAFE_RouteContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":227,\"kind\":16777216,\"name\":\"UNSAFE_useRouteId\",\"url\":\"modules/common.html#UNSAFE_useRouteId\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":228,\"kind\":16777216,\"name\":\"unstable_HistoryRouter\",\"url\":\"modules/common.html#unstable_HistoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":229,\"kind\":16777216,\"name\":\"UNSAFE_useScrollRestoration\",\"url\":\"modules/common.html#UNSAFE_useScrollRestoration\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":230,\"kind\":16777216,\"name\":\"unstable_usePrompt\",\"url\":\"modules/common.html#unstable_usePrompt\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":231,\"kind\":16777216,\"name\":\"reactRouterFeature\",\"url\":\"modules/node.html#reactRouterFeature\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":232,\"kind\":16777216,\"name\":\"ReactRouterFeatureOptions\",\"url\":\"modules/node.html#ReactRouterFeatureOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":233,\"kind\":16777216,\"name\":\"_id\",\"url\":\"modules/node.html#_id\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":234,\"kind\":16777216,\"name\":\"_subId\",\"url\":\"modules/node.html#_subId\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":235,\"kind\":16777216,\"name\":\"ReactRouterDom\",\"url\":\"modules/node.html#ReactRouterDom\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":236,\"kind\":16777216,\"name\":\"ReactRouter\",\"url\":\"modules/node.html#ReactRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":237,\"kind\":16777216,\"name\":\"FormEncType\",\"url\":\"modules/node.html#FormEncType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":238,\"kind\":16777216,\"name\":\"FormMethod\",\"url\":\"modules/node.html#FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":239,\"kind\":16777216,\"name\":\"GetScrollRestorationKeyFunction\",\"url\":\"modules/node.html#GetScrollRestorationKeyFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":240,\"kind\":16777216,\"name\":\"ParamKeyValuePair\",\"url\":\"modules/node.html#ParamKeyValuePair\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":241,\"kind\":16777216,\"name\":\"SubmitOptions\",\"url\":\"modules/node.html#SubmitOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":242,\"kind\":16777216,\"name\":\"URLSearchParamsInit\",\"url\":\"modules/node.html#URLSearchParamsInit\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":243,\"kind\":16777216,\"name\":\"V7_FormMethod\",\"url\":\"modules/node.html#V7_FormMethod\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":244,\"kind\":16777216,\"name\":\"createSearchParams\",\"url\":\"modules/node.html#createSearchParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":245,\"kind\":16777216,\"name\":\"ActionFunction\",\"url\":\"modules/node.html#ActionFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":246,\"kind\":16777216,\"name\":\"ActionFunctionArgs\",\"url\":\"modules/node.html#ActionFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":247,\"kind\":16777216,\"name\":\"AwaitProps\",\"url\":\"modules/node.html#AwaitProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":248,\"kind\":16777216,\"name\":\"unstable_Blocker\",\"url\":\"modules/node.html#unstable_Blocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":249,\"kind\":16777216,\"name\":\"unstable_BlockerFunction\",\"url\":\"modules/node.html#unstable_BlockerFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":250,\"kind\":16777216,\"name\":\"DataRouteMatch\",\"url\":\"modules/node.html#DataRouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":251,\"kind\":16777216,\"name\":\"DataRouteObject\",\"url\":\"modules/node.html#DataRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":252,\"kind\":16777216,\"name\":\"Fetcher\",\"url\":\"modules/node.html#Fetcher\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":253,\"kind\":16777216,\"name\":\"Hash\",\"url\":\"modules/node.html#Hash\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":254,\"kind\":16777216,\"name\":\"IndexRouteObject\",\"url\":\"modules/node.html#IndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":255,\"kind\":16777216,\"name\":\"IndexRouteProps\",\"url\":\"modules/node.html#IndexRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":256,\"kind\":16777216,\"name\":\"JsonFunction\",\"url\":\"modules/node.html#JsonFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":257,\"kind\":16777216,\"name\":\"LazyRouteFunction\",\"url\":\"modules/node.html#LazyRouteFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":258,\"kind\":16777216,\"name\":\"LayoutRouteProps\",\"url\":\"modules/node.html#LayoutRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":259,\"kind\":16777216,\"name\":\"LoaderFunction\",\"url\":\"modules/node.html#LoaderFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":260,\"kind\":16777216,\"name\":\"LoaderFunctionArgs\",\"url\":\"modules/node.html#LoaderFunctionArgs\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":261,\"kind\":16777216,\"name\":\"Location\",\"url\":\"modules/node.html#Location\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":262,\"kind\":16777216,\"name\":\"MemoryRouterProps\",\"url\":\"modules/node.html#MemoryRouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":263,\"kind\":16777216,\"name\":\"NavigateFunction\",\"url\":\"modules/node.html#NavigateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":264,\"kind\":16777216,\"name\":\"NavigateOptions\",\"url\":\"modules/node.html#NavigateOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":265,\"kind\":16777216,\"name\":\"NavigateProps\",\"url\":\"modules/node.html#NavigateProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":266,\"kind\":16777216,\"name\":\"Navigation\",\"url\":\"modules/node.html#Navigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":267,\"kind\":16777216,\"name\":\"Navigator\",\"url\":\"modules/node.html#Navigator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":268,\"kind\":16777216,\"name\":\"NonIndexRouteObject\",\"url\":\"modules/node.html#NonIndexRouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":269,\"kind\":16777216,\"name\":\"OutletProps\",\"url\":\"modules/node.html#OutletProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":270,\"kind\":16777216,\"name\":\"Params\",\"url\":\"modules/node.html#Params\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":271,\"kind\":16777216,\"name\":\"ParamParseKey\",\"url\":\"modules/node.html#ParamParseKey\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":272,\"kind\":16777216,\"name\":\"Path\",\"url\":\"modules/node.html#Path\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":273,\"kind\":16777216,\"name\":\"PathMatch\",\"url\":\"modules/node.html#PathMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":274,\"kind\":16777216,\"name\":\"Pathname\",\"url\":\"modules/node.html#Pathname\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":275,\"kind\":16777216,\"name\":\"PathPattern\",\"url\":\"modules/node.html#PathPattern\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":276,\"kind\":16777216,\"name\":\"PathRouteProps\",\"url\":\"modules/node.html#PathRouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":277,\"kind\":16777216,\"name\":\"RedirectFunction\",\"url\":\"modules/node.html#RedirectFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":278,\"kind\":16777216,\"name\":\"RelativeRoutingType\",\"url\":\"modules/node.html#RelativeRoutingType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":279,\"kind\":16777216,\"name\":\"RouteMatch\",\"url\":\"modules/node.html#RouteMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":280,\"kind\":16777216,\"name\":\"RouteObject\",\"url\":\"modules/node.html#RouteObject\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":281,\"kind\":16777216,\"name\":\"RouteProps\",\"url\":\"modules/node.html#RouteProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":282,\"kind\":16777216,\"name\":\"RouterProps\",\"url\":\"modules/node.html#RouterProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":283,\"kind\":16777216,\"name\":\"RouterProviderProps\",\"url\":\"modules/node.html#RouterProviderProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":284,\"kind\":16777216,\"name\":\"RoutesProps\",\"url\":\"modules/node.html#RoutesProps\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":285,\"kind\":16777216,\"name\":\"Search\",\"url\":\"modules/node.html#Search\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":286,\"kind\":16777216,\"name\":\"ShouldRevalidateFunction\",\"url\":\"modules/node.html#ShouldRevalidateFunction\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":287,\"kind\":16777216,\"name\":\"To\",\"url\":\"modules/node.html#To\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":288,\"kind\":16777216,\"name\":\"AbortedDeferredError\",\"url\":\"modules/node.html#AbortedDeferredError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":289,\"kind\":16777216,\"name\":\"Await\",\"url\":\"modules/node.html#Await\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":290,\"kind\":16777216,\"name\":\"MemoryRouter\",\"url\":\"modules/node.html#MemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":291,\"kind\":16777216,\"name\":\"Navigate\",\"url\":\"modules/node.html#Navigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":292,\"kind\":16777216,\"name\":\"NavigationType\",\"url\":\"modules/node.html#NavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":293,\"kind\":16777216,\"name\":\"Outlet\",\"url\":\"modules/node.html#Outlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":294,\"kind\":16777216,\"name\":\"Route\",\"url\":\"modules/node.html#Route\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":295,\"kind\":16777216,\"name\":\"Router\",\"url\":\"modules/node.html#Router\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":296,\"kind\":16777216,\"name\":\"RouterProvider\",\"url\":\"modules/node.html#RouterProvider\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":297,\"kind\":16777216,\"name\":\"Routes\",\"url\":\"modules/node.html#Routes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":298,\"kind\":16777216,\"name\":\"createMemoryRouter\",\"url\":\"modules/node.html#createMemoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":299,\"kind\":16777216,\"name\":\"createPath\",\"url\":\"modules/node.html#createPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":300,\"kind\":16777216,\"name\":\"createRoutesFromChildren\",\"url\":\"modules/node.html#createRoutesFromChildren\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":301,\"kind\":16777216,\"name\":\"createRoutesFromElements\",\"url\":\"modules/node.html#createRoutesFromElements\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":302,\"kind\":16777216,\"name\":\"defer\",\"url\":\"modules/node.html#defer\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":303,\"kind\":16777216,\"name\":\"isRouteErrorResponse\",\"url\":\"modules/node.html#isRouteErrorResponse\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":304,\"kind\":16777216,\"name\":\"generatePath\",\"url\":\"modules/node.html#generatePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":305,\"kind\":16777216,\"name\":\"json\",\"url\":\"modules/node.html#json\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":306,\"kind\":16777216,\"name\":\"matchPath\",\"url\":\"modules/node.html#matchPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":307,\"kind\":16777216,\"name\":\"matchRoutes\",\"url\":\"modules/node.html#matchRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":308,\"kind\":16777216,\"name\":\"parsePath\",\"url\":\"modules/node.html#parsePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":309,\"kind\":16777216,\"name\":\"redirect\",\"url\":\"modules/node.html#redirect\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":310,\"kind\":16777216,\"name\":\"redirectDocument\",\"url\":\"modules/node.html#redirectDocument\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":311,\"kind\":16777216,\"name\":\"renderMatches\",\"url\":\"modules/node.html#renderMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":312,\"kind\":16777216,\"name\":\"resolvePath\",\"url\":\"modules/node.html#resolvePath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":313,\"kind\":16777216,\"name\":\"useActionData\",\"url\":\"modules/node.html#useActionData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":314,\"kind\":16777216,\"name\":\"useAsyncError\",\"url\":\"modules/node.html#useAsyncError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":315,\"kind\":16777216,\"name\":\"useAsyncValue\",\"url\":\"modules/node.html#useAsyncValue\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":316,\"kind\":16777216,\"name\":\"unstable_useBlocker\",\"url\":\"modules/node.html#unstable_useBlocker\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":317,\"kind\":16777216,\"name\":\"useHref\",\"url\":\"modules/node.html#useHref\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":318,\"kind\":16777216,\"name\":\"useInRouterContext\",\"url\":\"modules/node.html#useInRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":319,\"kind\":16777216,\"name\":\"useLoaderData\",\"url\":\"modules/node.html#useLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":320,\"kind\":16777216,\"name\":\"useLocation\",\"url\":\"modules/node.html#useLocation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":321,\"kind\":16777216,\"name\":\"useMatch\",\"url\":\"modules/node.html#useMatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":322,\"kind\":16777216,\"name\":\"useMatches\",\"url\":\"modules/node.html#useMatches\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":323,\"kind\":16777216,\"name\":\"useNavigate\",\"url\":\"modules/node.html#useNavigate\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":324,\"kind\":16777216,\"name\":\"useNavigation\",\"url\":\"modules/node.html#useNavigation\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":325,\"kind\":16777216,\"name\":\"useNavigationType\",\"url\":\"modules/node.html#useNavigationType\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":326,\"kind\":16777216,\"name\":\"useOutlet\",\"url\":\"modules/node.html#useOutlet\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":327,\"kind\":16777216,\"name\":\"useOutletContext\",\"url\":\"modules/node.html#useOutletContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":328,\"kind\":16777216,\"name\":\"useParams\",\"url\":\"modules/node.html#useParams\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":329,\"kind\":16777216,\"name\":\"useResolvedPath\",\"url\":\"modules/node.html#useResolvedPath\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":330,\"kind\":16777216,\"name\":\"useRevalidator\",\"url\":\"modules/node.html#useRevalidator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":331,\"kind\":16777216,\"name\":\"useRouteError\",\"url\":\"modules/node.html#useRouteError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":332,\"kind\":16777216,\"name\":\"useRouteLoaderData\",\"url\":\"modules/node.html#useRouteLoaderData\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":333,\"kind\":16777216,\"name\":\"useRoutes\",\"url\":\"modules/node.html#useRoutes\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":334,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterContext\",\"url\":\"modules/node.html#UNSAFE_DataRouterContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":335,\"kind\":16777216,\"name\":\"UNSAFE_DataRouterStateContext\",\"url\":\"modules/node.html#UNSAFE_DataRouterStateContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":336,\"kind\":16777216,\"name\":\"UNSAFE_NavigationContext\",\"url\":\"modules/node.html#UNSAFE_NavigationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":337,\"kind\":16777216,\"name\":\"UNSAFE_LocationContext\",\"url\":\"modules/node.html#UNSAFE_LocationContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":338,\"kind\":16777216,\"name\":\"UNSAFE_RouteContext\",\"url\":\"modules/node.html#UNSAFE_RouteContext\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":339,\"kind\":16777216,\"name\":\"UNSAFE_useRouteId\",\"url\":\"modules/node.html#UNSAFE_useRouteId\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":340,\"kind\":16777216,\"name\":\"unstable_HistoryRouter\",\"url\":\"modules/node.html#unstable_HistoryRouter\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":341,\"kind\":16777216,\"name\":\"UNSAFE_useScrollRestoration\",\"url\":\"modules/node.html#UNSAFE_useScrollRestoration\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"},{\"id\":342,\"kind\":16777216,\"name\":\"unstable_usePrompt\",\"url\":\"modules/node.html#unstable_usePrompt\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"node\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,11.141]],[\"parent/0\",[]],[\"name/1\",[0,6.146,1,27.296,2,21.207]],[\"parent/1\",[]],[\"name/2\",[3,43.571]],[\"parent/2\",[0,0.609,1,2.703,2,2.1]],[\"name/3\",[4,11.23]],[\"parent/3\",[]],[\"name/4\",[5,46.096]],[\"parent/4\",[4,1.116]],[\"name/5\",[6,54.609]],[\"parent/5\",[7,5.429]],[\"name/6\",[8,54.609]],[\"parent/6\",[9,4.918]],[\"name/7\",[10,54.609]],[\"parent/7\",[9,4.918]],[\"name/8\",[11,46.096]],[\"parent/8\",[4,1.116]],[\"name/9\",[12,46.096]],[\"parent/9\",[4,1.116]],[\"name/10\",[13,10.965]],[\"parent/10\",[]],[\"name/11\",[2,21.207,13,6.05,14,27.296]],[\"parent/11\",[]],[\"name/12\",[3,43.571]],[\"parent/12\",[2,2.1,13,0.599,14,2.703]],[\"name/13\",[3,43.571]],[\"parent/13\",[0,1.108]],[\"name/14\",[5,46.096]],[\"parent/14\",[0,1.108]],[\"name/15\",[11,46.096]],[\"parent/15\",[0,1.108]],[\"name/16\",[12,46.096]],[\"parent/16\",[0,1.108]],[\"name/17\",[15,46.096]],[\"parent/17\",[0,1.108]],[\"name/18\",[16,46.096]],[\"parent/18\",[0,1.108]],[\"name/19\",[17,46.096]],[\"parent/19\",[0,1.108]],[\"name/20\",[18,46.096]],[\"parent/20\",[0,1.108]],[\"name/21\",[19,46.096]],[\"parent/21\",[0,1.108]],[\"name/22\",[20,46.096]],[\"parent/22\",[0,1.108]],[\"name/23\",[21,46.096]],[\"parent/23\",[0,1.108]],[\"name/24\",[22,46.096]],[\"parent/24\",[0,1.108]],[\"name/25\",[23,46.096]],[\"parent/25\",[0,1.108]],[\"name/26\",[24,46.096]],[\"parent/26\",[0,1.108]],[\"name/27\",[25,46.096]],[\"parent/27\",[0,1.108]],[\"name/28\",[26,46.096]],[\"parent/28\",[0,1.108]],[\"name/29\",[27,46.096]],[\"parent/29\",[0,1.108]],[\"name/30\",[28,46.096]],[\"parent/30\",[0,1.108]],[\"name/31\",[29,46.096]],[\"parent/31\",[0,1.108]],[\"name/32\",[30,46.096]],[\"parent/32\",[0,1.108]],[\"name/33\",[31,46.096]],[\"parent/33\",[0,1.108]],[\"name/34\",[32,46.096]],[\"parent/34\",[0,1.108]],[\"name/35\",[33,46.096]],[\"parent/35\",[0,1.108]],[\"name/36\",[34,46.096]],[\"parent/36\",[0,1.108]],[\"name/37\",[35,46.096]],[\"parent/37\",[0,1.108]],[\"name/38\",[36,46.096]],[\"parent/38\",[0,1.108]],[\"name/39\",[37,46.096]],[\"parent/39\",[0,1.108]],[\"name/40\",[38,46.096]],[\"parent/40\",[0,1.108]],[\"name/41\",[39,46.096]],[\"parent/41\",[0,1.108]],[\"name/42\",[40,46.096]],[\"parent/42\",[0,1.108]],[\"name/43\",[41,46.096]],[\"parent/43\",[0,1.108]],[\"name/44\",[42,46.096]],[\"parent/44\",[0,1.108]],[\"name/45\",[43,46.096]],[\"parent/45\",[0,1.108]],[\"name/46\",[44,46.096]],[\"parent/46\",[0,1.108]],[\"name/47\",[45,46.096]],[\"parent/47\",[0,1.108]],[\"name/48\",[46,46.096]],[\"parent/48\",[0,1.108]],[\"name/49\",[47,46.096]],[\"parent/49\",[0,1.108]],[\"name/50\",[48,46.096]],[\"parent/50\",[0,1.108]],[\"name/51\",[49,46.096]],[\"parent/51\",[0,1.108]],[\"name/52\",[50,46.096]],[\"parent/52\",[0,1.108]],[\"name/53\",[51,46.096]],[\"parent/53\",[0,1.108]],[\"name/54\",[52,46.096]],[\"parent/54\",[0,1.108]],[\"name/55\",[53,46.096]],[\"parent/55\",[0,1.108]],[\"name/56\",[54,46.096]],[\"parent/56\",[0,1.108]],[\"name/57\",[55,46.096]],[\"parent/57\",[0,1.108]],[\"name/58\",[56,46.096]],[\"parent/58\",[0,1.108]],[\"name/59\",[57,46.096]],[\"parent/59\",[0,1.108]],[\"name/60\",[58,46.096]],[\"parent/60\",[0,1.108]],[\"name/61\",[59,46.096]],[\"parent/61\",[0,1.108]],[\"name/62\",[60,46.096]],[\"parent/62\",[0,1.108]],[\"name/63\",[61,46.096]],[\"parent/63\",[0,1.108]],[\"name/64\",[62,46.096]],[\"parent/64\",[0,1.108]],[\"name/65\",[63,46.096]],[\"parent/65\",[0,1.108]],[\"name/66\",[64,46.096]],[\"parent/66\",[0,1.108]],[\"name/67\",[65,46.096]],[\"parent/67\",[0,1.108]],[\"name/68\",[66,46.096]],[\"parent/68\",[0,1.108]],[\"name/69\",[67,46.096]],[\"parent/69\",[0,1.108]],[\"name/70\",[68,46.096]],[\"parent/70\",[0,1.108]],[\"name/71\",[69,46.096]],[\"parent/71\",[0,1.108]],[\"name/72\",[70,46.096]],[\"parent/72\",[0,1.108]],[\"name/73\",[71,46.096]],[\"parent/73\",[0,1.108]],[\"name/74\",[72,46.096]],[\"parent/74\",[0,1.108]],[\"name/75\",[2,38.439]],[\"parent/75\",[0,1.108]],[\"name/76\",[73,46.096]],[\"parent/76\",[0,1.108]],[\"name/77\",[74,46.096]],[\"parent/77\",[0,1.108]],[\"name/78\",[75,46.096]],[\"parent/78\",[0,1.108]],[\"name/79\",[76,46.096]],[\"parent/79\",[0,1.108]],[\"name/80\",[77,46.096]],[\"parent/80\",[0,1.108]],[\"name/81\",[78,46.096]],[\"parent/81\",[0,1.108]],[\"name/82\",[79,46.096]],[\"parent/82\",[0,1.108]],[\"name/83\",[80,46.096]],[\"parent/83\",[0,1.108]],[\"name/84\",[81,46.096]],[\"parent/84\",[0,1.108]],[\"name/85\",[82,46.096]],[\"parent/85\",[0,1.108]],[\"name/86\",[83,46.096]],[\"parent/86\",[0,1.108]],[\"name/87\",[84,46.096]],[\"parent/87\",[0,1.108]],[\"name/88\",[85,46.096]],[\"parent/88\",[0,1.108]],[\"name/89\",[86,46.096]],[\"parent/89\",[0,1.108]],[\"name/90\",[87,46.096]],[\"parent/90\",[0,1.108]],[\"name/91\",[88,46.096]],[\"parent/91\",[0,1.108]],[\"name/92\",[89,46.096]],[\"parent/92\",[0,1.108]],[\"name/93\",[90,46.096]],[\"parent/93\",[0,1.108]],[\"name/94\",[91,46.096]],[\"parent/94\",[0,1.108]],[\"name/95\",[92,46.096]],[\"parent/95\",[0,1.108]],[\"name/96\",[93,46.096]],[\"parent/96\",[0,1.108]],[\"name/97\",[94,46.096]],[\"parent/97\",[0,1.108]],[\"name/98\",[95,46.096]],[\"parent/98\",[0,1.108]],[\"name/99\",[96,46.096]],[\"parent/99\",[0,1.108]],[\"name/100\",[97,46.096]],[\"parent/100\",[0,1.108]],[\"name/101\",[98,46.096]],[\"parent/101\",[0,1.108]],[\"name/102\",[99,46.096]],[\"parent/102\",[0,1.108]],[\"name/103\",[100,46.096]],[\"parent/103\",[0,1.108]],[\"name/104\",[101,46.096]],[\"parent/104\",[0,1.108]],[\"name/105\",[102,46.096]],[\"parent/105\",[0,1.108]],[\"name/106\",[103,46.096]],[\"parent/106\",[0,1.108]],[\"name/107\",[104,46.096]],[\"parent/107\",[0,1.108]],[\"name/108\",[105,46.096]],[\"parent/108\",[0,1.108]],[\"name/109\",[106,46.096]],[\"parent/109\",[0,1.108]],[\"name/110\",[107,46.096]],[\"parent/110\",[0,1.108]],[\"name/111\",[108,46.096]],[\"parent/111\",[0,1.108]],[\"name/112\",[109,46.096]],[\"parent/112\",[0,1.108]],[\"name/113\",[110,46.096]],[\"parent/113\",[0,1.108]],[\"name/114\",[111,46.096]],[\"parent/114\",[0,1.108]],[\"name/115\",[112,46.096]],[\"parent/115\",[0,1.108]],[\"name/116\",[113,46.096]],[\"parent/116\",[0,1.108]],[\"name/117\",[114,46.096]],[\"parent/117\",[0,1.108]],[\"name/118\",[115,46.096]],[\"parent/118\",[0,1.108]],[\"name/119\",[116,46.096]],[\"parent/119\",[0,1.108]],[\"name/120\",[117,46.096]],[\"parent/120\",[0,1.108]],[\"name/121\",[118,46.096]],[\"parent/121\",[0,1.108]],[\"name/122\",[119,46.096]],[\"parent/122\",[0,1.108]],[\"name/123\",[120,49.477]],[\"parent/123\",[4,1.116]],[\"name/124\",[121,49.477]],[\"parent/124\",[4,1.116]],[\"name/125\",[15,46.096]],[\"parent/125\",[4,1.116]],[\"name/126\",[16,46.096]],[\"parent/126\",[4,1.116]],[\"name/127\",[17,46.096]],[\"parent/127\",[4,1.116]],[\"name/128\",[18,46.096]],[\"parent/128\",[4,1.116]],[\"name/129\",[19,46.096]],[\"parent/129\",[4,1.116]],[\"name/130\",[20,46.096]],[\"parent/130\",[4,1.116]],[\"name/131\",[21,46.096]],[\"parent/131\",[4,1.116]],[\"name/132\",[22,46.096]],[\"parent/132\",[4,1.116]],[\"name/133\",[23,46.096]],[\"parent/133\",[4,1.116]],[\"name/134\",[24,46.096]],[\"parent/134\",[4,1.116]],[\"name/135\",[25,46.096]],[\"parent/135\",[4,1.116]],[\"name/136\",[26,46.096]],[\"parent/136\",[4,1.116]],[\"name/137\",[27,46.096]],[\"parent/137\",[4,1.116]],[\"name/138\",[28,46.096]],[\"parent/138\",[4,1.116]],[\"name/139\",[29,46.096]],[\"parent/139\",[4,1.116]],[\"name/140\",[30,46.096]],[\"parent/140\",[4,1.116]],[\"name/141\",[31,46.096]],[\"parent/141\",[4,1.116]],[\"name/142\",[32,46.096]],[\"parent/142\",[4,1.116]],[\"name/143\",[33,46.096]],[\"parent/143\",[4,1.116]],[\"name/144\",[34,46.096]],[\"parent/144\",[4,1.116]],[\"name/145\",[35,46.096]],[\"parent/145\",[4,1.116]],[\"name/146\",[36,46.096]],[\"parent/146\",[4,1.116]],[\"name/147\",[37,46.096]],[\"parent/147\",[4,1.116]],[\"name/148\",[38,46.096]],[\"parent/148\",[4,1.116]],[\"name/149\",[39,46.096]],[\"parent/149\",[4,1.116]],[\"name/150\",[40,46.096]],[\"parent/150\",[4,1.116]],[\"name/151\",[41,46.096]],[\"parent/151\",[4,1.116]],[\"name/152\",[42,46.096]],[\"parent/152\",[4,1.116]],[\"name/153\",[43,46.096]],[\"parent/153\",[4,1.116]],[\"name/154\",[44,46.096]],[\"parent/154\",[4,1.116]],[\"name/155\",[45,46.096]],[\"parent/155\",[4,1.116]],[\"name/156\",[46,46.096]],[\"parent/156\",[4,1.116]],[\"name/157\",[47,46.096]],[\"parent/157\",[4,1.116]],[\"name/158\",[48,46.096]],[\"parent/158\",[4,1.116]],[\"name/159\",[49,46.096]],[\"parent/159\",[4,1.116]],[\"name/160\",[50,46.096]],[\"parent/160\",[4,1.116]],[\"name/161\",[51,46.096]],[\"parent/161\",[4,1.116]],[\"name/162\",[52,46.096]],[\"parent/162\",[4,1.116]],[\"name/163\",[53,46.096]],[\"parent/163\",[4,1.116]],[\"name/164\",[54,46.096]],[\"parent/164\",[4,1.116]],[\"name/165\",[55,46.096]],[\"parent/165\",[4,1.116]],[\"name/166\",[56,46.096]],[\"parent/166\",[4,1.116]],[\"name/167\",[57,46.096]],[\"parent/167\",[4,1.116]],[\"name/168\",[58,46.096]],[\"parent/168\",[4,1.116]],[\"name/169\",[59,46.096]],[\"parent/169\",[4,1.116]],[\"name/170\",[60,46.096]],[\"parent/170\",[4,1.116]],[\"name/171\",[61,46.096]],[\"parent/171\",[4,1.116]],[\"name/172\",[62,46.096]],[\"parent/172\",[4,1.116]],[\"name/173\",[63,46.096]],[\"parent/173\",[4,1.116]],[\"name/174\",[64,46.096]],[\"parent/174\",[4,1.116]],[\"name/175\",[65,46.096]],[\"parent/175\",[4,1.116]],[\"name/176\",[66,46.096]],[\"parent/176\",[4,1.116]],[\"name/177\",[67,46.096]],[\"parent/177\",[4,1.116]],[\"name/178\",[68,46.096]],[\"parent/178\",[4,1.116]],[\"name/179\",[69,46.096]],[\"parent/179\",[4,1.116]],[\"name/180\",[70,46.096]],[\"parent/180\",[4,1.116]],[\"name/181\",[71,46.096]],[\"parent/181\",[4,1.116]],[\"name/182\",[72,46.096]],[\"parent/182\",[4,1.116]],[\"name/183\",[2,38.439]],[\"parent/183\",[4,1.116]],[\"name/184\",[73,46.096]],[\"parent/184\",[4,1.116]],[\"name/185\",[74,46.096]],[\"parent/185\",[4,1.116]],[\"name/186\",[75,46.096]],[\"parent/186\",[4,1.116]],[\"name/187\",[76,46.096]],[\"parent/187\",[4,1.116]],[\"name/188\",[77,46.096]],[\"parent/188\",[4,1.116]],[\"name/189\",[78,46.096]],[\"parent/189\",[4,1.116]],[\"name/190\",[79,46.096]],[\"parent/190\",[4,1.116]],[\"name/191\",[80,46.096]],[\"parent/191\",[4,1.116]],[\"name/192\",[81,46.096]],[\"parent/192\",[4,1.116]],[\"name/193\",[82,46.096]],[\"parent/193\",[4,1.116]],[\"name/194\",[83,46.096]],[\"parent/194\",[4,1.116]],[\"name/195\",[84,46.096]],[\"parent/195\",[4,1.116]],[\"name/196\",[85,46.096]],[\"parent/196\",[4,1.116]],[\"name/197\",[86,46.096]],[\"parent/197\",[4,1.116]],[\"name/198\",[87,46.096]],[\"parent/198\",[4,1.116]],[\"name/199\",[88,46.096]],[\"parent/199\",[4,1.116]],[\"name/200\",[89,46.096]],[\"parent/200\",[4,1.116]],[\"name/201\",[90,46.096]],[\"parent/201\",[4,1.116]],[\"name/202\",[91,46.096]],[\"parent/202\",[4,1.116]],[\"name/203\",[92,46.096]],[\"parent/203\",[4,1.116]],[\"name/204\",[93,46.096]],[\"parent/204\",[4,1.116]],[\"name/205\",[94,46.096]],[\"parent/205\",[4,1.116]],[\"name/206\",[95,46.096]],[\"parent/206\",[4,1.116]],[\"name/207\",[96,46.096]],[\"parent/207\",[4,1.116]],[\"name/208\",[97,46.096]],[\"parent/208\",[4,1.116]],[\"name/209\",[98,46.096]],[\"parent/209\",[4,1.116]],[\"name/210\",[99,46.096]],[\"parent/210\",[4,1.116]],[\"name/211\",[100,46.096]],[\"parent/211\",[4,1.116]],[\"name/212\",[101,46.096]],[\"parent/212\",[4,1.116]],[\"name/213\",[102,46.096]],[\"parent/213\",[4,1.116]],[\"name/214\",[103,46.096]],[\"parent/214\",[4,1.116]],[\"name/215\",[104,46.096]],[\"parent/215\",[4,1.116]],[\"name/216\",[105,46.096]],[\"parent/216\",[4,1.116]],[\"name/217\",[106,46.096]],[\"parent/217\",[4,1.116]],[\"name/218\",[107,46.096]],[\"parent/218\",[4,1.116]],[\"name/219\",[108,46.096]],[\"parent/219\",[4,1.116]],[\"name/220\",[109,46.096]],[\"parent/220\",[4,1.116]],[\"name/221\",[110,46.096]],[\"parent/221\",[4,1.116]],[\"name/222\",[111,46.096]],[\"parent/222\",[4,1.116]],[\"name/223\",[112,46.096]],[\"parent/223\",[4,1.116]],[\"name/224\",[113,46.096]],[\"parent/224\",[4,1.116]],[\"name/225\",[114,46.096]],[\"parent/225\",[4,1.116]],[\"name/226\",[115,46.096]],[\"parent/226\",[4,1.116]],[\"name/227\",[116,46.096]],[\"parent/227\",[4,1.116]],[\"name/228\",[117,46.096]],[\"parent/228\",[4,1.116]],[\"name/229\",[118,46.096]],[\"parent/229\",[4,1.116]],[\"name/230\",[119,46.096]],[\"parent/230\",[4,1.116]],[\"name/231\",[3,43.571]],[\"parent/231\",[13,1.09]],[\"name/232\",[5,46.096]],[\"parent/232\",[13,1.09]],[\"name/233\",[11,46.096]],[\"parent/233\",[13,1.09]],[\"name/234\",[12,46.096]],[\"parent/234\",[13,1.09]],[\"name/235\",[120,49.477]],[\"parent/235\",[13,1.09]],[\"name/236\",[121,49.477]],[\"parent/236\",[13,1.09]],[\"name/237\",[15,46.096]],[\"parent/237\",[13,1.09]],[\"name/238\",[16,46.096]],[\"parent/238\",[13,1.09]],[\"name/239\",[17,46.096]],[\"parent/239\",[13,1.09]],[\"name/240\",[18,46.096]],[\"parent/240\",[13,1.09]],[\"name/241\",[19,46.096]],[\"parent/241\",[13,1.09]],[\"name/242\",[20,46.096]],[\"parent/242\",[13,1.09]],[\"name/243\",[21,46.096]],[\"parent/243\",[13,1.09]],[\"name/244\",[22,46.096]],[\"parent/244\",[13,1.09]],[\"name/245\",[23,46.096]],[\"parent/245\",[13,1.09]],[\"name/246\",[24,46.096]],[\"parent/246\",[13,1.09]],[\"name/247\",[25,46.096]],[\"parent/247\",[13,1.09]],[\"name/248\",[26,46.096]],[\"parent/248\",[13,1.09]],[\"name/249\",[27,46.096]],[\"parent/249\",[13,1.09]],[\"name/250\",[28,46.096]],[\"parent/250\",[13,1.09]],[\"name/251\",[29,46.096]],[\"parent/251\",[13,1.09]],[\"name/252\",[30,46.096]],[\"parent/252\",[13,1.09]],[\"name/253\",[31,46.096]],[\"parent/253\",[13,1.09]],[\"name/254\",[32,46.096]],[\"parent/254\",[13,1.09]],[\"name/255\",[33,46.096]],[\"parent/255\",[13,1.09]],[\"name/256\",[34,46.096]],[\"parent/256\",[13,1.09]],[\"name/257\",[35,46.096]],[\"parent/257\",[13,1.09]],[\"name/258\",[36,46.096]],[\"parent/258\",[13,1.09]],[\"name/259\",[37,46.096]],[\"parent/259\",[13,1.09]],[\"name/260\",[38,46.096]],[\"parent/260\",[13,1.09]],[\"name/261\",[39,46.096]],[\"parent/261\",[13,1.09]],[\"name/262\",[40,46.096]],[\"parent/262\",[13,1.09]],[\"name/263\",[41,46.096]],[\"parent/263\",[13,1.09]],[\"name/264\",[42,46.096]],[\"parent/264\",[13,1.09]],[\"name/265\",[43,46.096]],[\"parent/265\",[13,1.09]],[\"name/266\",[44,46.096]],[\"parent/266\",[13,1.09]],[\"name/267\",[45,46.096]],[\"parent/267\",[13,1.09]],[\"name/268\",[46,46.096]],[\"parent/268\",[13,1.09]],[\"name/269\",[47,46.096]],[\"parent/269\",[13,1.09]],[\"name/270\",[48,46.096]],[\"parent/270\",[13,1.09]],[\"name/271\",[49,46.096]],[\"parent/271\",[13,1.09]],[\"name/272\",[50,46.096]],[\"parent/272\",[13,1.09]],[\"name/273\",[51,46.096]],[\"parent/273\",[13,1.09]],[\"name/274\",[52,46.096]],[\"parent/274\",[13,1.09]],[\"name/275\",[53,46.096]],[\"parent/275\",[13,1.09]],[\"name/276\",[54,46.096]],[\"parent/276\",[13,1.09]],[\"name/277\",[55,46.096]],[\"parent/277\",[13,1.09]],[\"name/278\",[56,46.096]],[\"parent/278\",[13,1.09]],[\"name/279\",[57,46.096]],[\"parent/279\",[13,1.09]],[\"name/280\",[58,46.096]],[\"parent/280\",[13,1.09]],[\"name/281\",[59,46.096]],[\"parent/281\",[13,1.09]],[\"name/282\",[60,46.096]],[\"parent/282\",[13,1.09]],[\"name/283\",[61,46.096]],[\"parent/283\",[13,1.09]],[\"name/284\",[62,46.096]],[\"parent/284\",[13,1.09]],[\"name/285\",[63,46.096]],[\"parent/285\",[13,1.09]],[\"name/286\",[64,46.096]],[\"parent/286\",[13,1.09]],[\"name/287\",[65,46.096]],[\"parent/287\",[13,1.09]],[\"name/288\",[66,46.096]],[\"parent/288\",[13,1.09]],[\"name/289\",[67,46.096]],[\"parent/289\",[13,1.09]],[\"name/290\",[68,46.096]],[\"parent/290\",[13,1.09]],[\"name/291\",[69,46.096]],[\"parent/291\",[13,1.09]],[\"name/292\",[70,46.096]],[\"parent/292\",[13,1.09]],[\"name/293\",[71,46.096]],[\"parent/293\",[13,1.09]],[\"name/294\",[72,46.096]],[\"parent/294\",[13,1.09]],[\"name/295\",[2,38.439]],[\"parent/295\",[13,1.09]],[\"name/296\",[73,46.096]],[\"parent/296\",[13,1.09]],[\"name/297\",[74,46.096]],[\"parent/297\",[13,1.09]],[\"name/298\",[75,46.096]],[\"parent/298\",[13,1.09]],[\"name/299\",[76,46.096]],[\"parent/299\",[13,1.09]],[\"name/300\",[77,46.096]],[\"parent/300\",[13,1.09]],[\"name/301\",[78,46.096]],[\"parent/301\",[13,1.09]],[\"name/302\",[79,46.096]],[\"parent/302\",[13,1.09]],[\"name/303\",[80,46.096]],[\"parent/303\",[13,1.09]],[\"name/304\",[81,46.096]],[\"parent/304\",[13,1.09]],[\"name/305\",[82,46.096]],[\"parent/305\",[13,1.09]],[\"name/306\",[83,46.096]],[\"parent/306\",[13,1.09]],[\"name/307\",[84,46.096]],[\"parent/307\",[13,1.09]],[\"name/308\",[85,46.096]],[\"parent/308\",[13,1.09]],[\"name/309\",[86,46.096]],[\"parent/309\",[13,1.09]],[\"name/310\",[87,46.096]],[\"parent/310\",[13,1.09]],[\"name/311\",[88,46.096]],[\"parent/311\",[13,1.09]],[\"name/312\",[89,46.096]],[\"parent/312\",[13,1.09]],[\"name/313\",[90,46.096]],[\"parent/313\",[13,1.09]],[\"name/314\",[91,46.096]],[\"parent/314\",[13,1.09]],[\"name/315\",[92,46.096]],[\"parent/315\",[13,1.09]],[\"name/316\",[93,46.096]],[\"parent/316\",[13,1.09]],[\"name/317\",[94,46.096]],[\"parent/317\",[13,1.09]],[\"name/318\",[95,46.096]],[\"parent/318\",[13,1.09]],[\"name/319\",[96,46.096]],[\"parent/319\",[13,1.09]],[\"name/320\",[97,46.096]],[\"parent/320\",[13,1.09]],[\"name/321\",[98,46.096]],[\"parent/321\",[13,1.09]],[\"name/322\",[99,46.096]],[\"parent/322\",[13,1.09]],[\"name/323\",[100,46.096]],[\"parent/323\",[13,1.09]],[\"name/324\",[101,46.096]],[\"parent/324\",[13,1.09]],[\"name/325\",[102,46.096]],[\"parent/325\",[13,1.09]],[\"name/326\",[103,46.096]],[\"parent/326\",[13,1.09]],[\"name/327\",[104,46.096]],[\"parent/327\",[13,1.09]],[\"name/328\",[105,46.096]],[\"parent/328\",[13,1.09]],[\"name/329\",[106,46.096]],[\"parent/329\",[13,1.09]],[\"name/330\",[107,46.096]],[\"parent/330\",[13,1.09]],[\"name/331\",[108,46.096]],[\"parent/331\",[13,1.09]],[\"name/332\",[109,46.096]],[\"parent/332\",[13,1.09]],[\"name/333\",[110,46.096]],[\"parent/333\",[13,1.09]],[\"name/334\",[111,46.096]],[\"parent/334\",[13,1.09]],[\"name/335\",[112,46.096]],[\"parent/335\",[13,1.09]],[\"name/336\",[113,46.096]],[\"parent/336\",[13,1.09]],[\"name/337\",[114,46.096]],[\"parent/337\",[13,1.09]],[\"name/338\",[115,46.096]],[\"parent/338\",[13,1.09]],[\"name/339\",[116,46.096]],[\"parent/339\",[13,1.09]],[\"name/340\",[117,46.096]],[\"parent/340\",[13,1.09]],[\"name/341\",[118,46.096]],[\"parent/341\",[13,1.09]],[\"name/342\",[119,46.096]],[\"parent/342\",[13,1.09]]],\"invertedIndex\":[[\"__type\",{\"_index\":6,\"name\":{\"5\":{}},\"parent\":{}}],[\"_id\",{\"_index\":11,\"name\":{\"8\":{},\"15\":{},\"233\":{}},\"parent\":{}}],[\"_subid\",{\"_index\":12,\"name\":{\"9\":{},\"16\":{},\"234\":{}},\"parent\":{}}],[\"aborteddeferrederror\",{\"_index\":66,\"name\":{\"68\":{},\"176\":{},\"288\":{}},\"parent\":{}}],[\"actionfunction\",{\"_index\":23,\"name\":{\"25\":{},\"133\":{},\"245\":{}},\"parent\":{}}],[\"actionfunctionargs\",{\"_index\":24,\"name\":{\"26\":{},\"134\":{},\"246\":{}},\"parent\":{}}],[\"await\",{\"_index\":67,\"name\":{\"69\":{},\"177\":{},\"289\":{}},\"parent\":{}}],[\"awaitprops\",{\"_index\":25,\"name\":{\"27\":{},\"135\":{},\"247\":{}},\"parent\":{}}],[\"browser\",{\"_index\":0,\"name\":{\"0\":{},\"1\":{}},\"parent\":{\"2\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{},\"27\":{},\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{},\"63\":{},\"64\":{},\"65\":{},\"66\":{},\"67\":{},\"68\":{},\"69\":{},\"70\":{},\"71\":{},\"72\":{},\"73\":{},\"74\":{},\"75\":{},\"76\":{},\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{},\"83\":{},\"84\":{},\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{},\"91\":{},\"92\":{},\"93\":{},\"94\":{},\"95\":{},\"96\":{},\"97\":{},\"98\":{},\"99\":{},\"100\":{},\"101\":{},\"102\":{},\"103\":{},\"104\":{},\"105\":{},\"106\":{},\"107\":{},\"108\":{},\"109\":{},\"110\":{},\"111\":{},\"112\":{},\"113\":{},\"114\":{},\"115\":{},\"116\":{},\"117\":{},\"118\":{},\"119\":{},\"120\":{},\"121\":{},\"122\":{}}}],[\"browser/react\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{\"2\":{}}}],[\"common\",{\"_index\":4,\"name\":{\"3\":{}},\"parent\":{\"4\":{},\"8\":{},\"9\":{},\"123\":{},\"124\":{},\"125\":{},\"126\":{},\"127\":{},\"128\":{},\"129\":{},\"130\":{},\"131\":{},\"132\":{},\"133\":{},\"134\":{},\"135\":{},\"136\":{},\"137\":{},\"138\":{},\"139\":{},\"140\":{},\"141\":{},\"142\":{},\"143\":{},\"144\":{},\"145\":{},\"146\":{},\"147\":{},\"148\":{},\"149\":{},\"150\":{},\"151\":{},\"152\":{},\"153\":{},\"154\":{},\"155\":{},\"156\":{},\"157\":{},\"158\":{},\"159\":{},\"160\":{},\"161\":{},\"162\":{},\"163\":{},\"164\":{},\"165\":{},\"166\":{},\"167\":{},\"168\":{},\"169\":{},\"170\":{},\"171\":{},\"172\":{},\"173\":{},\"174\":{},\"175\":{},\"176\":{},\"177\":{},\"178\":{},\"179\":{},\"180\":{},\"181\":{},\"182\":{},\"183\":{},\"184\":{},\"185\":{},\"186\":{},\"187\":{},\"188\":{},\"189\":{},\"190\":{},\"191\":{},\"192\":{},\"193\":{},\"194\":{},\"195\":{},\"196\":{},\"197\":{},\"198\":{},\"199\":{},\"200\":{},\"201\":{},\"202\":{},\"203\":{},\"204\":{},\"205\":{},\"206\":{},\"207\":{},\"208\":{},\"209\":{},\"210\":{},\"211\":{},\"212\":{},\"213\":{},\"214\":{},\"215\":{},\"216\":{},\"217\":{},\"218\":{},\"219\":{},\"220\":{},\"221\":{},\"222\":{},\"223\":{},\"224\":{},\"225\":{},\"226\":{},\"227\":{},\"228\":{},\"229\":{},\"230\":{}}}],[\"common.reactrouterfeatureoptions\",{\"_index\":7,\"name\":{},\"parent\":{\"5\":{}}}],[\"common.reactrouterfeatureoptions.__type\",{\"_index\":9,\"name\":{},\"parent\":{\"6\":{},\"7\":{}}}],[\"creatememoryrouter\",{\"_index\":75,\"name\":{\"78\":{},\"186\":{},\"298\":{}},\"parent\":{}}],[\"createpath\",{\"_index\":76,\"name\":{\"79\":{},\"187\":{},\"299\":{}},\"parent\":{}}],[\"createroutesfromchildren\",{\"_index\":77,\"name\":{\"80\":{},\"188\":{},\"300\":{}},\"parent\":{}}],[\"createroutesfromelements\",{\"_index\":78,\"name\":{\"81\":{},\"189\":{},\"301\":{}},\"parent\":{}}],[\"createsearchparams\",{\"_index\":22,\"name\":{\"24\":{},\"132\":{},\"244\":{}},\"parent\":{}}],[\"dataroutematch\",{\"_index\":28,\"name\":{\"30\":{},\"138\":{},\"250\":{}},\"parent\":{}}],[\"datarouteobject\",{\"_index\":29,\"name\":{\"31\":{},\"139\":{},\"251\":{}},\"parent\":{}}],[\"defer\",{\"_index\":79,\"name\":{\"82\":{},\"190\":{},\"302\":{}},\"parent\":{}}],[\"fetcher\",{\"_index\":30,\"name\":{\"32\":{},\"140\":{},\"252\":{}},\"parent\":{}}],[\"formenctype\",{\"_index\":15,\"name\":{\"17\":{},\"125\":{},\"237\":{}},\"parent\":{}}],[\"formmethod\",{\"_index\":16,\"name\":{\"18\":{},\"126\":{},\"238\":{}},\"parent\":{}}],[\"generatepath\",{\"_index\":81,\"name\":{\"84\":{},\"192\":{},\"304\":{}},\"parent\":{}}],[\"getscrollrestorationkeyfunction\",{\"_index\":17,\"name\":{\"19\":{},\"127\":{},\"239\":{}},\"parent\":{}}],[\"hash\",{\"_index\":31,\"name\":{\"33\":{},\"141\":{},\"253\":{}},\"parent\":{}}],[\"history\",{\"_index\":10,\"name\":{\"7\":{}},\"parent\":{}}],[\"indexrouteobject\",{\"_index\":32,\"name\":{\"34\":{},\"142\":{},\"254\":{}},\"parent\":{}}],[\"indexrouteprops\",{\"_index\":33,\"name\":{\"35\":{},\"143\":{},\"255\":{}},\"parent\":{}}],[\"isrouteerrorresponse\",{\"_index\":80,\"name\":{\"83\":{},\"191\":{},\"303\":{}},\"parent\":{}}],[\"json\",{\"_index\":82,\"name\":{\"85\":{},\"193\":{},\"305\":{}},\"parent\":{}}],[\"jsonfunction\",{\"_index\":34,\"name\":{\"36\":{},\"144\":{},\"256\":{}},\"parent\":{}}],[\"layoutrouteprops\",{\"_index\":36,\"name\":{\"38\":{},\"146\":{},\"258\":{}},\"parent\":{}}],[\"lazyroutefunction\",{\"_index\":35,\"name\":{\"37\":{},\"145\":{},\"257\":{}},\"parent\":{}}],[\"loaderfunction\",{\"_index\":37,\"name\":{\"39\":{},\"147\":{},\"259\":{}},\"parent\":{}}],[\"loaderfunctionargs\",{\"_index\":38,\"name\":{\"40\":{},\"148\":{},\"260\":{}},\"parent\":{}}],[\"location\",{\"_index\":39,\"name\":{\"41\":{},\"149\":{},\"261\":{}},\"parent\":{}}],[\"matchpath\",{\"_index\":83,\"name\":{\"86\":{},\"194\":{},\"306\":{}},\"parent\":{}}],[\"matchroutes\",{\"_index\":84,\"name\":{\"87\":{},\"195\":{},\"307\":{}},\"parent\":{}}],[\"memoryrouter\",{\"_index\":68,\"name\":{\"70\":{},\"178\":{},\"290\":{}},\"parent\":{}}],[\"memoryrouterprops\",{\"_index\":40,\"name\":{\"42\":{},\"150\":{},\"262\":{}},\"parent\":{}}],[\"navigate\",{\"_index\":69,\"name\":{\"71\":{},\"179\":{},\"291\":{}},\"parent\":{}}],[\"navigatefunction\",{\"_index\":41,\"name\":{\"43\":{},\"151\":{},\"263\":{}},\"parent\":{}}],[\"navigateoptions\",{\"_index\":42,\"name\":{\"44\":{},\"152\":{},\"264\":{}},\"parent\":{}}],[\"navigateprops\",{\"_index\":43,\"name\":{\"45\":{},\"153\":{},\"265\":{}},\"parent\":{}}],[\"navigation\",{\"_index\":44,\"name\":{\"46\":{},\"154\":{},\"266\":{}},\"parent\":{}}],[\"navigationtype\",{\"_index\":70,\"name\":{\"72\":{},\"180\":{},\"292\":{}},\"parent\":{}}],[\"navigator\",{\"_index\":45,\"name\":{\"47\":{},\"155\":{},\"267\":{}},\"parent\":{}}],[\"node\",{\"_index\":13,\"name\":{\"10\":{},\"11\":{}},\"parent\":{\"12\":{},\"231\":{},\"232\":{},\"233\":{},\"234\":{},\"235\":{},\"236\":{},\"237\":{},\"238\":{},\"239\":{},\"240\":{},\"241\":{},\"242\":{},\"243\":{},\"244\":{},\"245\":{},\"246\":{},\"247\":{},\"248\":{},\"249\":{},\"250\":{},\"251\":{},\"252\":{},\"253\":{},\"254\":{},\"255\":{},\"256\":{},\"257\":{},\"258\":{},\"259\":{},\"260\":{},\"261\":{},\"262\":{},\"263\":{},\"264\":{},\"265\":{},\"266\":{},\"267\":{},\"268\":{},\"269\":{},\"270\":{},\"271\":{},\"272\":{},\"273\":{},\"274\":{},\"275\":{},\"276\":{},\"277\":{},\"278\":{},\"279\":{},\"280\":{},\"281\":{},\"282\":{},\"283\":{},\"284\":{},\"285\":{},\"286\":{},\"287\":{},\"288\":{},\"289\":{},\"290\":{},\"291\":{},\"292\":{},\"293\":{},\"294\":{},\"295\":{},\"296\":{},\"297\":{},\"298\":{},\"299\":{},\"300\":{},\"301\":{},\"302\":{},\"303\":{},\"304\":{},\"305\":{},\"306\":{},\"307\":{},\"308\":{},\"309\":{},\"310\":{},\"311\":{},\"312\":{},\"313\":{},\"314\":{},\"315\":{},\"316\":{},\"317\":{},\"318\":{},\"319\":{},\"320\":{},\"321\":{},\"322\":{},\"323\":{},\"324\":{},\"325\":{},\"326\":{},\"327\":{},\"328\":{},\"329\":{},\"330\":{},\"331\":{},\"332\":{},\"333\":{},\"334\":{},\"335\":{},\"336\":{},\"337\":{},\"338\":{},\"339\":{},\"340\":{},\"341\":{},\"342\":{}}}],[\"node/react\",{\"_index\":14,\"name\":{\"11\":{}},\"parent\":{\"12\":{}}}],[\"nonindexrouteobject\",{\"_index\":46,\"name\":{\"48\":{},\"156\":{},\"268\":{}},\"parent\":{}}],[\"outlet\",{\"_index\":71,\"name\":{\"73\":{},\"181\":{},\"293\":{}},\"parent\":{}}],[\"outletprops\",{\"_index\":47,\"name\":{\"49\":{},\"157\":{},\"269\":{}},\"parent\":{}}],[\"paramkeyvaluepair\",{\"_index\":18,\"name\":{\"20\":{},\"128\":{},\"240\":{}},\"parent\":{}}],[\"paramparsekey\",{\"_index\":49,\"name\":{\"51\":{},\"159\":{},\"271\":{}},\"parent\":{}}],[\"params\",{\"_index\":48,\"name\":{\"50\":{},\"158\":{},\"270\":{}},\"parent\":{}}],[\"parsepath\",{\"_index\":85,\"name\":{\"88\":{},\"196\":{},\"308\":{}},\"parent\":{}}],[\"path\",{\"_index\":50,\"name\":{\"52\":{},\"160\":{},\"272\":{}},\"parent\":{}}],[\"pathmatch\",{\"_index\":51,\"name\":{\"53\":{},\"161\":{},\"273\":{}},\"parent\":{}}],[\"pathname\",{\"_index\":52,\"name\":{\"54\":{},\"162\":{},\"274\":{}},\"parent\":{}}],[\"pathpattern\",{\"_index\":53,\"name\":{\"55\":{},\"163\":{},\"275\":{}},\"parent\":{}}],[\"pathrouteprops\",{\"_index\":54,\"name\":{\"56\":{},\"164\":{},\"276\":{}},\"parent\":{}}],[\"react\",{\"_index\":8,\"name\":{\"6\":{}},\"parent\":{}}],[\"reactrouter\",{\"_index\":121,\"name\":{\"124\":{},\"236\":{}},\"parent\":{}}],[\"reactrouterdom\",{\"_index\":120,\"name\":{\"123\":{},\"235\":{}},\"parent\":{}}],[\"reactrouterfeature\",{\"_index\":3,\"name\":{\"2\":{},\"12\":{},\"13\":{},\"231\":{}},\"parent\":{}}],[\"reactrouterfeatureoptions\",{\"_index\":5,\"name\":{\"4\":{},\"14\":{},\"232\":{}},\"parent\":{}}],[\"redirect\",{\"_index\":86,\"name\":{\"89\":{},\"197\":{},\"309\":{}},\"parent\":{}}],[\"redirectdocument\",{\"_index\":87,\"name\":{\"90\":{},\"198\":{},\"310\":{}},\"parent\":{}}],[\"redirectfunction\",{\"_index\":55,\"name\":{\"57\":{},\"165\":{},\"277\":{}},\"parent\":{}}],[\"relativeroutingtype\",{\"_index\":56,\"name\":{\"58\":{},\"166\":{},\"278\":{}},\"parent\":{}}],[\"rendermatches\",{\"_index\":88,\"name\":{\"91\":{},\"199\":{},\"311\":{}},\"parent\":{}}],[\"resolvepath\",{\"_index\":89,\"name\":{\"92\":{},\"200\":{},\"312\":{}},\"parent\":{}}],[\"route\",{\"_index\":72,\"name\":{\"74\":{},\"182\":{},\"294\":{}},\"parent\":{}}],[\"routematch\",{\"_index\":57,\"name\":{\"59\":{},\"167\":{},\"279\":{}},\"parent\":{}}],[\"routeobject\",{\"_index\":58,\"name\":{\"60\":{},\"168\":{},\"280\":{}},\"parent\":{}}],[\"routeprops\",{\"_index\":59,\"name\":{\"61\":{},\"169\":{},\"281\":{}},\"parent\":{}}],[\"router\",{\"_index\":2,\"name\":{\"1\":{},\"11\":{},\"75\":{},\"183\":{},\"295\":{}},\"parent\":{\"2\":{},\"12\":{}}}],[\"routerprops\",{\"_index\":60,\"name\":{\"62\":{},\"170\":{},\"282\":{}},\"parent\":{}}],[\"routerprovider\",{\"_index\":73,\"name\":{\"76\":{},\"184\":{},\"296\":{}},\"parent\":{}}],[\"routerproviderprops\",{\"_index\":61,\"name\":{\"63\":{},\"171\":{},\"283\":{}},\"parent\":{}}],[\"routes\",{\"_index\":74,\"name\":{\"77\":{},\"185\":{},\"297\":{}},\"parent\":{}}],[\"routesprops\",{\"_index\":62,\"name\":{\"64\":{},\"172\":{},\"284\":{}},\"parent\":{}}],[\"search\",{\"_index\":63,\"name\":{\"65\":{},\"173\":{},\"285\":{}},\"parent\":{}}],[\"shouldrevalidatefunction\",{\"_index\":64,\"name\":{\"66\":{},\"174\":{},\"286\":{}},\"parent\":{}}],[\"submitoptions\",{\"_index\":19,\"name\":{\"21\":{},\"129\":{},\"241\":{}},\"parent\":{}}],[\"to\",{\"_index\":65,\"name\":{\"67\":{},\"175\":{},\"287\":{}},\"parent\":{}}],[\"unsafe_dataroutercontext\",{\"_index\":111,\"name\":{\"114\":{},\"222\":{},\"334\":{}},\"parent\":{}}],[\"unsafe_datarouterstatecontext\",{\"_index\":112,\"name\":{\"115\":{},\"223\":{},\"335\":{}},\"parent\":{}}],[\"unsafe_locationcontext\",{\"_index\":114,\"name\":{\"117\":{},\"225\":{},\"337\":{}},\"parent\":{}}],[\"unsafe_navigationcontext\",{\"_index\":113,\"name\":{\"116\":{},\"224\":{},\"336\":{}},\"parent\":{}}],[\"unsafe_routecontext\",{\"_index\":115,\"name\":{\"118\":{},\"226\":{},\"338\":{}},\"parent\":{}}],[\"unsafe_userouteid\",{\"_index\":116,\"name\":{\"119\":{},\"227\":{},\"339\":{}},\"parent\":{}}],[\"unsafe_usescrollrestoration\",{\"_index\":118,\"name\":{\"121\":{},\"229\":{},\"341\":{}},\"parent\":{}}],[\"unstable_blocker\",{\"_index\":26,\"name\":{\"28\":{},\"136\":{},\"248\":{}},\"parent\":{}}],[\"unstable_blockerfunction\",{\"_index\":27,\"name\":{\"29\":{},\"137\":{},\"249\":{}},\"parent\":{}}],[\"unstable_historyrouter\",{\"_index\":117,\"name\":{\"120\":{},\"228\":{},\"340\":{}},\"parent\":{}}],[\"unstable_useblocker\",{\"_index\":93,\"name\":{\"96\":{},\"204\":{},\"316\":{}},\"parent\":{}}],[\"unstable_useprompt\",{\"_index\":119,\"name\":{\"122\":{},\"230\":{},\"342\":{}},\"parent\":{}}],[\"urlsearchparamsinit\",{\"_index\":20,\"name\":{\"22\":{},\"130\":{},\"242\":{}},\"parent\":{}}],[\"useactiondata\",{\"_index\":90,\"name\":{\"93\":{},\"201\":{},\"313\":{}},\"parent\":{}}],[\"useasyncerror\",{\"_index\":91,\"name\":{\"94\":{},\"202\":{},\"314\":{}},\"parent\":{}}],[\"useasyncvalue\",{\"_index\":92,\"name\":{\"95\":{},\"203\":{},\"315\":{}},\"parent\":{}}],[\"usehref\",{\"_index\":94,\"name\":{\"97\":{},\"205\":{},\"317\":{}},\"parent\":{}}],[\"useinroutercontext\",{\"_index\":95,\"name\":{\"98\":{},\"206\":{},\"318\":{}},\"parent\":{}}],[\"useloaderdata\",{\"_index\":96,\"name\":{\"99\":{},\"207\":{},\"319\":{}},\"parent\":{}}],[\"uselocation\",{\"_index\":97,\"name\":{\"100\":{},\"208\":{},\"320\":{}},\"parent\":{}}],[\"usematch\",{\"_index\":98,\"name\":{\"101\":{},\"209\":{},\"321\":{}},\"parent\":{}}],[\"usematches\",{\"_index\":99,\"name\":{\"102\":{},\"210\":{},\"322\":{}},\"parent\":{}}],[\"usenavigate\",{\"_index\":100,\"name\":{\"103\":{},\"211\":{},\"323\":{}},\"parent\":{}}],[\"usenavigation\",{\"_index\":101,\"name\":{\"104\":{},\"212\":{},\"324\":{}},\"parent\":{}}],[\"usenavigationtype\",{\"_index\":102,\"name\":{\"105\":{},\"213\":{},\"325\":{}},\"parent\":{}}],[\"useoutlet\",{\"_index\":103,\"name\":{\"106\":{},\"214\":{},\"326\":{}},\"parent\":{}}],[\"useoutletcontext\",{\"_index\":104,\"name\":{\"107\":{},\"215\":{},\"327\":{}},\"parent\":{}}],[\"useparams\",{\"_index\":105,\"name\":{\"108\":{},\"216\":{},\"328\":{}},\"parent\":{}}],[\"useresolvedpath\",{\"_index\":106,\"name\":{\"109\":{},\"217\":{},\"329\":{}},\"parent\":{}}],[\"userevalidator\",{\"_index\":107,\"name\":{\"110\":{},\"218\":{},\"330\":{}},\"parent\":{}}],[\"userouteerror\",{\"_index\":108,\"name\":{\"111\":{},\"219\":{},\"331\":{}},\"parent\":{}}],[\"userouteloaderdata\",{\"_index\":109,\"name\":{\"112\":{},\"220\":{},\"332\":{}},\"parent\":{}}],[\"useroutes\",{\"_index\":110,\"name\":{\"113\":{},\"221\":{},\"333\":{}},\"parent\":{}}],[\"v7_formmethod\",{\"_index\":21,\"name\":{\"23\":{},\"131\":{},\"243\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/packages/xarc-react-router/docs/assets/style.css b/packages/xarc-react-router/docs/assets/style.css new file mode 100644 index 000000000..6127b27cd --- /dev/null +++ b/packages/xarc-react-router/docs/assets/style.css @@ -0,0 +1,1414 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/packages/xarc-react-router/docs/assets/images/widgets.png b/packages/xarc-react-router/docs/assets/widgets.png similarity index 100% rename from packages/xarc-react-router/docs/assets/images/widgets.png rename to packages/xarc-react-router/docs/assets/widgets.png diff --git a/packages/xarc-react-router/docs/assets/images/widgets@2x.png b/packages/xarc-react-router/docs/assets/widgets@2x.png similarity index 100% rename from packages/xarc-react-router/docs/assets/images/widgets@2x.png rename to packages/xarc-react-router/docs/assets/widgets@2x.png diff --git a/packages/xarc-react-router/docs/classes/browser.ReactRouterDom.AbortedDeferredError.html b/packages/xarc-react-router/docs/classes/browser.ReactRouterDom.AbortedDeferredError.html new file mode 100644 index 000000000..ae5547dff --- /dev/null +++ b/packages/xarc-react-router/docs/classes/browser.ReactRouterDom.AbortedDeferredError.html @@ -0,0 +1,6 @@ +AbortedDeferredError | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AbortedDeferredError

    Hierarchy

    • Error
      • AbortedDeferredError

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • Parameters

      • Optional message: string

      Returns AbortedDeferredError

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject: object, constructorOpt?: Function): void
    • +

      Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/enums/browser.ReactRouterDom.NavigationType.html b/packages/xarc-react-router/docs/enums/browser.ReactRouterDom.NavigationType.html new file mode 100644 index 000000000..54e19d3d1 --- /dev/null +++ b/packages/xarc-react-router/docs/enums/browser.ReactRouterDom.NavigationType.html @@ -0,0 +1,15 @@ +NavigationType | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration NavigationType

    +

    Actions represent the type of change to a location value.

    +

    Index

    Enumeration Members

    Enumeration Members

    Pop

    Pop: "POP"
    +

    A POP indicates a change to an arbitrary index in the history stack, such +as a back or forward navigation. It does not describe the direction of the +navigation, only that the current index changed.

    +

    Note: This is the default action for newly created history objects.

    +

    Push

    Push: "PUSH"
    +

    A PUSH indicates a new entry being added to the history stack, such as when +a link is clicked and a new page loads. When this happens, all subsequent +entries in the stack are lost.

    +

    Replace

    Replace: "REPLACE"
    +

    A REPLACE indicates the entry at the current index in the history stack +being replaced by a new one.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/index.html b/packages/xarc-react-router/docs/index.html index 6e5154c69..433941420 100644 --- a/packages/xarc-react-router/docs/index.html +++ b/packages/xarc-react-router/docs/index.html @@ -1,143 +1,38 @@ - - - - - - @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    -

    @xarc/react-router

    -
    -
    -
    -
    -
    -
    -
    -

    - Electrode Logo -
    - Electrode -

    - -

    Web Applications with node.js and React

    -     -

    The Electrode project was developed to make node.js and React the primary tech choices for developing applications at Walmart. It has been powering the http://www.walmart.com eCommerce website since 2017.

    -

    Originally designed for Walmart specific use cases, we open-sourced part of Electrode with the hope that it will be useful to some of you in the JavaScript community. This is the same version that is used to power many applications at Walmart.

    -

    What we open-sourced here is the web application development part of Electrode. It focuses on building web apps with the following emphases:

    -
      -
    • large scale micro-frontend architecture
      • -
    • universal webapp with server side rendering powered by node.js
      • -
    - -

    Getting Started

    -     -

    Please go to our docs for further information and instructions on using Electrode.

    -
    -

    NOTE: We maintain additional code for internal Walmart systems. If you are a Walmart developer, please check internal docs to get started.

    -
    - -

    Contributing

    -     -

    Do you find Electrode useful for your application development, exploring, or learning node.js and React? Please send us your encouragement with a github star.

    -

    Did you find an issue? Would you like to help with the project? Please see our contributing guide for instructions on submitting a PR or reporting an issue.

    - -

    License

    -     -

    Copyright (c) 2016-present, Walmart

    -

    Licensed under the Apache License, Version 2.0

    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +@xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @xarc/react-router

    +Electrode Logo +
    +Electrode +

    + + + +

    Web Applications with node.js and React

    +     +

    The Electrode project was developed to make node.js and React the primary tech choices for developing applications at Walmart. It has been powering the http://www.walmart.com eCommerce website since 2017.

    +

    Originally designed for Walmart specific use cases, we open-sourced part of Electrode with the hope that it will be useful to some of you in the JavaScript community. This is the same version that is used to power many applications at Walmart.

    +

    What we open-sourced here is the web application development part of Electrode. It focuses on building web apps with the following emphases:

    +
      +
    • large scale micro-frontend architecture
      • +
    • universal webapp with server side rendering powered by node.js
      • +
    + + +

    Getting Started

    +     +

    Please go to our docs for further information and instructions on using Electrode.

    +
    +

    NOTE: We maintain additional code for internal Walmart systems. If you are a Walmart developer, please check internal docs to get started.

    +
    + + +

    Contributing

    +     +

    Do you find Electrode useful for your application development, exploring, or learning node.js and React? Please send us your encouragement with a github star.

    +

    Did you find an issue? Would you like to help with the project? Please see our contributing guide for instructions on submitting a PR or reporting an issue.

    + + +

    License

    +     +

    Copyright (c) 2016-present, Walmart

    +

    Licensed under the Apache License, Version 2.0

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.BrowserRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.BrowserRouterProps.html new file mode 100644 index 000000000..3c4ddba37 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.BrowserRouterProps.html @@ -0,0 +1 @@ +BrowserRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BrowserRouterProps

    Hierarchy

    • BrowserRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.FetcherFormProps.html b/packages/xarc-react-router/docs/interfaces/browser.FetcherFormProps.html new file mode 100644 index 000000000..ffa03f417 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.FetcherFormProps.html @@ -0,0 +1,164 @@ +FetcherFormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherFormProps

    Hierarchy

    • FormHTMLAttributes<HTMLFormElement>
      • FetcherFormProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.FetcherSubmitFunction.html b/packages/xarc-react-router/docs/interfaces/browser.FetcherSubmitFunction.html new file mode 100644 index 000000000..d2f169dea --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.FetcherSubmitFunction.html @@ -0,0 +1,3 @@ +FetcherSubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherSubmitFunction

    Hierarchy

    • FetcherSubmitFunction

    Callable

    • FetcherSubmitFunction(target: SubmitTarget, options?: Omit<SubmitOptions, "replace" | "state">): void
    • +

      Submits a fetcher <form> to the server without reloading the page.

      +

      Parameters

      • target: SubmitTarget
      • Optional options: Omit<SubmitOptions, "replace" | "state">

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.FormProps.html b/packages/xarc-react-router/docs/interfaces/browser.FormProps.html new file mode 100644 index 000000000..bbbfad53f --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.FormProps.html @@ -0,0 +1,172 @@ +FormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FormProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional reloadDocument

    reloadDocument?: boolean
    +

    Forces a full document navigation instead of a fetch.

    +

    Optional replace

    replace?: boolean
    +

    Replaces the current entry in the browser history stack when the form +navigates. Use this if you don't want the user to be able to click "back" +to the page with the form on it.

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any
    +

    State object to add to the history stack entry for this navigation

    +

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.HashRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.HashRouterProps.html new file mode 100644 index 000000000..907dbd16b --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.HashRouterProps.html @@ -0,0 +1 @@ +HashRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HashRouterProps

    Hierarchy

    • HashRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.HistoryRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.HistoryRouterProps.html new file mode 100644 index 000000000..b942736ee --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.HistoryRouterProps.html @@ -0,0 +1 @@ +HistoryRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HistoryRouterProps

    Hierarchy

    • HistoryRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    history

    history: History

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.LinkProps.html b/packages/xarc-react-router/docs/interfaces/browser.LinkProps.html new file mode 100644 index 000000000..1997d85f4 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.LinkProps.html @@ -0,0 +1,146 @@ +LinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LinkProps

    Hierarchy

    • Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href">
      • LinkProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.NavLinkProps.html b/packages/xarc-react-router/docs/interfaces/browser.NavLinkProps.html new file mode 100644 index 000000000..be8290bcd --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.NavLinkProps.html @@ -0,0 +1,146 @@ +NavLinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavLinkProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode | ((props: { isActive: boolean; isPending: boolean }) => ReactNode)

    Optional className

    className?: string | ((props: { isActive: boolean; isPending: boolean }) => string)

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional end

    end?: boolean

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties | ((props: { isActive: boolean; isPending: boolean }) => CSSProperties)

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouter.FutureConfig.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouter.FutureConfig.html new file mode 100644 index 000000000..1b12533ad --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouter.FutureConfig.html @@ -0,0 +1 @@ +FutureConfig | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FutureConfig

    Hierarchy

    • FutureConfig

    Index

    Properties

    Properties

    v7_startTransition

    v7_startTransition: boolean

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunction.html new file mode 100644 index 000000000..fa628cce2 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunction.html @@ -0,0 +1,3 @@ +ActionFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ActionFunction

    Hierarchy

    • ActionFunction

    Callable

    • +

      Route action function signature

      +

      Parameters

      Returns DataFunctionValue | Promise<DataFunctionValue>

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunctionArgs.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunctionArgs.html new file mode 100644 index 000000000..b5c67d89d --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ActionFunctionArgs.html @@ -0,0 +1,3 @@ +ActionFunctionArgs | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ActionFunctionArgs

    +

    Arguments passed to action functions

    +

    Hierarchy

    • DataFunctionArgs
      • ActionFunctionArgs

    Index

    Properties

    Properties

    Optional context

    context?: any

    params

    params: Params<string>

    request

    request: Request

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.AwaitProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.AwaitProps.html new file mode 100644 index 000000000..937f0880f --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.AwaitProps.html @@ -0,0 +1 @@ +AwaitProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AwaitProps

    Hierarchy

    • AwaitProps

    Index

    Properties

    Properties

    children

    children: ReactNode | AwaitResolveRenderFunction

    Optional errorElement

    errorElement?: ReactNode

    resolve

    resolve: any

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.BrowserRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.BrowserRouterProps.html new file mode 100644 index 000000000..17cbc919d --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.BrowserRouterProps.html @@ -0,0 +1 @@ +BrowserRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BrowserRouterProps

    Hierarchy

    • BrowserRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.DataRouteMatch.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.DataRouteMatch.html new file mode 100644 index 000000000..c5989c29f --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.DataRouteMatch.html @@ -0,0 +1,9 @@ +DataRouteMatch | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DataRouteMatch

    Hierarchy

    Index

    Properties

    Properties

    params

    params: Params<string>
    +

    The names and values of dynamic parameters in the URL.

    +

    pathname

    pathname: string
    +

    The portion of the URL pathname that was matched.

    +

    pathnameBase

    pathnameBase: string
    +

    The portion of the URL pathname that was matched before child routes.

    +

    route

    route: DataRouteObject
    +

    The route object that was used to match.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherFormProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherFormProps.html new file mode 100644 index 000000000..b4d39c0ab --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherFormProps.html @@ -0,0 +1,164 @@ +FetcherFormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherFormProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherSubmitFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherSubmitFunction.html new file mode 100644 index 000000000..035797423 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FetcherSubmitFunction.html @@ -0,0 +1,3 @@ +FetcherSubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherSubmitFunction

    Hierarchy

    • FetcherSubmitFunction

    Callable

    • FetcherSubmitFunction(target: SubmitTarget, options?: Omit<SubmitOptions, "replace" | "state">): void
    • +

      Submits a fetcher <form> to the server without reloading the page.

      +

      Parameters

      • target: SubmitTarget
      • Optional options: Omit<SubmitOptions, "replace" | "state">

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FormProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FormProps.html new file mode 100644 index 000000000..027526d44 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.FormProps.html @@ -0,0 +1,172 @@ +FormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FormProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional reloadDocument

    reloadDocument?: boolean
    +

    Forces a full document navigation instead of a fetch.

    +

    Optional replace

    replace?: boolean
    +

    Replaces the current entry in the browser history stack when the form +navigates. Use this if you don't want the user to be able to click "back" +to the page with the form on it.

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any
    +

    State object to add to the history stack entry for this navigation

    +

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.GetScrollRestorationKeyFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.GetScrollRestorationKeyFunction.html new file mode 100644 index 000000000..43bd80083 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.GetScrollRestorationKeyFunction.html @@ -0,0 +1,4 @@ +GetScrollRestorationKeyFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GetScrollRestorationKeyFunction

    Hierarchy

    • GetScrollRestorationKeyFunction

    Callable

    • GetScrollRestorationKeyFunction(location: Location, matches: UseMatchesMatch[]): string
    • +

      Function signature for determining the key to be used in scroll restoration +for a given location

      +

      Parameters

      • location: Location
      • matches: UseMatchesMatch[]

      Returns string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HashRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HashRouterProps.html new file mode 100644 index 000000000..858a55382 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HashRouterProps.html @@ -0,0 +1 @@ +HashRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HashRouterProps

    Hierarchy

    • HashRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HistoryRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HistoryRouterProps.html new file mode 100644 index 000000000..76879684c --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.HistoryRouterProps.html @@ -0,0 +1 @@ +HistoryRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HistoryRouterProps

    Hierarchy

    • HistoryRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    history

    history: History

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteObject.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteObject.html new file mode 100644 index 000000000..add0ee5fd --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteObject.html @@ -0,0 +1 @@ +IndexRouteObject | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IndexRouteObject

    Hierarchy

    • IndexRouteObject

    Index

    Properties

    Properties

    Optional Component

    Component?: ComponentType<{}>

    Optional ErrorBoundary

    ErrorBoundary?: ComponentType<{}>

    Optional action

    action?: ActionFunction

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: undefined

    Optional element

    element?: ReactNode

    Optional errorElement

    errorElement?: ReactNode

    Optional handle

    handle?: any

    Optional hasErrorBoundary

    hasErrorBoundary?: boolean

    Optional id

    id?: string

    index

    index: true

    Optional lazy

    lazy?: LazyRouteFunction<RouteObject>

    Optional loader

    loader?: LoaderFunction

    Optional path

    path?: string

    Optional shouldRevalidate

    shouldRevalidate?: ShouldRevalidateFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteProps.html new file mode 100644 index 000000000..d9ca56a6d --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.IndexRouteProps.html @@ -0,0 +1 @@ +IndexRouteProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IndexRouteProps

    Hierarchy

    • IndexRouteProps

    Index

    Properties

    Properties

    Optional Component

    Component?: ComponentType<{}>

    Optional ErrorBoundary

    ErrorBoundary?: ComponentType<{}>

    Optional action

    action?: ActionFunction

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: undefined

    Optional element

    element?: ReactNode

    Optional errorElement

    errorElement?: ReactNode

    Optional handle

    handle?: any

    Optional hasErrorBoundary

    hasErrorBoundary?: boolean

    Optional id

    id?: string

    index

    index: true

    Optional lazy

    lazy?: LazyRouteFunction<IndexRouteObject>

    Optional loader

    loader?: LoaderFunction

    Optional path

    path?: string

    Optional shouldRevalidate

    shouldRevalidate?: ShouldRevalidateFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LayoutRouteProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LayoutRouteProps.html new file mode 100644 index 000000000..5583f42bb --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LayoutRouteProps.html @@ -0,0 +1 @@ +LayoutRouteProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LayoutRouteProps

    Hierarchy

    Index

    Properties

    Properties

    Optional Component

    Component?: ComponentType<{}>

    Optional ErrorBoundary

    ErrorBoundary?: ComponentType<{}>

    Optional action

    action?: ActionFunction

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode

    Optional element

    element?: ReactNode

    Optional errorElement

    errorElement?: ReactNode

    Optional handle

    handle?: any

    Optional hasErrorBoundary

    hasErrorBoundary?: boolean

    Optional id

    id?: string

    Optional index

    index?: false

    Optional lazy

    lazy?: LazyRouteFunction<NonIndexRouteObject>

    Optional loader

    loader?: LoaderFunction

    Optional path

    path?: string

    Optional shouldRevalidate

    shouldRevalidate?: ShouldRevalidateFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LazyRouteFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LazyRouteFunction.html new file mode 100644 index 000000000..c27089464 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LazyRouteFunction.html @@ -0,0 +1,4 @@ +LazyRouteFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LazyRouteFunction<R>

    Type Parameters

    • R extends AgnosticRouteObject

    Hierarchy

    • LazyRouteFunction

    Callable

    • LazyRouteFunction(): Promise<Exclude<{ [ K in string | number | symbol]: K extends Exclude<keyof R, ImmutableRouteKey> ? Omit<Omit<R, ImmutableRouteKey>, K> & Required<Pick<Omit<R, ImmutableRouteKey>, K>> : never }[Exclude<keyof R, ImmutableRouteKey>], undefined>>
    • +

      lazy() function to load a route definition, which can add non-matching +related properties to a route

      +

      Returns Promise<Exclude<{ [ K in string | number | symbol]: K extends Exclude<keyof R, ImmutableRouteKey> ? Omit<Omit<R, ImmutableRouteKey>, K> & Required<Pick<Omit<R, ImmutableRouteKey>, K>> : never }[Exclude<keyof R, ImmutableRouteKey>], undefined>>

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LinkProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LinkProps.html new file mode 100644 index 000000000..e3720601e --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LinkProps.html @@ -0,0 +1,146 @@ +LinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LinkProps

    Hierarchy

    • Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href">
      • LinkProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunction.html new file mode 100644 index 000000000..c5dbf6d31 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunction.html @@ -0,0 +1,3 @@ +LoaderFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LoaderFunction

    Hierarchy

    • LoaderFunction

    Callable

    • +

      Route loader function signature

      +

      Parameters

      Returns DataFunctionValue | Promise<DataFunctionValue>

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunctionArgs.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunctionArgs.html new file mode 100644 index 000000000..2dcd1a273 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.LoaderFunctionArgs.html @@ -0,0 +1,3 @@ +LoaderFunctionArgs | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LoaderFunctionArgs

    +

    Arguments passed to loader functions

    +

    Hierarchy

    • DataFunctionArgs
      • LoaderFunctionArgs

    Index

    Properties

    Properties

    Optional context

    context?: any

    params

    params: Params<string>

    request

    request: Request

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Location.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Location.html new file mode 100644 index 000000000..295674094 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Location.html @@ -0,0 +1,16 @@ +Location | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Location

    +

    An entry in a history stack. A location contains information about the +URL path, as well as possibly some arbitrary state and a key.

    +

    Hierarchy

    Index

    Properties

    Properties

    hash

    hash: string
    +

    A URL fragment identifier, beginning with a #.

    +

    key

    key: string
    +

    A unique string associated with this location. May be used to safely store +and retrieve data in some other storage API, like localStorage.

    +

    Note: This value is always "default" on the initial location.

    +

    pathname

    pathname: string
    +

    A URL pathname, beginning with a /.

    +

    search

    search: string
    +

    A URL search string, beginning with a ?.

    +

    state

    state: any
    +

    A value of arbitrary data associated with this location.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.MemoryRouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.MemoryRouterProps.html new file mode 100644 index 000000000..8ce462026 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.MemoryRouterProps.html @@ -0,0 +1 @@ +MemoryRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MemoryRouterProps

    Hierarchy

    • MemoryRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional initialEntries

    initialEntries?: InitialEntry[]

    Optional initialIndex

    initialIndex?: number

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavLinkProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavLinkProps.html new file mode 100644 index 000000000..052f5fe67 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavLinkProps.html @@ -0,0 +1,146 @@ +NavLinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavLinkProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode | ((props: { isActive: boolean; isPending: boolean }) => ReactNode)

    Optional className

    className?: string | ((props: { isActive: boolean; isPending: boolean }) => string)

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional end

    end?: boolean

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties | ((props: { isActive: boolean; isPending: boolean }) => CSSProperties)

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateFunction.html new file mode 100644 index 000000000..5ec054ef8 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateFunction.html @@ -0,0 +1,5 @@ +NavigateFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavigateFunction

    Hierarchy

    • NavigateFunction

    Callable

    • NavigateFunction(to: To, options?: NavigateOptions): void
    • NavigateFunction(delta: number): void
    • +

      The interface for the navigate() function returned from useNavigate().

      +

      Parameters

      Returns void

    • +

      The interface for the navigate() function returned from useNavigate().

      +

      Parameters

      • delta: number

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateOptions.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateOptions.html new file mode 100644 index 000000000..c702469cf --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateOptions.html @@ -0,0 +1 @@ +NavigateOptions | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavigateOptions

    Hierarchy

    • NavigateOptions

    Index

    Properties

    Properties

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional relative

    relative?: RelativeRoutingType

    Optional replace

    replace?: boolean

    Optional state

    state?: any

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateProps.html new file mode 100644 index 000000000..742cda6f9 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NavigateProps.html @@ -0,0 +1 @@ +NavigateProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavigateProps

    Hierarchy

    • NavigateProps

    Index

    Properties

    Properties

    Optional relative

    relative?: RelativeRoutingType

    Optional replace

    replace?: boolean

    Optional state

    state?: any

    to

    to: To

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Navigator.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Navigator.html new file mode 100644 index 000000000..15f4deefb --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Navigator.html @@ -0,0 +1,24 @@ +Navigator | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Navigator

    +

    A Navigator is a "location changer"; it's how you get to different locations.

    +

    Every history instance conforms to the Navigator interface, but the +distinction is useful primarily when it comes to the low-level API +where both the location and a navigator must be provided separately in order +to avoid "tearing" that may occur in a suspense-enabled app if the action +and/or location were to be read directly from the history instance.

    +

    Hierarchy

    • Navigator

    Index

    Properties

    Methods

    Properties

    createHref

    createHref: ((to: To) => string)

    Type declaration

      • (to: To): string
      • +

        Returns a valid href for the given to value that may be used as +the value of an attribute.

        +

        Parameters

        Returns string

    Optional encodeLocation

    encodeLocation?: ((to: To) => Path)

    Type declaration

      • +

        Encode a location the same way window.history would do (no-op for memory +history) so we ensure our PUSH/REPLACE navigations for data routers +behave the same as POP

        +

        Parameters

        • to: To
          +

          Unencoded path

          +

        Returns Path

    go

    go: ((delta: number) => void)

    Type declaration

      • (delta: number): void
      • +

        Navigates n entries backward/forward in the history stack relative to the +current index. For example, a "back" navigation would use go(-1).

        +

        Parameters

        • delta: number
          +

          The delta in the stack index

          +

        Returns void

    Methods

    push

    • Parameters

      Returns void

    replace

    • Parameters

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NonIndexRouteObject.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NonIndexRouteObject.html new file mode 100644 index 000000000..cc6db5e55 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.NonIndexRouteObject.html @@ -0,0 +1 @@ +NonIndexRouteObject | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NonIndexRouteObject

    Hierarchy

    • NonIndexRouteObject

    Index

    Properties

    Properties

    Optional Component

    Component?: ComponentType<{}>

    Optional ErrorBoundary

    ErrorBoundary?: ComponentType<{}>

    Optional action

    action?: ActionFunction

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: RouteObject[]

    Optional element

    element?: ReactNode

    Optional errorElement

    errorElement?: ReactNode

    Optional handle

    handle?: any

    Optional hasErrorBoundary

    hasErrorBoundary?: boolean

    Optional id

    id?: string

    Optional index

    index?: false

    Optional lazy

    lazy?: LazyRouteFunction<RouteObject>

    Optional loader

    loader?: LoaderFunction

    Optional path

    path?: string

    Optional shouldRevalidate

    shouldRevalidate?: ShouldRevalidateFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.OutletProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.OutletProps.html new file mode 100644 index 000000000..74d72d39b --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.OutletProps.html @@ -0,0 +1 @@ +OutletProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface OutletProps

    Hierarchy

    • OutletProps

    Index

    Properties

    Properties

    Optional context

    context?: unknown

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Path.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Path.html new file mode 100644 index 000000000..b4560d841 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.Path.html @@ -0,0 +1,9 @@ +Path | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Path

    +

    The pathname, search, and hash values of a URL.

    +

    Hierarchy

    Index

    Properties

    Properties

    hash

    hash: string
    +

    A URL fragment identifier, beginning with a #.

    +

    pathname

    pathname: string
    +

    A URL pathname, beginning with a /.

    +

    search

    search: string
    +

    A URL search string, beginning with a ?.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathMatch.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathMatch.html new file mode 100644 index 000000000..acee6d0ed --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathMatch.html @@ -0,0 +1,11 @@ +PathMatch | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathMatch<ParamKey>

    +

    A PathMatch contains info about how a PathPattern matched on a URL pathname.

    +

    Type Parameters

    • ParamKey extends string = string

    Hierarchy

    • PathMatch

    Index

    Properties

    Properties

    params

    params: Params<ParamKey>
    +

    The names and values of dynamic parameters in the URL.

    +

    pathname

    pathname: string
    +

    The portion of the URL pathname that was matched.

    +

    pathnameBase

    pathnameBase: string
    +

    The portion of the URL pathname that was matched before child routes.

    +

    pattern

    pattern: PathPattern<string>
    +

    The pattern that was used to match.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathPattern.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathPattern.html new file mode 100644 index 000000000..6d0aa5366 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathPattern.html @@ -0,0 +1,12 @@ +PathPattern | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathPattern<Path>

    +

    A PathPattern is used to match on some portion of a URL pathname.

    +

    Type Parameters

    • Path extends string = string

    Hierarchy

    • PathPattern

    Index

    Properties

    Properties

    Optional caseSensitive

    caseSensitive?: boolean
    +

    Should be true if the static portions of the path should be matched in +the same case.

    +

    Optional end

    end?: boolean
    +

    Should be true if this pattern should match the entire URL pathname.

    +

    path

    path: Path
    +

    A string to match against a URL pathname. May contain :id-style segments +to indicate placeholders for dynamic parameters. May also end with /* to +indicate matching the rest of the URL pathname.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathRouteProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathRouteProps.html new file mode 100644 index 000000000..69d75d11d --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.PathRouteProps.html @@ -0,0 +1 @@ +PathRouteProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathRouteProps

    Hierarchy

    Index

    Properties

    Properties

    Optional Component

    Component?: ComponentType<{}>

    Optional ErrorBoundary

    ErrorBoundary?: ComponentType<{}>

    Optional action

    action?: ActionFunction

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode

    Optional element

    element?: ReactNode

    Optional errorElement

    errorElement?: ReactNode

    Optional handle

    handle?: any

    Optional hasErrorBoundary

    hasErrorBoundary?: boolean

    Optional id

    id?: string

    Optional index

    index?: false

    Optional lazy

    lazy?: LazyRouteFunction<NonIndexRouteObject>

    Optional loader

    loader?: LoaderFunction

    Optional path

    path?: string

    Optional shouldRevalidate

    shouldRevalidate?: ShouldRevalidateFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouteMatch.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouteMatch.html new file mode 100644 index 000000000..290a955d3 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouteMatch.html @@ -0,0 +1,9 @@ +RouteMatch | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RouteMatch<ParamKey, RouteObjectType>

    Type Parameters

    Hierarchy

    Index

    Properties

    Properties

    params

    params: Params<ParamKey>
    +

    The names and values of dynamic parameters in the URL.

    +

    pathname

    pathname: string
    +

    The portion of the URL pathname that was matched.

    +

    pathnameBase

    pathnameBase: string
    +

    The portion of the URL pathname that was matched before child routes.

    +

    route

    route: RouteObjectType
    +

    The route object that was used to match.

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProps.html new file mode 100644 index 000000000..207ac5752 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProps.html @@ -0,0 +1 @@ +RouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RouterProps

    Hierarchy

    • RouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    location

    location: string | Partial<Location>

    Optional navigationType

    navigationType?: NavigationType

    navigator

    navigator: Navigator

    Optional static

    static?: boolean

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProviderProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProviderProps.html new file mode 100644 index 000000000..2a99573d2 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RouterProviderProps.html @@ -0,0 +1 @@ +RouterProviderProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RouterProviderProps

    Hierarchy

    • RouterProviderProps

    Index

    Properties

    Properties

    Optional fallbackElement

    fallbackElement?: ReactNode

    Optional future

    future?: FutureConfig

    router

    router: Router

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RoutesProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RoutesProps.html new file mode 100644 index 000000000..689d26616 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.RoutesProps.html @@ -0,0 +1 @@ +RoutesProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RoutesProps

    Hierarchy

    • RoutesProps

    Index

    Properties

    Properties

    Optional children

    children?: ReactNode

    Optional location

    location?: string | Partial<Location>

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ScrollRestorationProps.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ScrollRestorationProps.html new file mode 100644 index 000000000..7f363dd93 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ScrollRestorationProps.html @@ -0,0 +1 @@ +ScrollRestorationProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ScrollRestorationProps

    Hierarchy

    • ScrollRestorationProps

    Index

    Properties

    Properties

    Optional getKey

    getKey?: GetScrollRestorationKeyFunction

    Optional storageKey

    storageKey?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ShouldRevalidateFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ShouldRevalidateFunction.html new file mode 100644 index 000000000..32a4232dc --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.ShouldRevalidateFunction.html @@ -0,0 +1,7 @@ +ShouldRevalidateFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ShouldRevalidateFunction

    Hierarchy

    • ShouldRevalidateFunction

    Callable

    • ShouldRevalidateFunction(args: { actionResult?: DataResult; currentParams: Params<string>; currentUrl: URL; defaultShouldRevalidate: boolean; formAction?: string; formData?: FormData; formEncType?: FormEncType; formMethod?: LowerCaseFormMethod | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"; json?: JsonValue; nextParams: Params<string>; nextUrl: URL; text?: string }): boolean
    • +

      Route shouldRevalidate function signature. This runs after any submission +(navigation or fetcher), so we flatten the navigation/fetcher submission +onto the arguments. It shouldn't matter whether it came from a navigation +or a fetcher, what really matters is the URLs and the formData since loaders +have to re-run based on the data models that were potentially mutated.

      +

      Parameters

      • args: { actionResult?: DataResult; currentParams: Params<string>; currentUrl: URL; defaultShouldRevalidate: boolean; formAction?: string; formData?: FormData; formEncType?: FormEncType; formMethod?: LowerCaseFormMethod | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"; json?: JsonValue; nextParams: Params<string>; nextUrl: URL; text?: string }
        • Optional actionResult?: DataResult
        • currentParams: Params<string>
        • currentUrl: URL
        • defaultShouldRevalidate: boolean
        • Optional formAction?: string
        • Optional formData?: FormData
        • Optional formEncType?: FormEncType
        • Optional formMethod?: LowerCaseFormMethod | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
        • Optional json?: JsonValue
        • nextParams: Params<string>
        • nextUrl: URL
        • Optional text?: string

      Returns boolean

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitFunction.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitFunction.html new file mode 100644 index 000000000..ff3c9e05f --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitFunction.html @@ -0,0 +1,3 @@ +SubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitFunction

    Hierarchy

    • SubmitFunction

    Callable

    • SubmitFunction(target: SubmitTarget, options?: SubmitOptions): void
    • +

      Submits a HTML <form> to the server without reloading the page.

      +

      Parameters

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitOptions.html b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitOptions.html new file mode 100644 index 000000000..8a30444d2 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ReactRouterDom.SubmitOptions.html @@ -0,0 +1,23 @@ +SubmitOptions | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitOptions

    Hierarchy

    • SubmitOptions

    Index

    Properties

    Properties

    Optional action

    action?: string
    +

    The action URL path used to submit the form. Overrides <form action>. +Defaults to the path of the current route.

    +

    Optional encType

    encType?: FormEncType
    +

    The encoding used to submit the form. Overrides <form encType>. +Defaults to "application/x-www-form-urlencoded".

    +

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP method used to submit the form. Overrides <form method>. +Defaults to "GET".

    +

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    In browser-based environments, prevent resetting scroll after this +navigation when using the component

    +

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional replace

    replace?: boolean
    +

    Set true to replace the current entry in the browser's history stack +instead of creating a new one (i.e. stay on "the same page"). Defaults +to false.

    +

    Optional state

    state?: any
    +

    State object to add to the history stack entry for this navigation

    +

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.ScrollRestorationProps.html b/packages/xarc-react-router/docs/interfaces/browser.ScrollRestorationProps.html new file mode 100644 index 000000000..bd4240e16 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.ScrollRestorationProps.html @@ -0,0 +1 @@ +ScrollRestorationProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ScrollRestorationProps

    Hierarchy

    • ScrollRestorationProps

    Index

    Properties

    Properties

    Optional getKey

    getKey?: GetScrollRestorationKeyFunction

    Optional storageKey

    storageKey?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/browser.SubmitFunction.html b/packages/xarc-react-router/docs/interfaces/browser.SubmitFunction.html new file mode 100644 index 000000000..46222bbc5 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/browser.SubmitFunction.html @@ -0,0 +1,3 @@ +SubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitFunction

    Hierarchy

    • SubmitFunction

    Callable

    • SubmitFunction(target: SubmitTarget, options?: SubmitOptions): void
    • +

      Submits a HTML <form> to the server without reloading the page.

      +

      Parameters

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.BrowserRouterProps.html b/packages/xarc-react-router/docs/interfaces/common.BrowserRouterProps.html new file mode 100644 index 000000000..d4afd9fad --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.BrowserRouterProps.html @@ -0,0 +1 @@ +BrowserRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BrowserRouterProps

    Hierarchy

    • BrowserRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.FetcherFormProps.html b/packages/xarc-react-router/docs/interfaces/common.FetcherFormProps.html new file mode 100644 index 000000000..598c21620 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.FetcherFormProps.html @@ -0,0 +1,164 @@ +FetcherFormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherFormProps

    Hierarchy

    • FormHTMLAttributes<HTMLFormElement>
      • FetcherFormProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.FetcherSubmitFunction.html b/packages/xarc-react-router/docs/interfaces/common.FetcherSubmitFunction.html new file mode 100644 index 000000000..0151b1c20 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.FetcherSubmitFunction.html @@ -0,0 +1,3 @@ +FetcherSubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherSubmitFunction

    Hierarchy

    • FetcherSubmitFunction

    Callable

    • FetcherSubmitFunction(target: SubmitTarget, options?: Omit<SubmitOptions, "replace" | "state">): void
    • +

      Submits a fetcher <form> to the server without reloading the page.

      +

      Parameters

      • target: SubmitTarget
      • Optional options: Omit<SubmitOptions, "replace" | "state">

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.FormProps.html b/packages/xarc-react-router/docs/interfaces/common.FormProps.html new file mode 100644 index 000000000..f69f207f5 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.FormProps.html @@ -0,0 +1,172 @@ +FormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FormProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional reloadDocument

    reloadDocument?: boolean
    +

    Forces a full document navigation instead of a fetch.

    +

    Optional replace

    replace?: boolean
    +

    Replaces the current entry in the browser history stack when the form +navigates. Use this if you don't want the user to be able to click "back" +to the page with the form on it.

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any
    +

    State object to add to the history stack entry for this navigation

    +

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.HashRouterProps.html b/packages/xarc-react-router/docs/interfaces/common.HashRouterProps.html new file mode 100644 index 000000000..df25cfc37 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.HashRouterProps.html @@ -0,0 +1 @@ +HashRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HashRouterProps

    Hierarchy

    • HashRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.HistoryRouterProps.html b/packages/xarc-react-router/docs/interfaces/common.HistoryRouterProps.html new file mode 100644 index 000000000..50aa940cc --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.HistoryRouterProps.html @@ -0,0 +1 @@ +HistoryRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HistoryRouterProps

    Hierarchy

    • HistoryRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    history

    history: History

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.LinkProps.html b/packages/xarc-react-router/docs/interfaces/common.LinkProps.html new file mode 100644 index 000000000..d2633fba5 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.LinkProps.html @@ -0,0 +1,146 @@ +LinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LinkProps

    Hierarchy

    • Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href">
      • LinkProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.NavLinkProps.html b/packages/xarc-react-router/docs/interfaces/common.NavLinkProps.html new file mode 100644 index 000000000..16f5a6126 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.NavLinkProps.html @@ -0,0 +1,146 @@ +NavLinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavLinkProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode | ((props: { isActive: boolean; isPending: boolean }) => ReactNode)

    Optional className

    className?: string | ((props: { isActive: boolean; isPending: boolean }) => string)

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional end

    end?: boolean

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties | ((props: { isActive: boolean; isPending: boolean }) => CSSProperties)

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.ScrollRestorationProps.html b/packages/xarc-react-router/docs/interfaces/common.ScrollRestorationProps.html new file mode 100644 index 000000000..f2f652db8 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.ScrollRestorationProps.html @@ -0,0 +1 @@ +ScrollRestorationProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ScrollRestorationProps

    Hierarchy

    • ScrollRestorationProps

    Index

    Properties

    Properties

    Optional getKey

    getKey?: GetScrollRestorationKeyFunction

    Optional storageKey

    storageKey?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/common.SubmitFunction.html b/packages/xarc-react-router/docs/interfaces/common.SubmitFunction.html new file mode 100644 index 000000000..bd6d56423 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/common.SubmitFunction.html @@ -0,0 +1,3 @@ +SubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitFunction

    Hierarchy

    • SubmitFunction

    Callable

    • SubmitFunction(target: SubmitTarget, options?: SubmitOptions): void
    • +

      Submits a HTML <form> to the server without reloading the page.

      +

      Parameters

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.BrowserRouterProps.html b/packages/xarc-react-router/docs/interfaces/node.BrowserRouterProps.html new file mode 100644 index 000000000..0f4f6a263 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.BrowserRouterProps.html @@ -0,0 +1 @@ +BrowserRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface BrowserRouterProps

    Hierarchy

    • BrowserRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.FetcherFormProps.html b/packages/xarc-react-router/docs/interfaces/node.FetcherFormProps.html new file mode 100644 index 000000000..cf97d8eb5 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.FetcherFormProps.html @@ -0,0 +1,164 @@ +FetcherFormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherFormProps

    Hierarchy

    • FormHTMLAttributes<HTMLFormElement>
      • FetcherFormProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.FetcherSubmitFunction.html b/packages/xarc-react-router/docs/interfaces/node.FetcherSubmitFunction.html new file mode 100644 index 000000000..696b993e3 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.FetcherSubmitFunction.html @@ -0,0 +1,3 @@ +FetcherSubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FetcherSubmitFunction

    Hierarchy

    • FetcherSubmitFunction

    Callable

    • FetcherSubmitFunction(target: SubmitTarget, options?: Omit<SubmitOptions, "replace" | "state">): void
    • +

      Submits a fetcher <form> to the server without reloading the page.

      +

      Parameters

      • target: SubmitTarget
      • Optional options: Omit<SubmitOptions, "replace" | "state">

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.FormProps.html b/packages/xarc-react-router/docs/interfaces/node.FormProps.html new file mode 100644 index 000000000..89f67eeda --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.FormProps.html @@ -0,0 +1,172 @@ +FormProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FormProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional acceptCharset

    acceptCharset?: string

    Optional accessKey

    accessKey?: string

    Optional action

    action?: string
    +

    Normal <form action> but supports React Router's relative paths.

    +

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoComplete

    autoComplete?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional draggable

    draggable?: Booleanish

    Optional encType

    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"
    +

    <form encType> - enhancing beyond the normal string type and limiting +to the built-in browser supported values

    +

    Optional hidden

    hidden?: boolean

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional method

    method?: HTMLFormMethod
    +

    The HTTP verb to use when the form is submit. Supports "get", "post", +"put", "delete", "patch".

    +

    Optional name

    name?: string

    Optional noValidate

    noValidate?: boolean

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLFormElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLFormElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLFormElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLFormElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLFormElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLFormElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLFormElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLFormElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLFormElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLFormElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLFormElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLFormElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLFormElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLFormElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLFormElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLFormElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLFormElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLFormElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLFormElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLFormElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLFormElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLFormElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLFormElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLFormElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLFormElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLFormElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLFormElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLFormElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLFormElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onError

    onError?: ReactEventHandler<HTMLFormElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLFormElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLFormElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLFormElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLFormElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLFormElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLFormElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLFormElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLFormElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLFormElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLFormElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLFormElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLFormElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLFormElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLFormElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLFormElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLFormElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLFormElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLFormElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLFormElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLFormElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLFormElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLFormElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLFormElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLFormElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLFormElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLFormElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLFormElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLFormElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLFormElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLFormElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLFormElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLFormElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLFormElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLFormElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLFormElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLFormElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLFormElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLFormElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLFormElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLFormElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLFormElement>
    +

    A function to call when the form is submitted. If you call +event.preventDefault() then this form will not do anything.

    +

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLFormElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLFormElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLFormElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLFormElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLFormElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLFormElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLFormElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLFormElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLFormElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLFormElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLFormElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLFormElement>

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean
    +

    Prevent the scroll position from resetting to the top of the viewport on +completion of the navigation when using the component

    +

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType
    +

    Determines whether the form action is relative to the route hierarchy or +the pathname. Use this if you want to opt out of navigating the route +hierarchy and want to instead route based on /-delimited URL segments

    +

    Optional reloadDocument

    reloadDocument?: boolean
    +

    Forces a full document navigation instead of a fetch.

    +

    Optional replace

    replace?: boolean
    +

    Replaces the current entry in the browser history stack when the form +navigates. Use this if you don't want the user to be able to click "back" +to the page with the form on it.

    +

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any
    +

    State object to add to the history stack entry for this navigation

    +

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: string

    Optional title

    title?: string

    Optional translate

    translate?: "yes" | "no"

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.HashRouterProps.html b/packages/xarc-react-router/docs/interfaces/node.HashRouterProps.html new file mode 100644 index 000000000..92e6d503a --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.HashRouterProps.html @@ -0,0 +1 @@ +HashRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HashRouterProps

    Hierarchy

    • HashRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    Optional window

    window?: Window

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.HistoryRouterProps.html b/packages/xarc-react-router/docs/interfaces/node.HistoryRouterProps.html new file mode 100644 index 000000000..b3b48c5f4 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.HistoryRouterProps.html @@ -0,0 +1 @@ +HistoryRouterProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface HistoryRouterProps

    Hierarchy

    • HistoryRouterProps

    Index

    Properties

    Properties

    Optional basename

    basename?: string

    Optional children

    children?: ReactNode

    Optional future

    future?: FutureConfig

    history

    history: History

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.LinkProps.html b/packages/xarc-react-router/docs/interfaces/node.LinkProps.html new file mode 100644 index 000000000..f5425e82b --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.LinkProps.html @@ -0,0 +1,146 @@ +LinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LinkProps

    Hierarchy

    • Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href">
      • LinkProps

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional children

    children?: ReactNode

    Optional className

    className?: string

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.NavLinkProps.html b/packages/xarc-react-router/docs/interfaces/node.NavLinkProps.html new file mode 100644 index 000000000..54846e1cd --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.NavLinkProps.html @@ -0,0 +1,146 @@ +NavLinkProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NavLinkProps

    Hierarchy

    Index

    Properties

    Properties

    Optional about

    about?: string

    Optional accessKey

    accessKey?: string

    Optional aria-activedescendant

    aria-activedescendant?: string
    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optional aria-atomic

    aria-atomic?: Booleanish
    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optional aria-autocomplete

    aria-autocomplete?: "inline" | "both" | "none" | "list"
    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optional aria-braillelabel

    aria-braillelabel?: string
    +

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +
    see

    aria-label.

    +

    Optional aria-brailleroledescription

    aria-brailleroledescription?: string
    +

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +
    see

    aria-roledescription.

    +

    Optional aria-busy

    aria-busy?: Booleanish

    Optional aria-checked

    aria-checked?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +
    see

    aria-pressed @see aria-selected.

    +

    Optional aria-colcount

    aria-colcount?: number
    +

    Defines the total number of columns in a table, grid, or treegrid.

    +
    see

    aria-colindex.

    +

    Optional aria-colindex

    aria-colindex?: number
    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +
    see

    aria-colcount @see aria-colspan.

    +

    Optional aria-colindextext

    aria-colindextext?: string
    +

    Defines a human readable text alternative of aria-colindex.

    +
    see

    aria-rowindextext.

    +

    Optional aria-colspan

    aria-colspan?: number
    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-colindex @see aria-rowspan.

    +

    Optional aria-controls

    aria-controls?: string
    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +
    see

    aria-owns.

    +

    Optional aria-current

    aria-current?: boolean | "location" | "time" | "false" | "page" | "true" | "step" | "date"
    +

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optional aria-describedby

    aria-describedby?: string
    +

    Identifies the element (or elements) that describes the object.

    +
    see

    aria-labelledby

    +

    Optional aria-description

    aria-description?: string
    +

    Defines a string value that describes or annotates the current element.

    +
    see

    related aria-describedby.

    +

    Optional aria-details

    aria-details?: string
    +

    Identifies the element that provides a detailed, extended description for the object.

    +
    see

    aria-describedby.

    +

    Optional aria-disabled

    aria-disabled?: Booleanish
    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +
    see

    aria-hidden @see aria-readonly.

    +

    Optional aria-dropeffect

    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup"
    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-errormessage

    aria-errormessage?: string
    +

    Identifies the element that provides an error message for the object.

    +
    see

    aria-invalid @see aria-describedby.

    +

    Optional aria-expanded

    aria-expanded?: Booleanish
    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optional aria-flowto

    aria-flowto?: string
    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optional aria-grabbed

    aria-grabbed?: Booleanish
    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +
    deprecated

    in ARIA 1.1

    +

    Optional aria-haspopup

    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "false" | "listbox" | "true" | "tree"
    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optional aria-hidden

    aria-hidden?: Booleanish
    +

    Indicates whether the element is exposed to an accessibility API.

    +
    see

    aria-disabled.

    +

    Optional aria-invalid

    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling"
    +

    Indicates the entered value does not conform to the format expected by the application.

    +
    see

    aria-errormessage.

    +

    Optional aria-keyshortcuts

    aria-keyshortcuts?: string
    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optional aria-label

    aria-label?: string
    +

    Defines a string value that labels the current element.

    +
    see

    aria-labelledby.

    +

    Optional aria-labelledby

    aria-labelledby?: string
    +

    Identifies the element (or elements) that labels the current element.

    +
    see

    aria-describedby.

    +

    Optional aria-level

    aria-level?: number
    +

    Defines the hierarchical level of an element within a structure.

    +

    Optional aria-live

    aria-live?: "off" | "assertive" | "polite"
    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optional aria-modal

    aria-modal?: Booleanish
    +

    Indicates whether an element is modal when displayed.

    +

    Optional aria-multiline

    aria-multiline?: Booleanish
    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optional aria-multiselectable

    aria-multiselectable?: Booleanish
    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optional aria-orientation

    aria-orientation?: "horizontal" | "vertical"
    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optional aria-owns

    aria-owns?: string
    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +
    see

    aria-controls.

    +

    Optional aria-placeholder

    aria-placeholder?: string
    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optional aria-posinset

    aria-posinset?: number
    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-setsize.

    +

    Optional aria-pressed

    aria-pressed?: boolean | "false" | "mixed" | "true"
    +

    Indicates the current "pressed" state of toggle buttons.

    +
    see

    aria-checked @see aria-selected.

    +

    Optional aria-readonly

    aria-readonly?: Booleanish
    +

    Indicates that the element is not editable, but is otherwise operable.

    +
    see

    aria-disabled.

    +

    Optional aria-relevant

    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +
    see

    aria-atomic.

    +

    Optional aria-required

    aria-required?: Booleanish
    +

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optional aria-roledescription

    aria-roledescription?: string
    +

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optional aria-rowcount

    aria-rowcount?: number
    +

    Defines the total number of rows in a table, grid, or treegrid.

    +
    see

    aria-rowindex.

    +

    Optional aria-rowindex

    aria-rowindex?: number
    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +
    see

    aria-rowcount @see aria-rowspan.

    +

    Optional aria-rowindextext

    aria-rowindextext?: string
    +

    Defines a human readable text alternative of aria-rowindex.

    +
    see

    aria-colindextext.

    +

    Optional aria-rowspan

    aria-rowspan?: number
    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +
    see

    aria-rowindex @see aria-colspan.

    +

    Optional aria-selected

    aria-selected?: Booleanish
    +

    Indicates the current "selected" state of various widgets.

    +
    see

    aria-checked @see aria-pressed.

    +

    Optional aria-setsize

    aria-setsize?: number
    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +
    see

    aria-posinset.

    +

    Optional aria-sort

    aria-sort?: "none" | "other" | "ascending" | "descending"
    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optional aria-valuemax

    aria-valuemax?: number
    +

    Defines the maximum allowed value for a range widget.

    +

    Optional aria-valuemin

    aria-valuemin?: number
    +

    Defines the minimum allowed value for a range widget.

    +

    Optional aria-valuenow

    aria-valuenow?: number
    +

    Defines the current value for a range widget.

    +
    see

    aria-valuetext.

    +

    Optional aria-valuetext

    aria-valuetext?: string
    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +

    Optional autoCapitalize

    autoCapitalize?: string

    Optional autoCorrect

    autoCorrect?: string

    Optional autoFocus

    autoFocus?: boolean

    Optional autoSave

    autoSave?: string

    Optional caseSensitive

    caseSensitive?: boolean

    Optional children

    children?: ReactNode | ((props: { isActive: boolean; isPending: boolean }) => ReactNode)

    Optional className

    className?: string | ((props: { isActive: boolean; isPending: boolean }) => string)

    Optional color

    color?: string

    Optional content

    content?: string

    Optional contentEditable

    contentEditable?: "inherit" | Booleanish

    Optional contextMenu

    contextMenu?: string

    Optional dangerouslySetInnerHTML

    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

    Type declaration

    • __html: string | TrustedHTML

    Optional datatype

    datatype?: string

    Optional defaultChecked

    defaultChecked?: boolean

    Optional defaultValue

    defaultValue?: string | number | readonly string[]

    Optional dir

    dir?: string

    Optional download

    download?: any

    Optional draggable

    draggable?: Booleanish

    Optional end

    end?: boolean

    Optional hidden

    hidden?: boolean

    Optional hrefLang

    hrefLang?: string

    Optional id

    id?: string

    Optional inlist

    inlist?: any

    Optional inputMode

    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "decimal" | "tel" | "email"
    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    see

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +

    Optional is

    is?: string
    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +
    see

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +

    Optional itemID

    itemID?: string

    Optional itemProp

    itemProp?: string

    Optional itemRef

    itemRef?: string

    Optional itemScope

    itemScope?: boolean

    Optional itemType

    itemType?: string

    Optional lang

    lang?: string

    Optional media

    media?: string

    Optional nonce

    nonce?: string

    Optional onAbort

    onAbort?: ReactEventHandler<HTMLAnchorElement>

    Optional onAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLAnchorElement>

    Optional onAuxClick

    onAuxClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onBeforeInput

    onBeforeInput?: FormEventHandler<HTMLAnchorElement>

    Optional onBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onBlur

    onBlur?: FocusEventHandler<HTMLAnchorElement>

    Optional onBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onCanPlay

    onCanPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLAnchorElement>

    Optional onCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onChange

    onChange?: FormEventHandler<HTMLAnchorElement>

    Optional onChangeCapture

    onChangeCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onClick

    onClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onClickCapture

    onClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLAnchorElement>

    Optional onCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLAnchorElement>

    Optional onContextMenu

    onContextMenu?: MouseEventHandler<HTMLAnchorElement>

    Optional onContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onCopy

    onCopy?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCut

    onCut?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLAnchorElement>

    Optional onDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onDrag

    onDrag?: DragEventHandler<HTMLAnchorElement>

    Optional onDragCapture

    onDragCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnd

    onDragEnd?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnter

    onDragEnter?: DragEventHandler<HTMLAnchorElement>

    Optional onDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExit

    onDragExit?: DragEventHandler<HTMLAnchorElement>

    Optional onDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeave

    onDragLeave?: DragEventHandler<HTMLAnchorElement>

    Optional onDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOver

    onDragOver?: DragEventHandler<HTMLAnchorElement>

    Optional onDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStart

    onDragStart?: DragEventHandler<HTMLAnchorElement>

    Optional onDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDrop

    onDrop?: DragEventHandler<HTMLAnchorElement>

    Optional onDropCapture

    onDropCapture?: DragEventHandler<HTMLAnchorElement>

    Optional onDurationChange

    onDurationChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptied

    onEmptied?: ReactEventHandler<HTMLAnchorElement>

    Optional onEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncrypted

    onEncrypted?: ReactEventHandler<HTMLAnchorElement>

    Optional onEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onEnded

    onEnded?: ReactEventHandler<HTMLAnchorElement>

    Optional onEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onError

    onError?: ReactEventHandler<HTMLAnchorElement>

    Optional onErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onFocus

    onFocus?: FocusEventHandler<HTMLAnchorElement>

    Optional onFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLAnchorElement>

    Optional onGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onInput

    onInput?: FormEventHandler<HTMLAnchorElement>

    Optional onInputCapture

    onInputCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalid

    onInvalid?: FormEventHandler<HTMLAnchorElement>

    Optional onInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLAnchorElement>
    deprecated

    Optional onKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLAnchorElement>

    Optional onLoad

    onLoad?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStart

    onLoadStart?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedData

    onLoadedData?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLAnchorElement>

    Optional onLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onMouseDown

    onMouseDown?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMove

    onMouseMove?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOut

    onMouseOut?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOver

    onMouseOver?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUp

    onMouseUp?: MouseEventHandler<HTMLAnchorElement>

    Optional onMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLAnchorElement>

    Optional onPaste

    onPaste?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLAnchorElement>

    Optional onPause

    onPause?: ReactEventHandler<HTMLAnchorElement>

    Optional onPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlay

    onPlay?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlaying

    onPlaying?: ReactEventHandler<HTMLAnchorElement>

    Optional onPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDown

    onPointerDown?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerEnterCapture

    onPointerEnterCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerLeaveCapture

    onPointerLeaveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMove

    onPointerMove?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOut

    onPointerOut?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOver

    onPointerOver?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUp

    onPointerUp?: PointerEventHandler<HTMLAnchorElement>

    Optional onPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLAnchorElement>

    Optional onProgress

    onProgress?: ReactEventHandler<HTMLAnchorElement>

    Optional onProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChange

    onRateChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onReset

    onReset?: FormEventHandler<HTMLAnchorElement>

    Optional onResetCapture

    onResetCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onResize

    onResize?: ReactEventHandler<HTMLAnchorElement>

    Optional onResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onScroll

    onScroll?: UIEventHandler<HTMLAnchorElement>

    Optional onScrollCapture

    onScrollCapture?: UIEventHandler<HTMLAnchorElement>

    Optional onSeeked

    onSeeked?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeeking

    onSeeking?: ReactEventHandler<HTMLAnchorElement>

    Optional onSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelect

    onSelect?: ReactEventHandler<HTMLAnchorElement>

    Optional onSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalled

    onStalled?: ReactEventHandler<HTMLAnchorElement>

    Optional onStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onSubmit

    onSubmit?: FormEventHandler<HTMLAnchorElement>

    Optional onSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLAnchorElement>

    Optional onSuspend

    onSuspend?: ReactEventHandler<HTMLAnchorElement>

    Optional onSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLAnchorElement>

    Optional onTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMove

    onTouchMove?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStart

    onTouchStart?: TouchEventHandler<HTMLAnchorElement>

    Optional onTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLAnchorElement>

    Optional onTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLAnchorElement>

    Optional onTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLAnchorElement>

    Optional onVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLAnchorElement>

    Optional onVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaiting

    onWaiting?: ReactEventHandler<HTMLAnchorElement>

    Optional onWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLAnchorElement>

    Optional onWheel

    onWheel?: WheelEventHandler<HTMLAnchorElement>

    Optional onWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLAnchorElement>

    Optional ping

    ping?: string

    Optional placeholder

    placeholder?: string

    Optional prefix

    prefix?: string

    Optional preventScrollReset

    preventScrollReset?: boolean

    Optional property

    property?: string

    Optional radioGroup

    radioGroup?: string

    Optional referrerPolicy

    referrerPolicy?: HTMLAttributeReferrerPolicy

    Optional rel

    rel?: string

    Optional relative

    relative?: RelativeRoutingType

    Optional reloadDocument

    reloadDocument?: boolean

    Optional replace

    replace?: boolean

    Optional resource

    resource?: string

    Optional results

    results?: number

    Optional rev

    rev?: string

    Optional role

    role?: AriaRole

    Optional security

    security?: string

    Optional slot

    slot?: string

    Optional spellCheck

    spellCheck?: Booleanish

    Optional state

    state?: any

    Optional style

    style?: CSSProperties | ((props: { isActive: boolean; isPending: boolean }) => CSSProperties)

    Optional suppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    Optional suppressHydrationWarning

    suppressHydrationWarning?: boolean

    Optional tabIndex

    tabIndex?: number

    Optional target

    target?: HTMLAttributeAnchorTarget

    Optional title

    title?: string

    to

    to: To

    Optional translate

    translate?: "yes" | "no"

    Optional type

    type?: string

    Optional typeof

    typeof?: string

    Optional unselectable

    unselectable?: "on" | "off"

    Optional vocab

    vocab?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.ScrollRestorationProps.html b/packages/xarc-react-router/docs/interfaces/node.ScrollRestorationProps.html new file mode 100644 index 000000000..e64a7ae64 --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.ScrollRestorationProps.html @@ -0,0 +1 @@ +ScrollRestorationProps | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ScrollRestorationProps

    Hierarchy

    • ScrollRestorationProps

    Index

    Properties

    Properties

    Optional getKey

    getKey?: GetScrollRestorationKeyFunction

    Optional storageKey

    storageKey?: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/interfaces/node.SubmitFunction.html b/packages/xarc-react-router/docs/interfaces/node.SubmitFunction.html new file mode 100644 index 000000000..ef804325d --- /dev/null +++ b/packages/xarc-react-router/docs/interfaces/node.SubmitFunction.html @@ -0,0 +1,3 @@ +SubmitFunction | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitFunction

    Hierarchy

    • SubmitFunction

    Callable

    • SubmitFunction(target: SubmitTarget, options?: SubmitOptions): void
    • +

      Submits a HTML <form> to the server without reloading the page.

      +

      Parameters

      Returns void

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules.html b/packages/xarc-react-router/docs/modules.html index cd948cccc..a63bdc923 100644 --- a/packages/xarc-react-router/docs/modules.html +++ b/packages/xarc-react-router/docs/modules.html @@ -1,126 +1 @@ - - - - - - @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    -

    @xarc/react-router

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    Modules

    - -
    -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +@xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @xarc/react-router

    Index

    Modules

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.ReactRouter.html b/packages/xarc-react-router/docs/modules/browser.ReactRouter.html new file mode 100644 index 000000000..15f5cb383 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/browser.ReactRouter.html @@ -0,0 +1 @@ +ReactRouter | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ReactRouter

    Index

    References

    Interfaces

    Functions

    References

    AbortedDeferredError

    Re-exports AbortedDeferredError

    ActionFunction

    Re-exports ActionFunction

    ActionFunctionArgs

    Re-exports ActionFunctionArgs

    Await

    Re-exports Await

    AwaitProps

    Re-exports AwaitProps

    DataRouteMatch

    Re-exports DataRouteMatch

    DataRouteObject

    Re-exports DataRouteObject

    Fetcher

    Re-exports Fetcher

    Hash

    Re-exports Hash

    IndexRouteObject

    Re-exports IndexRouteObject

    IndexRouteProps

    Re-exports IndexRouteProps

    JsonFunction

    Re-exports JsonFunction

    LayoutRouteProps

    Re-exports LayoutRouteProps

    LazyRouteFunction

    Re-exports LazyRouteFunction

    LoaderFunction

    Re-exports LoaderFunction

    LoaderFunctionArgs

    Re-exports LoaderFunctionArgs

    Location

    Re-exports Location

    MemoryRouter

    Re-exports MemoryRouter

    MemoryRouterProps

    Re-exports MemoryRouterProps

    Navigate

    Re-exports Navigate

    NavigateFunction

    Re-exports NavigateFunction

    NavigateOptions

    Re-exports NavigateOptions

    NavigateProps

    Re-exports NavigateProps

    Navigation

    Re-exports Navigation

    NavigationType

    Re-exports NavigationType

    Navigator

    Re-exports Navigator

    NonIndexRouteObject

    Re-exports NonIndexRouteObject

    Outlet

    Re-exports Outlet

    OutletProps

    Re-exports OutletProps

    ParamParseKey

    Re-exports ParamParseKey

    Params

    Re-exports Params

    Path

    Re-exports Path

    PathMatch

    Re-exports PathMatch

    PathPattern

    Re-exports PathPattern

    PathRouteProps

    Re-exports PathRouteProps

    Pathname

    Re-exports Pathname

    RedirectFunction

    Re-exports RedirectFunction

    RelativeRoutingType

    Re-exports RelativeRoutingType

    Route

    Re-exports Route

    RouteMatch

    Re-exports RouteMatch

    RouteObject

    Re-exports RouteObject

    RouteProps

    Re-exports RouteProps

    Router

    Re-exports Router

    RouterProps

    Re-exports RouterProps

    RouterProvider

    Re-exports RouterProvider

    RouterProviderProps

    Re-exports RouterProviderProps

    Routes

    Re-exports Routes

    RoutesProps

    Re-exports RoutesProps

    Search

    Re-exports Search

    ShouldRevalidateFunction

    Re-exports ShouldRevalidateFunction

    To

    Re-exports To

    UNSAFE_DataRouterContext

    Re-exports UNSAFE_DataRouterContext

    UNSAFE_DataRouterStateContext

    Re-exports UNSAFE_DataRouterStateContext

    UNSAFE_LocationContext

    Re-exports UNSAFE_LocationContext

    UNSAFE_NavigationContext

    Re-exports UNSAFE_NavigationContext

    UNSAFE_RouteContext

    Re-exports UNSAFE_RouteContext

    UNSAFE_useRouteId

    Re-exports UNSAFE_useRouteId

    createPath

    Re-exports createPath

    createRoutesFromChildren

    Re-exports createRoutesFromChildren

    createRoutesFromElements

    Renames and re-exports createRoutesFromChildren

    defer

    Re-exports defer

    generatePath

    Re-exports generatePath

    isRouteErrorResponse

    Re-exports isRouteErrorResponse

    json

    Re-exports json

    matchPath

    Re-exports matchPath

    matchRoutes

    Re-exports matchRoutes

    parsePath

    Re-exports parsePath

    redirect

    Re-exports redirect

    redirectDocument

    Re-exports redirectDocument

    renderMatches

    Re-exports renderMatches

    resolvePath

    Re-exports resolvePath

    unstable_Blocker

    Re-exports unstable_Blocker

    unstable_BlockerFunction

    Re-exports unstable_BlockerFunction

    unstable_useBlocker

    Re-exports unstable_useBlocker

    useActionData

    Re-exports useActionData

    useAsyncError

    Re-exports useAsyncError

    useAsyncValue

    Re-exports useAsyncValue

    useHref

    Re-exports useHref

    useInRouterContext

    Re-exports useInRouterContext

    useLoaderData

    Re-exports useLoaderData

    useLocation

    Re-exports useLocation

    useMatch

    Re-exports useMatch

    useMatches

    Re-exports useMatches

    useNavigate

    Re-exports useNavigate

    useNavigation

    Re-exports useNavigation

    useNavigationType

    Re-exports useNavigationType

    useOutlet

    Re-exports useOutlet

    useOutletContext

    Re-exports useOutletContext

    useParams

    Re-exports useParams

    useResolvedPath

    Re-exports useResolvedPath

    useRevalidator

    Re-exports useRevalidator

    useRouteError

    Re-exports useRouteError

    useRouteLoaderData

    Re-exports useRouteLoaderData

    useRoutes

    Re-exports useRoutes

    Functions

    UNSAFE_mapRouteProperties

    • Parameters

      Returns Partial<RouteObject> & { hasErrorBoundary: boolean }

    UNSAFE_useRoutesImpl

    • UNSAFE_useRoutesImpl(routes: RouteObject[], locationArg?: string | Partial<Location>, dataRouterState?: RouterState): React.ReactElement | null

    • Parameters

      • routes: RouteObject[]
      • Optional locationArg: string | Partial<Location>
      • Optional dataRouterState: RouterState

      Returns React.ReactElement | null

    createMemoryRouter

    • createMemoryRouter(routes: RouteObject[], opts?: { basename?: string; future?: Partial<Omit<FutureConfig, "v7_prependBasename">>; hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>; initialEntries?: InitialEntry[]; initialIndex?: number }): RemixRouter

    • Parameters

      • routes: RouteObject[]
      • Optional opts: { basename?: string; future?: Partial<Omit<FutureConfig, "v7_prependBasename">>; hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>; initialEntries?: InitialEntry[]; initialIndex?: number }
        • Optional basename?: string
        • Optional future?: Partial<Omit<FutureConfig, "v7_prependBasename">>
        • Optional hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>
        • Optional initialEntries?: InitialEntry[]
        • Optional initialIndex?: number

      Returns RemixRouter

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.ScrollRestoration.html b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.ScrollRestoration.html new file mode 100644 index 000000000..8e619863d --- /dev/null +++ b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.ScrollRestoration.html @@ -0,0 +1 @@ +ScrollRestoration | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ScrollRestoration

    Index

    Variables

    Variables

    displayName

    displayName: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.html b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.html new file mode 100644 index 000000000..14a4932d2 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.html @@ -0,0 +1,229 @@ +ReactRouterDom | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ReactRouterDom

    Index

    References

    Namespaces

    Enumerations

    Classes

    Interfaces

    Type Aliases

    Variables

    Functions

    References

    createRoutesFromElements

    Renames and re-exports createRoutesFromChildren

    Type Aliases

    DataRouteObject

    DataRouteObject: RouteObject & { children?: DataRouteObject[]; id: string }

    Fetcher

    Fetcher<TData>: FetcherStates<TData>[keyof FetcherStates<TData>]

    Type Parameters

    • TData = any

    FetcherWithComponents

    FetcherWithComponents<TData>: Fetcher<TData> & { Form: ReturnType<typeof createFetcherForm>; submit: ReactRouterDom.FetcherSubmitFunction; load: any }

    Type Parameters

    • TData

    FormEncType

    FormEncType: "application/x-www-form-urlencoded" | "multipart/form-data" | "application/json" | "text/plain"

    FormMethod

    FormMethod: LowerCaseFormMethod
    +

    Active navigation/fetcher form methods are exposed in lowercase on the +RouterState

    +

    Hash

    Hash: string

    JsonFunction

    JsonFunction: (<Data>(data: Data, init?: number | ResponseInit) => Response)

    Type declaration

      • <Data>(data: Data, init?: number | ResponseInit): Response

      • Type Parameters

        • Data

        Parameters

        • data: Data
        • Optional init: number | ResponseInit

        Returns Response

    Navigation

    Navigation: NavigationStates[keyof NavigationStates]

    ParamKeyValuePair

    ParamKeyValuePair: [string, string]

    ParamParseKey

    ParamParseKey<Segment>: [PathParam<Segment>] extends [never] ? string : PathParam<Segment>

    Type Parameters

    • Segment extends string

    Params

    Params<Key>: { readonly [ key in Key]: string | undefined }
    +

    The parameters that were parsed from the URL path.

    +

    Type Parameters

    • Key extends string = string

    Pathname

    Pathname: string

    RedirectFunction

    RedirectFunction: ((url: string, init?: number | ResponseInit) => Response)

    Type declaration

      • (url: string, init?: number | ResponseInit): Response

      • Parameters

        • url: string
        • Optional init: number | ResponseInit

        Returns Response

    RelativeRoutingType

    RelativeRoutingType: "route" | "path"

    RouteObject

    RouteObject: IndexRouteObject | NonIndexRouteObject

    RouteProps

    RouteProps: PathRouteProps | LayoutRouteProps | IndexRouteProps

    Search

    Search: string

    SetURLSearchParams

    SetURLSearchParams: ((nextInit?: URLSearchParamsInit | ((prev: URLSearchParams) => URLSearchParamsInit), navigateOpts?: NavigateOptions) => void)

    Type declaration

    To

    To: string | Partial<Path>
    +

    Describes a location that is the destination of some navigation, either via +history.push or history.replace. May be either a URL or the pieces of a +URL path.

    +

    URLSearchParamsInit

    URLSearchParamsInit: string | ParamKeyValuePair[] | Record<string, string | string[]> | URLSearchParams

    V7_FormMethod

    V7_FormMethod: UpperCaseFormMethod
    +

    In v7, active navigation/fetcher form methods are exposed in uppercase on the +RouterState. This is to align with the normalization done via fetch().

    +

    unstable_Blocker

    unstable_Blocker: BlockerUnblocked | BlockerBlocked | BlockerProceeding

    unstable_BlockerFunction

    unstable_BlockerFunction: ((args: { currentLocation: Location; historyAction: NavigationType; nextLocation: Location }) => boolean)

    Type declaration

    Variables

    Const Form

    Form: React.ForwardRefExoticComponent<ReactRouterDom.FormProps & React.RefAttributes<HTMLFormElement>>
    +

    A @remix-run/router-aware <form>. It behaves like a normal form except +that the interaction with the server is with fetch instead of new document +requests, allowing components to add nicer UX to the page as the form is +submitted and returns with data.

    +

    Const Link

    Link: React.ForwardRefExoticComponent<ReactRouterDom.LinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    The public API for rendering a history-aware .

    +

    Const NavLink

    NavLink: React.ForwardRefExoticComponent<ReactRouterDom.NavLinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    A wrapper that knows if it's "active" or not.

    +

    Const UNSAFE_DataRouterContext

    UNSAFE_DataRouterContext: React.Context<DataRouterContextObject | null>
    internal

    Const UNSAFE_DataRouterStateContext

    UNSAFE_DataRouterStateContext: React.Context<RouterState | null>
    internal

    Const UNSAFE_LocationContext

    UNSAFE_LocationContext: React.Context<LocationContextObject>
    internal

    Const UNSAFE_NavigationContext

    UNSAFE_NavigationContext: React.Context<NavigationContextObject>
    internal

    Const UNSAFE_RouteContext

    UNSAFE_RouteContext: React.Context<RouteContextObject>
    internal

    Functions

    Await

    • Await(__namedParameters: AwaitProps): React.JSX.Element
    • +

      Component to use for rendering lazily loaded data from returning defer() +in a loader function

      +

      Parameters

      Returns React.JSX.Element

    BrowserRouter

    • +

      A <Router> for use in web browsers. Provides the cleanest URLs.

      +

      Parameters

      Returns React.JSX.Element

    HashRouter

    • +

      A <Router> for use in web browsers. Stores the location in the hash +portion of the URL so it is not sent to the server.

      +

      Parameters

      Returns React.JSX.Element

    MemoryRouter

    Navigate

    • +

      Changes the current location.

      +

      Note: This API is mostly useful in React.Component subclasses that are not +able to use hooks. In functional components, we recommend you use the +useNavigate hook instead.

      +
      see

      https://reactrouter.com/components/navigate

      +

      Parameters

      Returns null

    Outlet

    • +

      Renders the child route's element, if there is one.

      +
      see

      https://reactrouter.com/components/outlet

      +

      Parameters

      Returns React.ReactElement | null

    Route

    • Route(_props: RouteProps): React.ReactElement | null
    • +

      Declares an element that should be rendered at a certain URL path.

      +
      see

      https://reactrouter.com/components/route

      +

      Parameters

      Returns React.ReactElement | null

    Router

    • Router(__namedParameters: RouterProps): React.ReactElement | null
    • +

      Provides location context for the rest of the app.

      +

      Note: You usually won't render a directly. Instead, you'll render a +router that is more specific to your environment such as a +in web browsers or a for server rendering.

      +
      see

      https://reactrouter.com/router-components/router

      +

      Parameters

      Returns React.ReactElement | null

    RouterProvider

    • +

      Given a Remix Router instance, render the appropriate UI

      +

      Parameters

      Returns React.ReactElement

    Routes

    • Routes(__namedParameters: RoutesProps): React.ReactElement | null
    • +

      A container for a nested tree of elements that renders the branch +that best matches the current location.

      +
      see

      https://reactrouter.com/components/routes

      +

      Parameters

      Returns React.ReactElement | null

    ScrollRestoration

    • +

      This component will emulate the browser's scroll restoration on location +changes.

      +

      Parameters

      Returns null

    UNSAFE_useRouteId

    • UNSAFE_useRouteId(): string
    • +

      Returns the ID for the nearest contextual route

      +

      Returns string

    UNSAFE_useScrollRestoration

    • +

      When rendered inside a RouterProvider, will restore scroll positions on navigations

      +

      Parameters

      Returns void

    createBrowserRouter

    • createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    createHashRouter

    • createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    createMemoryRouter

    • createMemoryRouter(routes: RouteObject[], opts?: { basename?: string; future?: Partial<Omit<FutureConfig, "v7_prependBasename">>; hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>; initialEntries?: InitialEntry[]; initialIndex?: number }): RemixRouter

    • Parameters

      • routes: RouteObject[]
      • Optional opts: { basename?: string; future?: Partial<Omit<FutureConfig, "v7_prependBasename">>; hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>; initialEntries?: InitialEntry[]; initialIndex?: number }
        • Optional basename?: string
        • Optional future?: Partial<Omit<FutureConfig, "v7_prependBasename">>
        • Optional hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>
        • Optional initialEntries?: InitialEntry[]
        • Optional initialIndex?: number

      Returns RemixRouter

    createPath

    • createPath(__namedParameters: Partial<Path>): string
    • +

      Creates a string URL path from the given pathname, search, and hash components.

      +

      Parameters

      • __namedParameters: Partial<Path>

      Returns string

    createRoutesFromChildren

    • createRoutesFromChildren(children: ReactNode, parentPath?: number[]): RouteObject[]
    • +

      Creates a route config from a React "children" object, which is usually +either a <Route> element or an array of them. Used internally by +<Routes> to create a route config from its children.

      +
      see

      https://reactrouter.com/utils/create-routes-from-children

      +

      Parameters

      • children: ReactNode
      • Optional parentPath: number[]

      Returns RouteObject[]

    createSearchParams

    • +

      Creates a URLSearchParams object using the given initializer.

      +

      This is identical to new URLSearchParams(init) except it also +supports arrays as values in the object form of the initializer +instead of just strings. This is convenient when you need multiple +values for a given key, but don't want to use an array initializer.

      +

      For example, instead of:

      +

      let searchParams = new URLSearchParams([ + ['sort', 'name'], + ['sort', 'price'] + ]);

      +

      you can do:

      +

      let searchParams = createSearchParams({ + sort: ['name', 'price'] + });

      +

      Parameters

      Returns URLSearchParams

    defer

    • defer(data: Record<string, unknown>, init?: number | ResponseInit): DeferredData

    • Parameters

      • data: Record<string, unknown>
      • Optional init: number | ResponseInit

      Returns DeferredData

    generatePath

    • generatePath<Path>(originalPath: Path, params?: { [ key in string]: string }): string
    • +

      Returns a path with params interpolated.

      +
      see

      https://reactrouter.com/utils/generate-path

      +

      Type Parameters

      • Path extends string

      Parameters

      • originalPath: Path
      • Optional params: { [ key in string]: string }

      Returns string

    isRouteErrorResponse

    • isRouteErrorResponse(error: any): error is ErrorResponse
    • +

      Check if the given error is an ErrorResponse generated from a 4xx/5xx +Response thrown from an action/loader

      +

      Parameters

      • error: any

      Returns error is ErrorResponse

    json

    • json<Data>(data: Data, init?: number | ResponseInit): Response
    • +

      This is a shortcut for creating application/json responses. Converts data +to JSON and sets the Content-Type header.

      +

      Type Parameters

      • Data

      Parameters

      • data: Data
      • Optional init: number | ResponseInit

      Returns Response

    matchPath

    • matchPath<ParamKey, Path>(pattern: Path | PathPattern<Path>, pathname: string): PathMatch<ParamKey> | null
    • +

      Performs pattern matching on a URL pathname and returns information about +the match.

      +
      see

      https://reactrouter.com/utils/match-path

      +

      Type Parameters

      • ParamKey extends string

      • Path extends string

      Parameters

      Returns PathMatch<ParamKey> | null

    matchRoutes

    • matchRoutes<RouteObjectType>(routes: RouteObjectType[], locationArg: string | Partial<Location>, basename?: string): AgnosticRouteMatch<string, RouteObjectType>[] | null
    • +

      Matches the given routes to a location and returns the match data.

      +
      see

      https://reactrouter.com/utils/match-routes

      +

      Type Parameters

      • RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject

      Parameters

      • routes: RouteObjectType[]
      • locationArg: string | Partial<Location>
      • Optional basename: string

      Returns AgnosticRouteMatch<string, RouteObjectType>[] | null

    parsePath

    • parsePath(path: string): Partial<Path>
    • +

      Parses a string URL path into its separate pathname, search, and hash components.

      +

      Parameters

      • path: string

      Returns Partial<Path>

    redirect

    • redirect(url: string, init?: number | ResponseInit): Response
    • +

      A redirect response. Sets the status code and the Location header. +Defaults to "302 Found".

      +

      Parameters

      • url: string
      • Optional init: number | ResponseInit

      Returns Response

    redirectDocument

    • redirectDocument(url: string, init?: number | ResponseInit): Response
    • +

      A redirect response that will force a document reload to the new location. +Sets the status code and the Location header. +Defaults to "302 Found".

      +

      Parameters

      • url: string
      • Optional init: number | ResponseInit

      Returns Response

    renderMatches

    • +

      Renders the result of matchRoutes() into a React element.

      +

      Parameters

      Returns React.ReactElement | null

    resolvePath

    • resolvePath(to: To, fromPathname?: string): Path
    • +

      Returns a resolved path object relative to the given pathname.

      +
      see

      https://reactrouter.com/utils/resolve-path

      +

      Parameters

      • to: To
      • Optional fromPathname: string

      Returns Path

    unstable_HistoryRouter

    • +

      A <Router> that accepts a pre-instantiated history object. It's important +to note that using your own history object is highly discouraged and may add +two versions of the history library to your bundles unless you use the same +version of the history library that React Router uses internally.

      +

      Parameters

      Returns React.JSX.Element

    unstable_useBlocker

    • +

      Allow the application to block navigations within the SPA and present the +user a confirmation dialog to confirm the navigation. Mostly used to avoid +using half-filled form data. This does not handle hard-reloads or +cross-origin navigations.

      +

      Parameters

      Returns unstable_Blocker

    unstable_usePrompt

    • unstable_usePrompt(__namedParameters: { message: string; when: boolean }): void
    • +

      Wrapper around useBlocker to show a window.confirm prompt to users instead +of building a custom UI with useBlocker.

      +

      Warning: This has a lot of rough edges and behaves very differently (and +very incorrectly in some cases) across browsers if user click addition +back/forward navigations while the confirm is open. Use at your own risk.

      +

      Parameters

      • __namedParameters: { message: string; when: boolean }
        • message: string
        • when: boolean

      Returns void

    useActionData

    • useActionData(): unknown
    • +

      Returns the action data for the nearest ancestor Route action

      +

      Returns unknown

    useAsyncError

    • useAsyncError(): unknown
    • +

      Returns the error from the nearest ancestor value

      +

      Returns unknown

    useAsyncValue

    • useAsyncValue(): unknown
    • +

      Returns the happy-path data from the nearest ancestor value

      +

      Returns unknown

    useBeforeUnload

    • useBeforeUnload(callback: ((event: BeforeUnloadEvent) => any), options?: { capture?: boolean }): void
    • +

      Setup a callback to be fired on the window's beforeunload event. This is +useful for saving some data to window.localStorage just before the page +refreshes.

      +

      Note: The callback argument should be a function created with +React.useCallback().

      +

      Parameters

      • callback: ((event: BeforeUnloadEvent) => any)
          • (event: BeforeUnloadEvent): any

          • Parameters

            • event: BeforeUnloadEvent

            Returns any

      • Optional options: { capture?: boolean }
        • Optional capture?: boolean

      Returns void

    useFetcher

    • +

      Interacts with route loaders and actions without causing a navigation. Great +for any interaction that stays on the same page.

      +

      Type Parameters

      • TData = any

      Returns ReactRouterDom.FetcherWithComponents<TData>

    useFetchers

    • +

      Provides all fetchers currently on the page. Useful for layouts and parent +routes that need to provide pending/optimistic UI regarding the fetch.

      +

      Returns Fetcher[]

    useFormAction

    • Parameters

      Returns string

    useHref

    • +

      Returns the full href for the given "to" value. This is useful for building +custom links that are also accessible and preserve right-click behavior.

      +
      see

      https://reactrouter.com/hooks/use-href

      +

      Parameters

      Returns string

    useInRouterContext

    • useInRouterContext(): boolean

    useLinkClickHandler

    • useLinkClickHandler<E>(to: To, __namedParameters?: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }): ((event: React.MouseEvent<E, MouseEvent>) => void)
    • +

      Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

      +

      Type Parameters

      • E extends Element<E> = HTMLAnchorElement

      Parameters

      • to: To
      • Optional __namedParameters: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }
        • Optional preventScrollReset?: boolean
        • Optional relative?: RelativeRoutingType
        • Optional replace?: boolean
        • Optional state?: any
        • Optional target?: HTMLAttributeAnchorTarget

      Returns ((event: React.MouseEvent<E, MouseEvent>) => void)

        • (event: React.MouseEvent<E, MouseEvent>): void
        • +

          Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

          +

          Parameters

          • event: React.MouseEvent<E, MouseEvent>

          Returns void

    useLoaderData

    • useLoaderData(): unknown
    • +

      Returns the loader data for the nearest ancestor Route loader

      +

      Returns unknown

    useLocation

    • +

      Returns the current location object, which represents the current URL in web +browsers.

      +

      Note: If you're using this it may mean you're doing some of your own +"routing" in your app, and we'd like to know what your use case is. We may +be able to provide something higher-level to better suit your needs.

      +
      see

      https://reactrouter.com/hooks/use-location

      +

      Returns Location

    useMatch

    • +

      Returns a PathMatch object if the given pattern matches the current URL. +This is useful for components that need to know "active" state, e.g. +.

      +
      see

      https://reactrouter.com/hooks/use-match

      +

      Type Parameters

      • ParamKey extends string

      • Path extends string

      Parameters

      Returns PathMatch<ParamKey> | null

    useMatches

    • useMatches(): { data: unknown; handle: unknown; id: string; params: Params<string>; pathname: string }[]
    • +

      Returns the active route matches, useful for accessing loaderData for +parent/child routes or the route "handle" property

      +

      Returns { data: unknown; handle: unknown; id: string; params: Params<string>; pathname: string }[]

    useNavigate

    • +

      Returns an imperative method for changing the location. Used by s, but +may also be used by other elements to change the location.

      +
      see

      https://reactrouter.com/hooks/use-navigate

      +

      Returns NavigateFunction

    useNavigation

    • useNavigation(): Navigation
    • +

      Returns the current navigation, defaulting to an "idle" navigation when +no navigation is in progress

      +

      Returns Navigation

    useNavigationType

    • +

      Returns the current navigation action which describes how the router came to +the current location, either by a pop, push, or replace on the history stack.

      +
      see

      https://reactrouter.com/hooks/use-navigation-type

      +

      Returns NavigationType

    useOutlet

    • useOutlet(context?: unknown): React.ReactElement | null
    • +

      Returns the element for the child route at this level of the route +hierarchy. Used internally by to render child routes.

      +
      see

      https://reactrouter.com/hooks/use-outlet

      +

      Parameters

      • Optional context: unknown

      Returns React.ReactElement | null

    useOutletContext

    • useOutletContext<Context>(): Context
    • +

      Returns the context (if provided) for the child route at this level of the route +hierarchy.

      +
      see

      https://reactrouter.com/hooks/use-outlet-context

      +

      Type Parameters

      • Context = unknown

      Returns Context

    useParams

    • useParams<ParamsOrKey>(): Readonly<[ParamsOrKey] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>
    • +

      Returns an object of key/value pairs of the dynamic params from the current +URL that were matched by the route path.

      +
      see

      https://reactrouter.com/hooks/use-params

      +

      Type Parameters

      • ParamsOrKey extends string | Record<string, string> = string

      Returns Readonly<[ParamsOrKey] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>

    useResolvedPath

    useRevalidator

    • useRevalidator(): { state: RevalidationState; revalidate: any }
    • +

      Returns a revalidate function for manually triggering revalidation, as well +as the current state of any manual revalidations

      +

      Returns { state: RevalidationState; revalidate: any }

      • state: RevalidationState
      • revalidate:function
        • revalidate(): void

        • Returns void

    useRouteError

    • useRouteError(): unknown
    • +

      Returns the nearest ancestor Route error, which could be a loader/action +error or a render error. This is intended to be called from your +ErrorBoundary/errorElement to display a proper error message.

      +

      Returns unknown

    useRouteLoaderData

    • useRouteLoaderData(routeId: string): unknown
    • +

      Returns the loaderData for the given routeId

      +

      Parameters

      • routeId: string

      Returns unknown

    useRoutes

    • useRoutes(routes: RouteObject[], locationArg?: string | Partial<Location>): React.ReactElement | null
    • +

      Returns the element of the route that matched the current location, prepared +with the correct context to render the remainder of the route tree. Route +elements in the tree must render an to render their child route's +element.

      +
      see

      https://reactrouter.com/hooks/use-routes

      +

      Parameters

      Returns React.ReactElement | null

    useSearchParams

    • +

      A convenient wrapper for reading and writing search parameters via the +URLSearchParams interface.

      +

      Parameters

      Returns [URLSearchParams, ReactRouterDom.SetURLSearchParams]

    useSubmit

    • +

      Returns a function that may be used to programmatically submit a form (or +some arbitrary data) to the server.

      +

      Returns ReactRouterDom.SubmitFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.unstable_HistoryRouter.html b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.unstable_HistoryRouter.html new file mode 100644 index 000000000..98aaff7a1 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/browser.ReactRouterDom.unstable_HistoryRouter.html @@ -0,0 +1 @@ +unstable_HistoryRouter | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace unstable_HistoryRouter

    Index

    Variables

    Variables

    displayName

    displayName: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.ScrollRestoration.html b/packages/xarc-react-router/docs/modules/browser.ScrollRestoration.html new file mode 100644 index 000000000..d30558312 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/browser.ScrollRestoration.html @@ -0,0 +1 @@ +ScrollRestoration | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ScrollRestoration

    Index

    Variables

    Variables

    displayName

    displayName: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser.html b/packages/xarc-react-router/docs/modules/browser.html index d3a4bbc03..e8ac2c2de 100644 --- a/packages/xarc-react-router/docs/modules/browser.html +++ b/packages/xarc-react-router/docs/modules/browser.html @@ -1,196 +1,44 @@ - - - - - - browser | @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Module browser

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    References

    - -
    -
    -

    Functions

    - -
    -
    -
    -
    -
    -

    References

    -
    - -

    ReactRouter

    - Renames and exports ReactRouterDom -
    -
    - -

    ReactRouterFeatureOptions

    - Re-exports ReactRouterFeatureOptions -
    -
    - -

    _id

    - Re-exports _id -
    -
    - -

    _subId

    - Re-exports _subId -
    -
    - -

    reactRouterFeature

    - Re-exports reactRouterFeature -
    -
    -
    -

    Functions

    -
    - -

    ReactRouterDom

    -
    ReactRouterDom:
    - -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +browser | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module browser

    Index

    References

    Namespaces

    Interfaces

    Type Aliases

    Variables

    Functions

    References

    AbortedDeferredError

    Re-exports AbortedDeferredError

    ActionFunction

    Re-exports ActionFunction

    ActionFunctionArgs

    Re-exports ActionFunctionArgs

    Await

    Re-exports Await

    AwaitProps

    Re-exports AwaitProps

    DataRouteMatch

    Re-exports DataRouteMatch

    DataRouteObject

    Re-exports DataRouteObject

    Fetcher

    Re-exports Fetcher

    FormEncType

    Re-exports FormEncType

    FormMethod

    Re-exports FormMethod

    GetScrollRestorationKeyFunction

    Re-exports GetScrollRestorationKeyFunction

    Hash

    Re-exports Hash

    IndexRouteObject

    Re-exports IndexRouteObject

    IndexRouteProps

    Re-exports IndexRouteProps

    JsonFunction

    Re-exports JsonFunction

    LayoutRouteProps

    Re-exports LayoutRouteProps

    LazyRouteFunction

    Re-exports LazyRouteFunction

    LoaderFunction

    Re-exports LoaderFunction

    LoaderFunctionArgs

    Re-exports LoaderFunctionArgs

    Location

    Re-exports Location

    MemoryRouter

    Re-exports MemoryRouter

    MemoryRouterProps

    Re-exports MemoryRouterProps

    Navigate

    Re-exports Navigate

    NavigateFunction

    Re-exports NavigateFunction

    NavigateOptions

    Re-exports NavigateOptions

    NavigateProps

    Re-exports NavigateProps

    Navigation

    Re-exports Navigation

    NavigationType

    Re-exports NavigationType

    Navigator

    Re-exports Navigator

    NonIndexRouteObject

    Re-exports NonIndexRouteObject

    Outlet

    Re-exports Outlet

    OutletProps

    Re-exports OutletProps

    ParamKeyValuePair

    Re-exports ParamKeyValuePair

    ParamParseKey

    Re-exports ParamParseKey

    Params

    Re-exports Params

    Path

    Re-exports Path

    PathMatch

    Re-exports PathMatch

    PathPattern

    Re-exports PathPattern

    PathRouteProps

    Re-exports PathRouteProps

    Pathname

    Re-exports Pathname

    ReactRouterFeatureOptions

    Re-exports ReactRouterFeatureOptions

    RedirectFunction

    Re-exports RedirectFunction

    RelativeRoutingType

    Re-exports RelativeRoutingType

    Route

    Re-exports Route

    RouteMatch

    Re-exports RouteMatch

    RouteObject

    Re-exports RouteObject

    RouteProps

    Re-exports RouteProps

    Router

    Re-exports Router

    RouterProps

    Re-exports RouterProps

    RouterProvider

    Re-exports RouterProvider

    RouterProviderProps

    Re-exports RouterProviderProps

    Routes

    Re-exports Routes

    RoutesProps

    Re-exports RoutesProps

    Search

    Re-exports Search

    ShouldRevalidateFunction

    Re-exports ShouldRevalidateFunction

    SubmitOptions

    Re-exports SubmitOptions

    To

    Re-exports To

    UNSAFE_DataRouterContext

    Re-exports UNSAFE_DataRouterContext

    UNSAFE_DataRouterStateContext

    Re-exports UNSAFE_DataRouterStateContext

    UNSAFE_LocationContext

    Re-exports UNSAFE_LocationContext

    UNSAFE_NavigationContext

    Re-exports UNSAFE_NavigationContext

    UNSAFE_RouteContext

    Re-exports UNSAFE_RouteContext

    UNSAFE_useRouteId

    Re-exports UNSAFE_useRouteId

    UNSAFE_useScrollRestoration

    Re-exports UNSAFE_useScrollRestoration

    URLSearchParamsInit

    Re-exports URLSearchParamsInit

    V7_FormMethod

    Re-exports V7_FormMethod

    _id

    Re-exports _id

    _subId

    Re-exports _subId

    createMemoryRouter

    Re-exports createMemoryRouter

    createPath

    Re-exports createPath

    createRoutesFromChildren

    Re-exports createRoutesFromChildren

    createRoutesFromElements

    Renames and re-exports createRoutesFromChildren

    createSearchParams

    Re-exports createSearchParams

    defer

    Re-exports defer

    generatePath

    Re-exports generatePath

    isRouteErrorResponse

    Re-exports isRouteErrorResponse

    json

    Re-exports json

    matchPath

    Re-exports matchPath

    matchRoutes

    Re-exports matchRoutes

    parsePath

    Re-exports parsePath

    reactRouterFeature

    Re-exports reactRouterFeature

    redirect

    Re-exports redirect

    redirectDocument

    Re-exports redirectDocument

    renderMatches

    Re-exports renderMatches

    resolvePath

    Re-exports resolvePath

    unstable_Blocker

    Re-exports unstable_Blocker

    unstable_BlockerFunction

    Re-exports unstable_BlockerFunction

    unstable_HistoryRouter

    Re-exports unstable_HistoryRouter

    unstable_useBlocker

    Re-exports unstable_useBlocker

    unstable_usePrompt

    Re-exports unstable_usePrompt

    useActionData

    Re-exports useActionData

    useAsyncError

    Re-exports useAsyncError

    useAsyncValue

    Re-exports useAsyncValue

    useHref

    Re-exports useHref

    useInRouterContext

    Re-exports useInRouterContext

    useLoaderData

    Re-exports useLoaderData

    useLocation

    Re-exports useLocation

    useMatch

    Re-exports useMatch

    useMatches

    Re-exports useMatches

    useNavigate

    Re-exports useNavigate

    useNavigation

    Re-exports useNavigation

    useNavigationType

    Re-exports useNavigationType

    useOutlet

    Re-exports useOutlet

    useOutletContext

    Re-exports useOutletContext

    useParams

    Re-exports useParams

    useResolvedPath

    Re-exports useResolvedPath

    useRevalidator

    Re-exports useRevalidator

    useRouteError

    Re-exports useRouteError

    useRouteLoaderData

    Re-exports useRouteLoaderData

    useRoutes

    Re-exports useRoutes

    Type Aliases

    FetcherWithComponents

    FetcherWithComponents<TData>: Fetcher<TData> & { Form: ReturnType<typeof createFetcherForm>; submit: ReactRouterDom.FetcherSubmitFunction; load: any }

    Type Parameters

    • TData

    SetURLSearchParams

    SetURLSearchParams: ((nextInit?: URLSearchParamsInit | ((prev: URLSearchParams) => URLSearchParamsInit), navigateOpts?: NavigateOptions) => void)

    Type declaration

    Variables

    Const Form

    Form: React.ForwardRefExoticComponent<ReactRouterDom.FormProps & React.RefAttributes<HTMLFormElement>>
    +

    A @remix-run/router-aware <form>. It behaves like a normal form except +that the interaction with the server is with fetch instead of new document +requests, allowing components to add nicer UX to the page as the form is +submitted and returns with data.

    +

    Const Link

    Link: React.ForwardRefExoticComponent<ReactRouterDom.LinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    The public API for rendering a history-aware .

    +

    Const NavLink

    NavLink: React.ForwardRefExoticComponent<ReactRouterDom.NavLinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    A wrapper that knows if it's "active" or not.

    +

    Functions

    BrowserRouter

    • +

      A <Router> for use in web browsers. Provides the cleanest URLs.

      +

      Parameters

      Returns React.JSX.Element

    HashRouter

    • +

      A <Router> for use in web browsers. Stores the location in the hash +portion of the URL so it is not sent to the server.

      +

      Parameters

      Returns React.JSX.Element

    ScrollRestoration

    • +

      This component will emulate the browser's scroll restoration on location +changes.

      +

      Parameters

      Returns null

    createBrowserRouter

    • createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    createHashRouter

    • createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    useBeforeUnload

    • useBeforeUnload(callback: ((event: BeforeUnloadEvent) => any), options?: { capture?: boolean }): void
    • +

      Setup a callback to be fired on the window's beforeunload event. This is +useful for saving some data to window.localStorage just before the page +refreshes.

      +

      Note: The callback argument should be a function created with +React.useCallback().

      +

      Parameters

      • callback: ((event: BeforeUnloadEvent) => any)
          • (event: BeforeUnloadEvent): any

          • Parameters

            • event: BeforeUnloadEvent

            Returns any

      • Optional options: { capture?: boolean }
        • Optional capture?: boolean

      Returns void

    useFetcher

    • +

      Interacts with route loaders and actions without causing a navigation. Great +for any interaction that stays on the same page.

      +

      Type Parameters

      • TData = any

      Returns ReactRouterDom.FetcherWithComponents<TData>

    useFetchers

    • +

      Provides all fetchers currently on the page. Useful for layouts and parent +routes that need to provide pending/optimistic UI regarding the fetch.

      +

      Returns Fetcher[]

    useFormAction

    • Parameters

      Returns string

    useLinkClickHandler

    • useLinkClickHandler<E>(to: To, __namedParameters?: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }): ((event: React.MouseEvent<E, MouseEvent>) => void)
    • +

      Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

      +

      Type Parameters

      • E extends Element<E> = HTMLAnchorElement

      Parameters

      • to: To
      • Optional __namedParameters: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }
        • Optional preventScrollReset?: boolean
        • Optional relative?: RelativeRoutingType
        • Optional replace?: boolean
        • Optional state?: any
        • Optional target?: HTMLAttributeAnchorTarget

      Returns ((event: React.MouseEvent<E, MouseEvent>) => void)

        • (event: React.MouseEvent<E, MouseEvent>): void
        • +

          Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

          +

          Parameters

          • event: React.MouseEvent<E, MouseEvent>

          Returns void

    useSearchParams

    • +

      A convenient wrapper for reading and writing search parameters via the +URLSearchParams interface.

      +

      Parameters

      Returns [URLSearchParams, ReactRouterDom.SetURLSearchParams]

    useSubmit

    • +

      Returns a function that may be used to programmatically submit a form (or +some arbitrary data) to the server.

      +

      Returns ReactRouterDom.SubmitFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/browser_react_router_browser.html b/packages/xarc-react-router/docs/modules/browser_react_router_browser.html index 787227b4d..ec514ef1a 100644 --- a/packages/xarc-react-router/docs/modules/browser_react_router_browser.html +++ b/packages/xarc-react-router/docs/modules/browser_react_router_browser.html @@ -1,170 +1,8 @@ - - - - - - browser/react-router-browser | @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Module browser/react-router-browser

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    Functions

    - -
    -
    -
    -
    -
    -

    Functions

    -
    - -

    reactRouterFeature

    - -
      -
    • - -
      -
      -

      Implement the component wrapping support for using react router on a subapp

      -
      -
      -

      Parameters

      - -

      Returns SubAppFeatureFactory

      -
        -
      • feature factory which can add router feature on a subapp
        • -
      -
      • -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +browser/react-router-browser | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module browser/react-router-browser

    Index

    Functions

    Functions

    reactRouterFeature

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/common.ScrollRestoration.html b/packages/xarc-react-router/docs/modules/common.ScrollRestoration.html new file mode 100644 index 000000000..35c6010a7 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/common.ScrollRestoration.html @@ -0,0 +1 @@ +ScrollRestoration | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ScrollRestoration

    Index

    Variables

    Variables

    displayName

    displayName: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/common.html b/packages/xarc-react-router/docs/modules/common.html index 2c846f790..f4598454a 100644 --- a/packages/xarc-react-router/docs/modules/common.html +++ b/packages/xarc-react-router/docs/modules/common.html @@ -1,239 +1,58 @@ - - - - - - common | @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Module common

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    References

    - -
    -
    -

    Type aliases

    - -
    -
    -

    Variables

    - -
    -
    -
    -
    -
    -

    References

    -
    - -

    ReactRouter

    - Renames and exports ReactRouterDom -
    -
    - -

    ReactRouterDom

    - Re-exports ReactRouterDom -
    -
    -
    -

    Type aliases

    -
    - -

    ReactRouterFeatureOptions

    -
    ReactRouterFeatureOptions: { React: Partial<{ createElement: unknown }>; history?: boolean | unknown }
    - -
    -

    Type declaration

    -
      -
    • -
      React: Partial<{ createElement: unknown }>
      -
      -
      -

      The React module.

      -
      -

      This is needed for the react router feature to wrap subapp's component inside - the Router component.

      -
      -
      • -
    • -
      Optional history?: boolean | unknown
      -
      -
      -

      A custom browser history object and control which Router to use.

      -
      -
        -
      • If it's true, or not specified, then HistoryRouter is used with history from createBrowserHistory - from https://www.npmjs.com/package/history and the same history object will be shared - among all subapps
        • -
      • If it's a valid object, then it's assumed to be a history object and used with HistoryRouter
        • -
      • Finally fallback to use BrowserRouter, which internally uses its own history object that's not - shared with other subapps.
        • -
      -
      -
      • -
    -
    -
    -
    -
    -

    Variables

    -
    - -

    Const _id

    -
    _id: "router-provider" = "router-provider"
    - -
    -
    - -

    Const _subId

    -
    _subId: "react-router" = "react-router"
    - -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +common | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module common

    Index

    References

    Namespaces

    Interfaces

    Type Aliases

    Variables

    Functions

    References

    AbortedDeferredError

    Re-exports AbortedDeferredError

    ActionFunction

    Re-exports ActionFunction

    ActionFunctionArgs

    Re-exports ActionFunctionArgs

    Await

    Re-exports Await

    AwaitProps

    Re-exports AwaitProps

    DataRouteMatch

    Re-exports DataRouteMatch

    DataRouteObject

    Re-exports DataRouteObject

    Fetcher

    Re-exports Fetcher

    FormEncType

    Re-exports FormEncType

    FormMethod

    Re-exports FormMethod

    GetScrollRestorationKeyFunction

    Re-exports GetScrollRestorationKeyFunction

    Hash

    Re-exports Hash

    IndexRouteObject

    Re-exports IndexRouteObject

    IndexRouteProps

    Re-exports IndexRouteProps

    JsonFunction

    Re-exports JsonFunction

    LayoutRouteProps

    Re-exports LayoutRouteProps

    LazyRouteFunction

    Re-exports LazyRouteFunction

    LoaderFunction

    Re-exports LoaderFunction

    LoaderFunctionArgs

    Re-exports LoaderFunctionArgs

    Location

    Re-exports Location

    MemoryRouter

    Re-exports MemoryRouter

    MemoryRouterProps

    Re-exports MemoryRouterProps

    Navigate

    Re-exports Navigate

    NavigateFunction

    Re-exports NavigateFunction

    NavigateOptions

    Re-exports NavigateOptions

    NavigateProps

    Re-exports NavigateProps

    Navigation

    Re-exports Navigation

    NavigationType

    Re-exports NavigationType

    Navigator

    Re-exports Navigator

    NonIndexRouteObject

    Re-exports NonIndexRouteObject

    Outlet

    Re-exports Outlet

    OutletProps

    Re-exports OutletProps

    ParamKeyValuePair

    Re-exports ParamKeyValuePair

    ParamParseKey

    Re-exports ParamParseKey

    Params

    Re-exports Params

    Path

    Re-exports Path

    PathMatch

    Re-exports PathMatch

    PathPattern

    Re-exports PathPattern

    PathRouteProps

    Re-exports PathRouteProps

    Pathname

    Re-exports Pathname

    ReactRouter

    Re-exports ReactRouter

    ReactRouterDom

    Re-exports ReactRouterDom

    RedirectFunction

    Re-exports RedirectFunction

    RelativeRoutingType

    Re-exports RelativeRoutingType

    Route

    Re-exports Route

    RouteMatch

    Re-exports RouteMatch

    RouteObject

    Re-exports RouteObject

    RouteProps

    Re-exports RouteProps

    Router

    Re-exports Router

    RouterProps

    Re-exports RouterProps

    RouterProvider

    Re-exports RouterProvider

    RouterProviderProps

    Re-exports RouterProviderProps

    Routes

    Re-exports Routes

    RoutesProps

    Re-exports RoutesProps

    Search

    Re-exports Search

    ShouldRevalidateFunction

    Re-exports ShouldRevalidateFunction

    SubmitOptions

    Re-exports SubmitOptions

    To

    Re-exports To

    UNSAFE_DataRouterContext

    Re-exports UNSAFE_DataRouterContext

    UNSAFE_DataRouterStateContext

    Re-exports UNSAFE_DataRouterStateContext

    UNSAFE_LocationContext

    Re-exports UNSAFE_LocationContext

    UNSAFE_NavigationContext

    Re-exports UNSAFE_NavigationContext

    UNSAFE_RouteContext

    Re-exports UNSAFE_RouteContext

    UNSAFE_useRouteId

    Re-exports UNSAFE_useRouteId

    UNSAFE_useScrollRestoration

    Re-exports UNSAFE_useScrollRestoration

    URLSearchParamsInit

    Re-exports URLSearchParamsInit

    V7_FormMethod

    Re-exports V7_FormMethod

    createMemoryRouter

    Re-exports createMemoryRouter

    createPath

    Re-exports createPath

    createRoutesFromChildren

    Re-exports createRoutesFromChildren

    createRoutesFromElements

    Renames and re-exports createRoutesFromChildren

    createSearchParams

    Re-exports createSearchParams

    defer

    Re-exports defer

    generatePath

    Re-exports generatePath

    isRouteErrorResponse

    Re-exports isRouteErrorResponse

    json

    Re-exports json

    matchPath

    Re-exports matchPath

    matchRoutes

    Re-exports matchRoutes

    parsePath

    Re-exports parsePath

    redirect

    Re-exports redirect

    redirectDocument

    Re-exports redirectDocument

    renderMatches

    Re-exports renderMatches

    resolvePath

    Re-exports resolvePath

    unstable_Blocker

    Re-exports unstable_Blocker

    unstable_BlockerFunction

    Re-exports unstable_BlockerFunction

    unstable_HistoryRouter

    Re-exports unstable_HistoryRouter

    unstable_useBlocker

    Re-exports unstable_useBlocker

    unstable_usePrompt

    Re-exports unstable_usePrompt

    useActionData

    Re-exports useActionData

    useAsyncError

    Re-exports useAsyncError

    useAsyncValue

    Re-exports useAsyncValue

    useHref

    Re-exports useHref

    useInRouterContext

    Re-exports useInRouterContext

    useLoaderData

    Re-exports useLoaderData

    useLocation

    Re-exports useLocation

    useMatch

    Re-exports useMatch

    useMatches

    Re-exports useMatches

    useNavigate

    Re-exports useNavigate

    useNavigation

    Re-exports useNavigation

    useNavigationType

    Re-exports useNavigationType

    useOutlet

    Re-exports useOutlet

    useOutletContext

    Re-exports useOutletContext

    useParams

    Re-exports useParams

    useResolvedPath

    Re-exports useResolvedPath

    useRevalidator

    Re-exports useRevalidator

    useRouteError

    Re-exports useRouteError

    useRouteLoaderData

    Re-exports useRouteLoaderData

    useRoutes

    Re-exports useRoutes

    Type Aliases

    FetcherWithComponents

    FetcherWithComponents<TData>: Fetcher<TData> & { Form: ReturnType<typeof createFetcherForm>; submit: ReactRouterDom.FetcherSubmitFunction; load: any }

    Type Parameters

    • TData

    ReactRouterFeatureOptions

    ReactRouterFeatureOptions: { React: Partial<{ createElement: unknown }>; history?: boolean | unknown }

    Type declaration

    • React: Partial<{ createElement: unknown }>
      +

      The React module.

      +

      This is needed for the react router feature to wrap subapp's component inside +the Router component.

      +
    • Optional history?: boolean | unknown
      +

      A custom browser history object and control which Router to use.

      +
        +
      • If it's true, or not specified, then Router is used with history from createBrowserHistory +from https://www.npmjs.com/package/history and the same history object will be shared +among all subapps
        • +
      • If it's a valid object, then it's assumed to be a history object and used with Router
        • +
      • Finally fallback to use BrowserRouter, which internally uses its own history object that's not +shared with other subapps.
        • +
      +

    SetURLSearchParams

    SetURLSearchParams: ((nextInit?: URLSearchParamsInit | ((prev: URLSearchParams) => URLSearchParamsInit), navigateOpts?: NavigateOptions) => void)

    Type declaration

    Variables

    Const Form

    Form: React.ForwardRefExoticComponent<ReactRouterDom.FormProps & React.RefAttributes<HTMLFormElement>>
    +

    A @remix-run/router-aware <form>. It behaves like a normal form except +that the interaction with the server is with fetch instead of new document +requests, allowing components to add nicer UX to the page as the form is +submitted and returns with data.

    +

    Const Link

    Link: React.ForwardRefExoticComponent<ReactRouterDom.LinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    The public API for rendering a history-aware .

    +

    Const NavLink

    NavLink: React.ForwardRefExoticComponent<ReactRouterDom.NavLinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    A wrapper that knows if it's "active" or not.

    +

    Const _id

    _id: "router-provider" = "router-provider"

    Const _subId

    _subId: "react-router" = "react-router"

    Functions

    BrowserRouter

    • +

      A <Router> for use in web browsers. Provides the cleanest URLs.

      +

      Parameters

      Returns React.JSX.Element

    HashRouter

    • +

      A <Router> for use in web browsers. Stores the location in the hash +portion of the URL so it is not sent to the server.

      +

      Parameters

      Returns React.JSX.Element

    ScrollRestoration

    • +

      This component will emulate the browser's scroll restoration on location +changes.

      +

      Parameters

      Returns null

    createBrowserRouter

    • createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    createHashRouter

    • createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    useBeforeUnload

    • useBeforeUnload(callback: ((event: BeforeUnloadEvent) => any), options?: { capture?: boolean }): void
    • +

      Setup a callback to be fired on the window's beforeunload event. This is +useful for saving some data to window.localStorage just before the page +refreshes.

      +

      Note: The callback argument should be a function created with +React.useCallback().

      +

      Parameters

      • callback: ((event: BeforeUnloadEvent) => any)
          • (event: BeforeUnloadEvent): any

          • Parameters

            • event: BeforeUnloadEvent

            Returns any

      • Optional options: { capture?: boolean }
        • Optional capture?: boolean

      Returns void

    useFetcher

    • +

      Interacts with route loaders and actions without causing a navigation. Great +for any interaction that stays on the same page.

      +

      Type Parameters

      • TData = any

      Returns ReactRouterDom.FetcherWithComponents<TData>

    useFetchers

    • +

      Provides all fetchers currently on the page. Useful for layouts and parent +routes that need to provide pending/optimistic UI regarding the fetch.

      +

      Returns Fetcher[]

    useFormAction

    • Parameters

      Returns string

    useLinkClickHandler

    • useLinkClickHandler<E>(to: To, __namedParameters?: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }): ((event: React.MouseEvent<E, MouseEvent>) => void)
    • +

      Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

      +

      Type Parameters

      • E extends Element<E> = HTMLAnchorElement

      Parameters

      • to: To
      • Optional __namedParameters: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }
        • Optional preventScrollReset?: boolean
        • Optional relative?: RelativeRoutingType
        • Optional replace?: boolean
        • Optional state?: any
        • Optional target?: HTMLAttributeAnchorTarget

      Returns ((event: React.MouseEvent<E, MouseEvent>) => void)

        • (event: React.MouseEvent<E, MouseEvent>): void
        • +

          Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

          +

          Parameters

          • event: React.MouseEvent<E, MouseEvent>

          Returns void

    useSearchParams

    • +

      A convenient wrapper for reading and writing search parameters via the +URLSearchParams interface.

      +

      Parameters

      Returns [URLSearchParams, ReactRouterDom.SetURLSearchParams]

    useSubmit

    • +

      Returns a function that may be used to programmatically submit a form (or +some arbitrary data) to the server.

      +

      Returns ReactRouterDom.SubmitFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/node.ScrollRestoration.html b/packages/xarc-react-router/docs/modules/node.ScrollRestoration.html new file mode 100644 index 000000000..8a625d9d9 --- /dev/null +++ b/packages/xarc-react-router/docs/modules/node.ScrollRestoration.html @@ -0,0 +1 @@ +ScrollRestoration | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace ScrollRestoration

    Index

    Variables

    Variables

    displayName

    displayName: string

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/node.html b/packages/xarc-react-router/docs/modules/node.html index 8f946d982..045150258 100644 --- a/packages/xarc-react-router/docs/modules/node.html +++ b/packages/xarc-react-router/docs/modules/node.html @@ -1,186 +1,44 @@ - - - - - - node | @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Module node

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    References

    - -
    -
    -
    -
    -
    -

    References

    -
    - -

    ReactRouter

    - Renames and exports ReactRouterDom -
    -
    - -

    ReactRouterDom

    - Re-exports ReactRouterDom -
    -
    - -

    ReactRouterFeatureOptions

    - Re-exports ReactRouterFeatureOptions -
    -
    - -

    _id

    - Re-exports _id -
    -
    - -

    _subId

    - Re-exports _subId -
    -
    - -

    reactRouterFeature

    - Re-exports reactRouterFeature -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +node | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module node

    Index

    References

    Namespaces

    Interfaces

    Type Aliases

    Variables

    Functions

    References

    AbortedDeferredError

    Re-exports AbortedDeferredError

    ActionFunction

    Re-exports ActionFunction

    ActionFunctionArgs

    Re-exports ActionFunctionArgs

    Await

    Re-exports Await

    AwaitProps

    Re-exports AwaitProps

    DataRouteMatch

    Re-exports DataRouteMatch

    DataRouteObject

    Re-exports DataRouteObject

    Fetcher

    Re-exports Fetcher

    FormEncType

    Re-exports FormEncType

    FormMethod

    Re-exports FormMethod

    GetScrollRestorationKeyFunction

    Re-exports GetScrollRestorationKeyFunction

    Hash

    Re-exports Hash

    IndexRouteObject

    Re-exports IndexRouteObject

    IndexRouteProps

    Re-exports IndexRouteProps

    JsonFunction

    Re-exports JsonFunction

    LayoutRouteProps

    Re-exports LayoutRouteProps

    LazyRouteFunction

    Re-exports LazyRouteFunction

    LoaderFunction

    Re-exports LoaderFunction

    LoaderFunctionArgs

    Re-exports LoaderFunctionArgs

    Location

    Re-exports Location

    MemoryRouter

    Re-exports MemoryRouter

    MemoryRouterProps

    Re-exports MemoryRouterProps

    Navigate

    Re-exports Navigate

    NavigateFunction

    Re-exports NavigateFunction

    NavigateOptions

    Re-exports NavigateOptions

    NavigateProps

    Re-exports NavigateProps

    Navigation

    Re-exports Navigation

    NavigationType

    Re-exports NavigationType

    Navigator

    Re-exports Navigator

    NonIndexRouteObject

    Re-exports NonIndexRouteObject

    Outlet

    Re-exports Outlet

    OutletProps

    Re-exports OutletProps

    ParamKeyValuePair

    Re-exports ParamKeyValuePair

    ParamParseKey

    Re-exports ParamParseKey

    Params

    Re-exports Params

    Path

    Re-exports Path

    PathMatch

    Re-exports PathMatch

    PathPattern

    Re-exports PathPattern

    PathRouteProps

    Re-exports PathRouteProps

    Pathname

    Re-exports Pathname

    ReactRouter

    Re-exports ReactRouter

    ReactRouterDom

    Re-exports ReactRouterDom

    ReactRouterFeatureOptions

    Re-exports ReactRouterFeatureOptions

    RedirectFunction

    Re-exports RedirectFunction

    RelativeRoutingType

    Re-exports RelativeRoutingType

    Route

    Re-exports Route

    RouteMatch

    Re-exports RouteMatch

    RouteObject

    Re-exports RouteObject

    RouteProps

    Re-exports RouteProps

    Router

    Re-exports Router

    RouterProps

    Re-exports RouterProps

    RouterProvider

    Re-exports RouterProvider

    RouterProviderProps

    Re-exports RouterProviderProps

    Routes

    Re-exports Routes

    RoutesProps

    Re-exports RoutesProps

    Search

    Re-exports Search

    ShouldRevalidateFunction

    Re-exports ShouldRevalidateFunction

    SubmitOptions

    Re-exports SubmitOptions

    To

    Re-exports To

    UNSAFE_DataRouterContext

    Re-exports UNSAFE_DataRouterContext

    UNSAFE_DataRouterStateContext

    Re-exports UNSAFE_DataRouterStateContext

    UNSAFE_LocationContext

    Re-exports UNSAFE_LocationContext

    UNSAFE_NavigationContext

    Re-exports UNSAFE_NavigationContext

    UNSAFE_RouteContext

    Re-exports UNSAFE_RouteContext

    UNSAFE_useRouteId

    Re-exports UNSAFE_useRouteId

    UNSAFE_useScrollRestoration

    Re-exports UNSAFE_useScrollRestoration

    URLSearchParamsInit

    Re-exports URLSearchParamsInit

    V7_FormMethod

    Re-exports V7_FormMethod

    _id

    Re-exports _id

    _subId

    Re-exports _subId

    createMemoryRouter

    Re-exports createMemoryRouter

    createPath

    Re-exports createPath

    createRoutesFromChildren

    Re-exports createRoutesFromChildren

    createRoutesFromElements

    Renames and re-exports createRoutesFromChildren

    createSearchParams

    Re-exports createSearchParams

    defer

    Re-exports defer

    generatePath

    Re-exports generatePath

    isRouteErrorResponse

    Re-exports isRouteErrorResponse

    json

    Re-exports json

    matchPath

    Re-exports matchPath

    matchRoutes

    Re-exports matchRoutes

    parsePath

    Re-exports parsePath

    reactRouterFeature

    Re-exports reactRouterFeature

    redirect

    Re-exports redirect

    redirectDocument

    Re-exports redirectDocument

    renderMatches

    Re-exports renderMatches

    resolvePath

    Re-exports resolvePath

    unstable_Blocker

    Re-exports unstable_Blocker

    unstable_BlockerFunction

    Re-exports unstable_BlockerFunction

    unstable_HistoryRouter

    Re-exports unstable_HistoryRouter

    unstable_useBlocker

    Re-exports unstable_useBlocker

    unstable_usePrompt

    Re-exports unstable_usePrompt

    useActionData

    Re-exports useActionData

    useAsyncError

    Re-exports useAsyncError

    useAsyncValue

    Re-exports useAsyncValue

    useHref

    Re-exports useHref

    useInRouterContext

    Re-exports useInRouterContext

    useLoaderData

    Re-exports useLoaderData

    useLocation

    Re-exports useLocation

    useMatch

    Re-exports useMatch

    useMatches

    Re-exports useMatches

    useNavigate

    Re-exports useNavigate

    useNavigation

    Re-exports useNavigation

    useNavigationType

    Re-exports useNavigationType

    useOutlet

    Re-exports useOutlet

    useOutletContext

    Re-exports useOutletContext

    useParams

    Re-exports useParams

    useResolvedPath

    Re-exports useResolvedPath

    useRevalidator

    Re-exports useRevalidator

    useRouteError

    Re-exports useRouteError

    useRouteLoaderData

    Re-exports useRouteLoaderData

    useRoutes

    Re-exports useRoutes

    Type Aliases

    FetcherWithComponents

    FetcherWithComponents<TData>: Fetcher<TData> & { Form: ReturnType<typeof createFetcherForm>; submit: ReactRouterDom.FetcherSubmitFunction; load: any }

    Type Parameters

    • TData

    SetURLSearchParams

    SetURLSearchParams: ((nextInit?: URLSearchParamsInit | ((prev: URLSearchParams) => URLSearchParamsInit), navigateOpts?: NavigateOptions) => void)

    Type declaration

    Variables

    Const Form

    Form: React.ForwardRefExoticComponent<ReactRouterDom.FormProps & React.RefAttributes<HTMLFormElement>>
    +

    A @remix-run/router-aware <form>. It behaves like a normal form except +that the interaction with the server is with fetch instead of new document +requests, allowing components to add nicer UX to the page as the form is +submitted and returns with data.

    +

    Const Link

    Link: React.ForwardRefExoticComponent<ReactRouterDom.LinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    The public API for rendering a history-aware .

    +

    Const NavLink

    NavLink: React.ForwardRefExoticComponent<ReactRouterDom.NavLinkProps & React.RefAttributes<HTMLAnchorElement>>
    +

    A wrapper that knows if it's "active" or not.

    +

    Functions

    BrowserRouter

    • +

      A <Router> for use in web browsers. Provides the cleanest URLs.

      +

      Parameters

      Returns React.JSX.Element

    HashRouter

    • +

      A <Router> for use in web browsers. Stores the location in the hash +portion of the URL so it is not sent to the server.

      +

      Parameters

      Returns React.JSX.Element

    ScrollRestoration

    • +

      This component will emulate the browser's scroll restoration on location +changes.

      +

      Parameters

      Returns null

    createBrowserRouter

    • createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    createHashRouter

    • createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): RemixRouter

    • Parameters

      Returns RemixRouter

    useBeforeUnload

    • useBeforeUnload(callback: ((event: BeforeUnloadEvent) => any), options?: { capture?: boolean }): void
    • +

      Setup a callback to be fired on the window's beforeunload event. This is +useful for saving some data to window.localStorage just before the page +refreshes.

      +

      Note: The callback argument should be a function created with +React.useCallback().

      +

      Parameters

      • callback: ((event: BeforeUnloadEvent) => any)
          • (event: BeforeUnloadEvent): any

          • Parameters

            • event: BeforeUnloadEvent

            Returns any

      • Optional options: { capture?: boolean }
        • Optional capture?: boolean

      Returns void

    useFetcher

    • +

      Interacts with route loaders and actions without causing a navigation. Great +for any interaction that stays on the same page.

      +

      Type Parameters

      • TData = any

      Returns ReactRouterDom.FetcherWithComponents<TData>

    useFetchers

    • +

      Provides all fetchers currently on the page. Useful for layouts and parent +routes that need to provide pending/optimistic UI regarding the fetch.

      +

      Returns Fetcher[]

    useFormAction

    • Parameters

      Returns string

    useLinkClickHandler

    • useLinkClickHandler<E>(to: To, __namedParameters?: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }): ((event: React.MouseEvent<E, MouseEvent>) => void)
    • +

      Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

      +

      Type Parameters

      • E extends Element<E> = HTMLAnchorElement

      Parameters

      • to: To
      • Optional __namedParameters: { preventScrollReset?: boolean; relative?: RelativeRoutingType; replace?: boolean; state?: any; target?: HTMLAttributeAnchorTarget }
        • Optional preventScrollReset?: boolean
        • Optional relative?: RelativeRoutingType
        • Optional replace?: boolean
        • Optional state?: any
        • Optional target?: HTMLAttributeAnchorTarget

      Returns ((event: React.MouseEvent<E, MouseEvent>) => void)

        • (event: React.MouseEvent<E, MouseEvent>): void
        • +

          Handles the click behavior for router <Link> components. This is useful if +you need to create custom <Link> components with the same click behavior we +use in our exported <Link>.

          +

          Parameters

          • event: React.MouseEvent<E, MouseEvent>

          Returns void

    useSearchParams

    • +

      A convenient wrapper for reading and writing search parameters via the +URLSearchParams interface.

      +

      Parameters

      Returns [URLSearchParams, ReactRouterDom.SetURLSearchParams]

    useSubmit

    • +

      Returns a function that may be used to programmatically submit a form (or +some arbitrary data) to the server.

      +

      Returns ReactRouterDom.SubmitFunction

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/docs/modules/node_react_router_node.html b/packages/xarc-react-router/docs/modules/node_react_router_node.html index 3c82b582e..bb64bad7e 100644 --- a/packages/xarc-react-router/docs/modules/node_react_router_node.html +++ b/packages/xarc-react-router/docs/modules/node_react_router_node.html @@ -1,170 +1,8 @@ - - - - - - node/react-router-node | @xarc/react-router - - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Module node/react-router-node

    -
    -
    -
    -
    -
    -
    -
    -

    Index

    -
    -
    -
    -

    Functions

    - -
    -
    -
    -
    -
    -

    Functions

    -
    - -

    reactRouterFeature

    - -
      -
    • - -
      -
      -

      Implement the component wrapping support for using react router on a subapp

      -
      -
      -

      Parameters

      - -

      Returns SubAppFeatureFactory

      -
        -
      • feature factory which can add router feature on a subapp
        • -
      -
      • -
    -
    -
    -
    -
    - - -
    -
    -
    -
    -
    -

    Legend

    -
    -
      -
    • Variable
      • -
    • Function
      • -
    • Type alias
      • -
    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    -
    - - - \ No newline at end of file +node/react-router-node | @xarc/react-router
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module node/react-router-node

    Index

    Functions

    Functions

    reactRouterFeature

    Legend

    • Variable
    • Function
    • Type alias

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xarc-react-router/package.json b/packages/xarc-react-router/package.json index 3b51352ea..6725408c9 100644 --- a/packages/xarc-react-router/package.json +++ b/packages/xarc-react-router/package.json @@ -1,6 +1,6 @@ { "name": "@xarc/react-router", - "version": "1.1.1", + "version": "1.1.2", "description": "xarc React Router support for SubApp version 2", "main": "dist-node-cjs/node/index.js", "module": "dist-node-esm/node/index.js", diff --git a/packages/xarc-react-router/src/browser/index.ts b/packages/xarc-react-router/src/browser/index.ts index a5ce5e7bd..ae30628d7 100644 --- a/packages/xarc-react-router/src/browser/index.ts +++ b/packages/xarc-react-router/src/browser/index.ts @@ -1,4 +1,5 @@ export * from "./react-router-browser"; + // // re-export from common // diff --git a/samples/subapp2-basic/package.json b/samples/subapp2-basic/package.json index e96a1ddc5..d0025af1e 100644 --- a/samples/subapp2-basic/package.json +++ b/samples/subapp2-basic/package.json @@ -36,9 +36,9 @@ "@xarc/fastify-server": "^3.3.0", "@xarc/app": "^11.0.5", "@xarc/react": "^1.0.3", - "@xarc/react-query": "^1.0.2", + "@xarc/react-query": "^1.0.3", "@xarc/react-redux": "^1.1.2", - "@xarc/react-router": "^1.1.1", + "@xarc/react-router": "^1.1.2", "@module-federation/concat-runtime": "~0.0.1" }, "devDependencies": { diff --git a/samples/subapp2-poc/package.json b/samples/subapp2-poc/package.json index 5e575ef56..73ec62a88 100644 --- a/samples/subapp2-poc/package.json +++ b/samples/subapp2-poc/package.json @@ -34,10 +34,10 @@ "@xarc/app": "^11.0.5", "@xarc/fastify-server": "^3.3.0", "@xarc/react": "^1.0.3", - "@xarc/react-query": "^1.0.2", - "@xarc/react-recoil": "^1.1.1", + "@xarc/react-query": "^1.0.3", + "@xarc/react-recoil": "^1.1.2", "@xarc/react-redux": "^1.1.2", - "@xarc/react-router": "^1.1.1", + "@xarc/react-router": "^1.1.2", "isomorphic-loader": "^4.5.0", "prop-types": "~15.8.1", "react-dom": "~18.2.0"