@elliemae/pui-app-sdk 5.42.4 → 5.42.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/docs/404.html +2 -2
- package/build/docs/api/classes/Analytics/index.html +2 -2
- package/build/docs/api/classes/CMicroAppGuest/index.html +2 -2
- package/build/docs/api/classes/CMicroAppHost/index.html +2 -2
- package/build/docs/api/classes/ErrorBoundary/index.html +2 -2
- package/build/docs/api/classes/GuestModule/index.html +2 -2
- package/build/docs/api/functions/AppRoot/index.html +2 -2
- package/build/docs/api/functions/Autocomplete/index.html +2 -2
- package/build/docs/api/functions/CheckBox/index.html +2 -2
- package/build/docs/api/functions/ComboBox/index.html +2 -2
- package/build/docs/api/functions/ComboBoxV3/index.html +2 -2
- package/build/docs/api/functions/ConnectForm/index.html +2 -2
- package/build/docs/api/functions/DateInput/index.html +2 -2
- package/build/docs/api/functions/DatePicker/index.html +2 -2
- package/build/docs/api/functions/DateRangePicker/index.html +2 -2
- package/build/docs/api/functions/DateTimePicker/index.html +2 -2
- package/build/docs/api/functions/Form/index.html +2 -2
- package/build/docs/api/functions/FormItemLayout/index.html +2 -2
- package/build/docs/api/functions/FormLayoutBlockItem/index.html +2 -2
- package/build/docs/api/functions/FormSubmitButton/index.html +2 -2
- package/build/docs/api/functions/InputMask/index.html +2 -2
- package/build/docs/api/functions/InputText/index.html +2 -2
- package/build/docs/api/functions/LargeTextBox/index.html +2 -2
- package/build/docs/api/functions/MaskedInputText/index.html +2 -2
- package/build/docs/api/functions/Page/index.html +2 -2
- package/build/docs/api/functions/Radio/index.html +2 -2
- package/build/docs/api/functions/RadioGroup/index.html +2 -2
- package/build/docs/api/functions/RegisterService/index.html +2 -2
- package/build/docs/api/functions/RenderWithStateAddOns/index.html +2 -2
- package/build/docs/api/functions/RequireAuth/index.html +2 -2
- package/build/docs/api/functions/SessionTimeout/index.html +2 -2
- package/build/docs/api/functions/TextBox/index.html +2 -2
- package/build/docs/api/functions/Toggle/index.html +2 -2
- package/build/docs/api/functions/authSaga/index.html +2 -2
- package/build/docs/api/functions/authorize/index.html +2 -2
- package/build/docs/api/functions/buildModuleParams/index.html +2 -2
- package/build/docs/api/functions/cleanup/index.html +2 -2
- package/build/docs/api/functions/configureStore/index.html +2 -2
- package/build/docs/api/functions/createGuestModule/index.html +2 -2
- package/build/docs/api/functions/createManager/index.html +2 -2
- package/build/docs/api/functions/enableReactAppForHostIntegration/index.html +2 -2
- package/build/docs/api/functions/fetchHostAppData/index.html +2 -2
- package/build/docs/api/functions/fetchUserSettings/index.html +2 -2
- package/build/docs/api/functions/getApiActionCreator/index.html +2 -2
- package/build/docs/api/functions/getAppConfig/index.html +2 -2
- package/build/docs/api/functions/getAppConfigValue/index.html +2 -2
- package/build/docs/api/functions/getAuthHTTPClient/index.html +2 -2
- package/build/docs/api/functions/getAuthorizationHeader/index.html +2 -2
- package/build/docs/api/functions/getHTTPClient/index.html +2 -2
- package/build/docs/api/functions/getHostAppDataByKey/index.html +2 -2
- package/build/docs/api/functions/getLogger/index.html +2 -2
- package/build/docs/api/functions/getMicroFrontEndAppConfig/index.html +2 -2
- package/build/docs/api/functions/getNavigationLinks/index.html +2 -2
- package/build/docs/api/functions/getRedirectUrl/index.html +2 -2
- package/build/docs/api/functions/getSelectField/index.html +2 -2
- package/build/docs/api/functions/getStore/index.html +2 -2
- package/build/docs/api/functions/initServiceWorker/index.html +2 -2
- package/build/docs/api/functions/isCIBuild/index.html +2 -2
- package/build/docs/api/functions/isProd/index.html +2 -2
- package/build/docs/api/functions/isUserAuthorized/index.html +2 -2
- package/build/docs/api/functions/listenStorageEvents/index.html +2 -2
- package/build/docs/api/functions/loadAppConfig/index.html +2 -2
- package/build/docs/api/functions/loadable/index.html +2 -2
- package/build/docs/api/functions/login/index.html +2 -2
- package/build/docs/api/functions/notifyGuestUnloadComplete/index.html +2 -2
- package/build/docs/api/functions/onAuthorizationFailure/index.html +2 -2
- package/build/docs/api/functions/onGuestUnloadStart/index.html +2 -2
- package/build/docs/api/functions/redactPii/index.html +2 -2
- package/build/docs/api/functions/removeDoubleSlash/index.html +2 -2
- package/build/docs/api/functions/removeStorageEvents/index.html +2 -2
- package/build/docs/api/functions/render/index.html +2 -2
- package/build/docs/api/functions/renderHook/index.html +2 -2
- package/build/docs/api/functions/renderWithHostData/index.html +2 -2
- package/build/docs/api/functions/renderWithRedux/index.html +2 -2
- package/build/docs/api/functions/renderWithRouter/index.html +2 -2
- package/build/docs/api/functions/renderWithRouterRedux/index.html +2 -2
- package/build/docs/api/functions/sdkBaseQuery/index.html +2 -2
- package/build/docs/api/functions/sendBAEvent/index.html +2 -2
- package/build/docs/api/functions/sendMessageToHost/index.html +2 -2
- package/build/docs/api/functions/setAppConfig/index.html +2 -2
- package/build/docs/api/functions/setAppConfigValue/index.html +2 -2
- package/build/docs/api/functions/setHostAppData/index.html +2 -2
- package/build/docs/api/functions/setLoginParams/index.html +2 -2
- package/build/docs/api/functions/subscribeToResetSession/index.html +7 -10
- package/build/docs/api/functions/subscribeToSessionExpiry/index.html +7 -10
- package/build/docs/api/functions/subscribeToSessionExpiryWarning/index.html +7 -10
- package/build/docs/api/functions/trackActivity/index.html +9 -11
- package/build/docs/api/functions/useAppDispatch/index.html +2 -2
- package/build/docs/api/functions/useAppMiddleware/index.html +2 -2
- package/build/docs/api/functions/useInjectQuery/index.html +2 -2
- package/build/docs/api/functions/useInjectReducer/index.html +2 -2
- package/build/docs/api/functions/useInjectSaga/index.html +2 -2
- package/build/docs/api/functions/useInjectSideEffect/index.html +2 -2
- package/build/docs/api/functions/useMediaQueryList/index.html +2 -2
- package/build/docs/api/functions/useStateSelector/index.html +2 -2
- package/build/docs/api/functions/useStateSelectorShallow/index.html +2 -2
- package/build/docs/api/functions/waitFor/index.html +2 -2
- package/build/docs/api/functions/waitForElementToBeRemoved/index.html +2 -2
- package/build/docs/api/functions/withAppDecorator/index.html +2 -2
- package/build/docs/api/index.html +4 -4
- package/build/docs/api/interfaces/AppConfig/index.html +2 -2
- package/build/docs/api/interfaces/GuestProps/index.html +2 -2
- package/build/docs/api/interfaces/UseStateSelectorOptions/index.html +2 -2
- package/build/docs/api/type-aliases/AppDispatch/index.html +2 -2
- package/build/docs/api/type-aliases/AppStore/index.html +2 -2
- package/build/docs/api/type-aliases/Await/index.html +2 -2
- package/build/docs/api/type-aliases/EMUI/index.html +2 -2
- package/build/docs/api/type-aliases/HostOptions/index.html +2 -2
- package/build/docs/api/type-aliases/HostProvidedParams/index.html +2 -2
- package/build/docs/api/type-aliases/ModuleOverrides/index.html +2 -2
- package/build/docs/api/type-aliases/OnHostInitCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnInitCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnMountCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnUnMountCallback/index.html +2 -2
- package/build/docs/api/type-aliases/RootState/index.html +2 -2
- package/build/docs/api/type-aliases/SelectStateFieldFunction/index.html +2 -2
- package/build/docs/api/variables/ErrorToast/index.html +2 -2
- package/build/docs/api/variables/FormPropsContext/index.html +2 -2
- package/build/docs/api/variables/GuestMicroApp/index.html +2 -2
- package/build/docs/api/variables/MASK_PIPES/index.html +2 -2
- package/build/docs/api/variables/MASK_TYPES/index.html +2 -2
- package/build/docs/api/variables/MicroApp/index.html +2 -2
- package/build/docs/api/variables/MicroIFrameApp/index.html +2 -2
- package/build/docs/api/variables/NavigationPrompt/index.html +2 -2
- package/build/docs/api/variables/NavigationPromptActions/index.html +2 -2
- package/build/docs/api/variables/Themes/index.html +2 -2
- package/build/docs/api/variables/VisuallyHidden/index.html +2 -2
- package/build/docs/api/variables/WaitMessage/index.html +2 -2
- package/build/docs/api/variables/act/index.html +2 -2
- package/build/docs/api/variables/ariaLive/index.html +2 -2
- package/build/docs/api/variables/auth/index.html +2 -2
- package/build/docs/api/variables/authReducer/index.html +2 -2
- package/build/docs/api/variables/clearSideEffects/index.html +2 -2
- package/build/docs/api/variables/createSideEffect/index.html +2 -2
- package/build/docs/api/variables/decorators/index.html +2 -2
- package/build/docs/api/variables/endSession/index.html +2 -2
- package/build/docs/api/variables/error/index.html +2 -2
- package/build/docs/api/variables/errorMiddleware/index.html +2 -2
- package/build/docs/api/variables/fireEvent/index.html +2 -2
- package/build/docs/api/variables/globalConstants/index.html +2 -2
- package/build/docs/api/variables/history/index.html +2 -2
- package/build/docs/api/variables/httpClientProps/index.html +2 -2
- package/build/docs/api/variables/logout/index.html +2 -2
- package/build/docs/api/variables/memoryHistory/index.html +2 -2
- package/build/docs/api/variables/removeSideEffect/index.html +2 -2
- package/build/docs/api/variables/resetUserIdleTime/index.html +8 -8
- package/build/docs/api/variables/screen/index.html +2 -2
- package/build/docs/api/variables/startSideEffect/index.html +2 -2
- package/build/docs/api/variables/updateBAEventParameters/index.html +2 -2
- package/build/docs/api/variables/useAppSelector/index.html +2 -2
- package/build/docs/api/variables/waitMessageAction/index.html +2 -2
- package/build/docs/api/variables/within/index.html +2 -2
- package/build/docs/assets/js/3cb0b0a9.67b20d88.js +1 -0
- package/build/docs/assets/js/{5e8c322a.f1548b2b.js → 5e8c322a.c3cc240b.js} +1 -1
- package/build/docs/assets/js/{822e0178.a567065b.js → 822e0178.dfd661b8.js} +1 -1
- package/build/docs/assets/js/a0eb976e.77667f42.js +1 -0
- package/build/docs/assets/js/c90572d4.0b7362b5.js +1 -0
- package/build/docs/assets/js/f4180cff.0f2ce3bf.js +1 -0
- package/build/docs/assets/js/fed4ae4f.4cbcd19c.js +1 -0
- package/build/docs/assets/js/{main.2c531d5e.js → main.1a5a08af.js} +2 -2
- package/build/docs/assets/js/{runtime~main.cd750ab4.js → runtime~main.9f7b9b59.js} +1 -1
- package/build/docs/index.html +2 -2
- package/build/docs/usage-guide/index.html +2 -2
- package/demo/{9478.de5e6fa2.iframe.bundle.js → 9478.1f9d2bf2.iframe.bundle.js} +1 -1
- package/demo/9478.1f9d2bf2.iframe.bundle.js.br +0 -0
- package/demo/{docs/9478.de5e6fa2.iframe.bundle.js.gz → 9478.1f9d2bf2.iframe.bundle.js.gz} +0 -0
- package/demo/docs/{9478.de5e6fa2.iframe.bundle.js → 9478.1f9d2bf2.iframe.bundle.js} +1 -1
- package/demo/docs/9478.1f9d2bf2.iframe.bundle.js.br +0 -0
- package/demo/{9478.de5e6fa2.iframe.bundle.js.gz → docs/9478.1f9d2bf2.iframe.bundle.js.gz} +0 -0
- package/demo/docs/iframe.html +1 -1
- package/demo/docs/index.html +1 -1
- package/demo/docs/main.3ca9a77e.iframe.bundle.js +5 -0
- package/demo/docs/main.3ca9a77e.iframe.bundle.js.br +0 -0
- package/demo/docs/main.3ca9a77e.iframe.bundle.js.gz +0 -0
- package/demo/docs/{main.b293ffa609119d831d1a.manager.bundle.js → main.9379efdc5e6f460465e2.manager.bundle.js} +1 -1
- package/demo/docs/main.9379efdc5e6f460465e2.manager.bundle.js.br +0 -0
- package/demo/docs/{main.b293ffa609119d831d1a.manager.bundle.js.gz → main.9379efdc5e6f460465e2.manager.bundle.js.gz} +0 -0
- package/demo/docs/project.json +1 -1
- package/demo/docs/{runtime~main.79f1fd4d.iframe.bundle.js → runtime~main.b7f50131.iframe.bundle.js} +2 -2
- package/demo/docs/{runtime~main.79f1fd4d.iframe.bundle.js.br → runtime~main.b7f50131.iframe.bundle.js.br} +0 -0
- package/demo/docs/runtime~main.b7f50131.iframe.bundle.js.gz +0 -0
- package/demo/iframe.html +1 -1
- package/demo/index.html +1 -1
- package/demo/main.3ca9a77e.iframe.bundle.js +5 -0
- package/demo/main.3ca9a77e.iframe.bundle.js.br +0 -0
- package/demo/main.3ca9a77e.iframe.bundle.js.gz +0 -0
- package/demo/{main.b293ffa609119d831d1a.manager.bundle.js → main.9379efdc5e6f460465e2.manager.bundle.js} +1 -1
- package/demo/main.9379efdc5e6f460465e2.manager.bundle.js.br +0 -0
- package/demo/{main.b293ffa609119d831d1a.manager.bundle.js.gz → main.9379efdc5e6f460465e2.manager.bundle.js.gz} +0 -0
- package/demo/project.json +1 -1
- package/demo/{runtime~main.79f1fd4d.iframe.bundle.js → runtime~main.b7f50131.iframe.bundle.js} +2 -2
- package/demo/{runtime~main.79f1fd4d.iframe.bundle.js.br → runtime~main.b7f50131.iframe.bundle.js.br} +0 -0
- package/demo/runtime~main.b7f50131.iframe.bundle.js.gz +0 -0
- package/dist/cjs/utils/session-timeout-config.js +60 -0
- package/dist/cjs/utils/session.js +45 -23
- package/dist/cjs/view/modals/session-expiry/customHooks.js +3 -10
- package/dist/cjs/view/modals/session-expiry/index.js +1 -1
- package/dist/esm/utils/session-timeout-config.js +40 -0
- package/dist/esm/utils/session.js +50 -27
- package/dist/esm/view/modals/session-expiry/customHooks.js +6 -10
- package/dist/esm/view/modals/session-expiry/index.js +1 -1
- package/dist/types/lib/utils/session-timeout-config.d.ts +6 -0
- package/dist/types/lib/utils/session.d.ts +38 -71
- package/dist/types/lib/utils/tests/session-idle-guard.test.d.ts +1 -0
- package/dist/types/lib/utils/tests/session-timeout-config.test.d.ts +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/build/docs/assets/js/3cb0b0a9.b5efc7a4.js +0 -1
- package/build/docs/assets/js/a0eb976e.fc660f60.js +0 -1
- package/build/docs/assets/js/c90572d4.71073c5c.js +0 -1
- package/build/docs/assets/js/f4180cff.b50f1502.js +0 -1
- package/build/docs/assets/js/fed4ae4f.335f00fb.js +0 -1
- package/demo/9478.de5e6fa2.iframe.bundle.js.br +0 -0
- package/demo/docs/9478.de5e6fa2.iframe.bundle.js.br +0 -0
- package/demo/docs/main.4a02f0d8.iframe.bundle.js +0 -5
- package/demo/docs/main.4a02f0d8.iframe.bundle.js.br +0 -0
- package/demo/docs/main.4a02f0d8.iframe.bundle.js.gz +0 -0
- package/demo/docs/main.b293ffa609119d831d1a.manager.bundle.js.br +0 -0
- package/demo/docs/runtime~main.79f1fd4d.iframe.bundle.js.gz +0 -0
- package/demo/main.4a02f0d8.iframe.bundle.js +0 -5
- package/demo/main.4a02f0d8.iframe.bundle.js.br +0 -0
- package/demo/main.4a02f0d8.iframe.bundle.js.gz +0 -0
- package/demo/main.b293ffa609119d831d1a.manager.bundle.js.br +0 -0
- package/demo/runtime~main.79f1fd4d.iframe.bundle.js.gz +0 -0
- /package/build/docs/assets/js/{main.2c531d5e.js.LICENSE.txt → main.1a5a08af.js.LICENSE.txt} +0 -0
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useAppDispatch() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useAppDispatch"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useAppDispatch() | App SDK"><meta data-rh="true" name="description" content="React hook to get the typed dispatch function."><meta data-rh="true" property="og:description" content="React hook to get the typed dispatch function."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useAppDispatch"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useAppDispatch" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useAppDispatch" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useAppDispatch()","item":"https://pui.ice.com/app-sdk/api/functions/useAppDispatch"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useAppMiddleware() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useAppMiddleware"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useAppMiddleware() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useAppMiddleware"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useAppMiddleware" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useAppMiddleware" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useAppMiddleware()","item":"https://pui.ice.com/app-sdk/api/functions/useAppMiddleware"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useInjectQuery() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useInjectQuery"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useInjectQuery() | App SDK"><meta data-rh="true" name="description" content="React hook to dynamically inject RTK Query API slice into the Redux store."><meta data-rh="true" property="og:description" content="React hook to dynamically inject RTK Query API slice into the Redux store."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useInjectQuery"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectQuery" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectQuery" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useInjectQuery()","item":"https://pui.ice.com/app-sdk/api/functions/useInjectQuery"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useInjectReducer() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useInjectReducer"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useInjectReducer() | App SDK"><meta data-rh="true" name="description" content="A react hook that dynamically injects a reducer when the hook is run"><meta data-rh="true" property="og:description" content="A react hook that dynamically injects a reducer when the hook is run"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useInjectReducer"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectReducer" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectReducer" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useInjectReducer()","item":"https://pui.ice.com/app-sdk/api/functions/useInjectReducer"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useInjectSaga() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useInjectSaga"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useInjectSaga() | App SDK"><meta data-rh="true" name="description" content="A react hook that dynamically injects a saga when the hook is run"><meta data-rh="true" property="og:description" content="A react hook that dynamically injects a saga when the hook is run"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useInjectSaga"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectSaga" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectSaga" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useInjectSaga()","item":"https://pui.ice.com/app-sdk/api/functions/useInjectSaga"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useInjectSideEffect() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useInjectSideEffect"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useInjectSideEffect() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useInjectSideEffect"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectSideEffect" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useInjectSideEffect" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useInjectSideEffect()","item":"https://pui.ice.com/app-sdk/api/functions/useInjectSideEffect"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useMediaQueryList() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useMediaQueryList"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useMediaQueryList() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useMediaQueryList"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useMediaQueryList" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useMediaQueryList" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useMediaQueryList()","item":"https://pui.ice.com/app-sdk/api/functions/useMediaQueryList"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useStateSelector() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useStateSelector"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useStateSelector() | App SDK"><meta data-rh="true" name="description" content="Generic selector that receives a field selector function returned from getSelectField"><meta data-rh="true" property="og:description" content="Generic selector that receives a field selector function returned from getSelectField"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useStateSelector"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useStateSelector" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useStateSelector" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useStateSelector()","item":"https://pui.ice.com/app-sdk/api/functions/useStateSelector"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">useStateSelectorShallow() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/useStateSelectorShallow"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="useStateSelectorShallow() | App SDK"><meta data-rh="true" name="description" content="Generic selector that receives a field selector function returned from getSelectField."><meta data-rh="true" property="og:description" content="Generic selector that receives a field selector function returned from getSelectField."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/useStateSelectorShallow"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useStateSelectorShallow" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/useStateSelectorShallow" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"useStateSelectorShallow()","item":"https://pui.ice.com/app-sdk/api/functions/useStateSelectorShallow"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">waitFor() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/waitFor"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="waitFor() | App SDK"><meta data-rh="true" name="description" content="Type Parameters"><meta data-rh="true" property="og:description" content="Type Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/waitFor"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/waitFor" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/waitFor" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"waitFor()","item":"https://pui.ice.com/app-sdk/api/functions/waitFor"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">waitForElementToBeRemoved() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/waitForElementToBeRemoved"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="waitForElementToBeRemoved() | App SDK"><meta data-rh="true" name="description" content="Type Parameters"><meta data-rh="true" property="og:description" content="Type Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/waitForElementToBeRemoved"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/waitForElementToBeRemoved" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/waitForElementToBeRemoved" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"waitForElementToBeRemoved()","item":"https://pui.ice.com/app-sdk/api/functions/waitForElementToBeRemoved"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">withAppDecorator() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/withAppDecorator"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="withAppDecorator() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/withAppDecorator"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/withAppDecorator" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/withAppDecorator" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"withAppDecorator()","item":"https://pui.ice.com/app-sdk/api/functions/withAppDecorator"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">App SDK API | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="App SDK API | App SDK"><meta data-rh="true" name="description" content="Classes"><meta data-rh="true" property="og:description" content="Classes"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -17,13 +17,13 @@
|
|
|
17
17
|
<h2 class="anchor anchorTargetStickyNavbar_EtkZ" id="interfaces">Interfaces<a href="#interfaces" class="hash-link" aria-label="Direct link to Interfaces" title="Direct link to Interfaces" translate="no"></a></h2>
|
|
18
18
|
<table><thead><tr><th>Interface</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/interfaces/AppConfig">AppConfig</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/interfaces/GuestProps">GuestProps</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/interfaces/UseStateSelectorOptions">UseStateSelectorOptions</a></td><td>-</td></tr></tbody></table>
|
|
19
19
|
<h2 class="anchor anchorTargetStickyNavbar_EtkZ" id="functions">Functions<a href="#functions" class="hash-link" aria-label="Direct link to Functions" title="Direct link to Functions" translate="no"></a></h2>
|
|
20
|
-
<table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/functions/AppRoot">AppRoot</a></td><td>Root component for SDK-based applications. Provides Redux store, routing, theming, error boundaries, and session management.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/authorize">authorize</a></td><td>Handles the OAuth authorization callback after redirect from IDP. Exchanges authorization code for access token and initializes user session.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/authSaga">authSaga</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Autocomplete">Autocomplete</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/buildModuleParams">buildModuleParams</a></td><td>Build a ModuleParameters object for a self-initializing guest.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/CheckBox">CheckBox</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/cleanup">cleanup</a></td><td>Unmounts React trees that were mounted with render.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ComboBox">ComboBox</a></td><td>Dropdown/select field component with React Hook Form integration. Wraps the Dimsum ComboBox component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ComboBoxV3">ComboBoxV3</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/configureStore">configureStore</a></td><td>Creates and configures the Redux store with SDK middleware and enhancers. Includes saga middleware, listener middleware, RTK Query support, and hot reloading.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ConnectForm">ConnectForm</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/createGuestModule">createGuestModule</a></td><td>Create a module scripting object for a guest micro-app. The host registers this before rendering GuestMicroApp so the guest can pull its init parameters via module.getParameters().</td></tr><tr><td><a class="" href="/app-sdk/api/functions/createManager">createManager</a></td><td>Creates a "manager" component that will inject the provided reducer and saga when mounted. It only renders its children after both the reducer and saga have been injected. This is the recommended way to use redux-injectors.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateInput">DateInput</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DatePicker">DatePicker</a></td><td>Date picker field component with React Hook Form integration. Wraps the Dimsum DatePicker component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateRangePicker">DateRangePicker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateTimePicker">DateTimePicker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/enableReactAppForHostIntegration">enableReactAppForHostIntegration</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/fetchHostAppData">fetchHostAppData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/fetchUserSettings">fetchUserSettings</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Form">Form</a></td><td>Form component with integrated React Hook Form state management and validation. Provides form context to all child form fields and handles submission.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormItemLayout">FormItemLayout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormLayoutBlockItem">FormLayoutBlockItem</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormSubmitButton">FormSubmitButton</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getApiActionCreator">getApiActionCreator</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAppConfig">getAppConfig</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAppConfigValue">getAppConfigValue</a></td><td>Gets a value from the application configuration using dot notation. Returns a deep clone to prevent accidental mutations.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAuthHTTPClient">getAuthHTTPClient</a></td><td>Creates an authenticated HTTP client instance with authorization headers. Automatically includes the current user's authorization token in all requests.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAuthorizationHeader">getAuthorizationHeader</a></td><td>Gets the current authorization header value from session storage.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getHostAppDataByKey">getHostAppDataByKey</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getHTTPClient">getHTTPClient</a></td><td>Creates a basic HTTP client instance using Axios. The client includes request/response interceptors and automatic retry logic.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getLogger">getLogger</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getMicroFrontEndAppConfig">getMicroFrontEndAppConfig</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getNavigationLinks">getNavigationLinks</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getRedirectUrl">getRedirectUrl</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getSelectField">getSelectField</a></td><td>Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store hence making it easier and keeping your codebase smaller and easier to maintain.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getStore">getStore</a></td><td>Gets the global Redux store instance.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/initServiceWorker">initServiceWorker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/InputMask">InputMask</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/InputText">InputText</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isCIBuild">isCIBuild</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isProd">isProd</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isUserAuthorized">isUserAuthorized</a></td><td>Checks if the user is currently authorized/authenticated.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/LargeTextBox">LargeTextBox</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/listenStorageEvents">listenStorageEvents</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/loadable">loadable</a></td><td>Creates a lazily-loaded React component for code splitting. Wraps the component in Suspense with a customizable fallback.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/loadAppConfig">loadAppConfig</a></td><td>Loads the application configuration from a JSON file. Attempts to fetch from versioned path first, then falls back to unversioned path. Merges environment-specific configuration with base configuration.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/login">login</a></td><td>Initiates the login flow using OAuth/OIDC authorization code flow. If authorization code is present in URL, completes the authorization. Otherwise, redirects to the identity provider's login page.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/MaskedInputText">MaskedInputText</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/notifyGuestUnloadComplete">notifyGuestUnloadComplete</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/onAuthorizationFailure">onAuthorizationFailure</a></td><td>Registers a callback to handle authorization failures (401 errors). The callback should refresh the authentication token and return the new authorization header. The SDK will automatically retry the failed request with the new token.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/onGuestUnloadStart">onGuestUnloadStart</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Page">Page</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Radio">Radio</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RadioGroup">RadioGroup</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/redactPii">redactPii</a></td><td>Redacts personally identifiable information (PII) from data objects. Removes sensitive data like credit cards, SSNs, emails, passwords, addresses, etc.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RegisterService">RegisterService</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/removeDoubleSlash">removeDoubleSlash</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/removeStorageEvents">removeStorageEvents</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/render">render</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderHook">renderHook</a></td><td>Allows you to render a hook within a test React component without having to create that component yourself.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithHostData">renderWithHostData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRedux">renderWithRedux</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRouter">renderWithRouter</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRouterRedux">renderWithRouterRedux</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RenderWithStateAddOns">RenderWithStateAddOns</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RequireAuth">RequireAuth</a></td><td>A React component that ensures authentication for its children.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sdkBaseQuery">sdkBaseQuery</a></td><td>Base query function for RTK Query integration. Provides automatic error handling, authentication, and token refresh capabilities. Use this as the baseQuery for RTK Query API slices.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sendBAEvent"><del>sendBAEvent</del></a></td><td>Sends a business analytics event to Google Tag Manager data layer. Can send events to the host app or handle locally.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sendMessageToHost">sendMessageToHost</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/SessionTimeout">SessionTimeout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setAppConfig">setAppConfig</a></td><td>Sets the entire application configuration. Replaces the current configuration with the provided config object.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setAppConfigValue">setAppConfigValue</a></td><td>Sets a value in the application configuration using dot notation. Creates nested objects if they don't exist.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setHostAppData">setHostAppData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setLoginParams">setLoginParams</a></td><td>Sets login parameters for the authentication flow. Stores parameters in the global window object for use across the application.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToResetSession">subscribeToResetSession</a></td><td>Subscribes to session reset events. The callback is invoked when the session idle time is reset.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToSessionExpiry">subscribeToSessionExpiry</a></td><td>Subscribes to session expiry events. The callback is invoked when the session has expired.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToSessionExpiryWarning">subscribeToSessionExpiryWarning</a></td><td>Subscribes to session expiry warning events. The callback is invoked when the session is about to expire (based on warning interval).</td></tr><tr><td><a class="" href="/app-sdk/api/functions/TextBox">TextBox</a></td><td>Text input field component with React Hook Form integration. Wraps the Dimsum TextBox component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Toggle">Toggle</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/trackActivity">trackActivity</a></td><td>Starts tracking user activity for session management. Monitors user interactions on the specified element and invokes callback.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useAppDispatch">useAppDispatch</a></td><td>React hook to get the typed dispatch function. Provides type-safe dispatching of Redux actions.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useAppMiddleware">useAppMiddleware</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectQuery">useInjectQuery</a></td><td>React hook to dynamically inject RTK Query API slice into the Redux store. Registers the reducer and middleware for the API slice at runtime.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectReducer">useInjectReducer</a></td><td>A react hook that dynamically injects a reducer when the hook is run</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectSaga">useInjectSaga</a></td><td>A react hook that dynamically injects a saga when the hook is run</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectSideEffect">useInjectSideEffect</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useMediaQueryList">useMediaQueryList</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useStateSelector">useStateSelector</a></td><td>Generic selector that receives a field selector function returned from getSelectField</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useStateSelectorShallow">useStateSelectorShallow</a></td><td>Generic selector that receives a field selector function returned from getSelectField.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/waitFor">waitFor</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/waitForElementToBeRemoved">waitForElementToBeRemoved</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/withAppDecorator">withAppDecorator</a></td><td>-</td></tr></tbody></table>
|
|
20
|
+
<table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/functions/AppRoot">AppRoot</a></td><td>Root component for SDK-based applications. Provides Redux store, routing, theming, error boundaries, and session management.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/authorize">authorize</a></td><td>Handles the OAuth authorization callback after redirect from IDP. Exchanges authorization code for access token and initializes user session.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/authSaga">authSaga</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Autocomplete">Autocomplete</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/buildModuleParams">buildModuleParams</a></td><td>Build a ModuleParameters object for a self-initializing guest.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/CheckBox">CheckBox</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/cleanup">cleanup</a></td><td>Unmounts React trees that were mounted with render.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ComboBox">ComboBox</a></td><td>Dropdown/select field component with React Hook Form integration. Wraps the Dimsum ComboBox component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ComboBoxV3">ComboBoxV3</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/configureStore">configureStore</a></td><td>Creates and configures the Redux store with SDK middleware and enhancers. Includes saga middleware, listener middleware, RTK Query support, and hot reloading.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/ConnectForm">ConnectForm</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/createGuestModule">createGuestModule</a></td><td>Create a module scripting object for a guest micro-app. The host registers this before rendering GuestMicroApp so the guest can pull its init parameters via module.getParameters().</td></tr><tr><td><a class="" href="/app-sdk/api/functions/createManager">createManager</a></td><td>Creates a "manager" component that will inject the provided reducer and saga when mounted. It only renders its children after both the reducer and saga have been injected. This is the recommended way to use redux-injectors.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateInput">DateInput</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DatePicker">DatePicker</a></td><td>Date picker field component with React Hook Form integration. Wraps the Dimsum DatePicker component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateRangePicker">DateRangePicker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/DateTimePicker">DateTimePicker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/enableReactAppForHostIntegration">enableReactAppForHostIntegration</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/fetchHostAppData">fetchHostAppData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/fetchUserSettings">fetchUserSettings</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Form">Form</a></td><td>Form component with integrated React Hook Form state management and validation. Provides form context to all child form fields and handles submission.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormItemLayout">FormItemLayout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormLayoutBlockItem">FormLayoutBlockItem</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/FormSubmitButton">FormSubmitButton</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getApiActionCreator">getApiActionCreator</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAppConfig">getAppConfig</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAppConfigValue">getAppConfigValue</a></td><td>Gets a value from the application configuration using dot notation. Returns a deep clone to prevent accidental mutations.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAuthHTTPClient">getAuthHTTPClient</a></td><td>Creates an authenticated HTTP client instance with authorization headers. Automatically includes the current user's authorization token in all requests.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getAuthorizationHeader">getAuthorizationHeader</a></td><td>Gets the current authorization header value from session storage.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getHostAppDataByKey">getHostAppDataByKey</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getHTTPClient">getHTTPClient</a></td><td>Creates a basic HTTP client instance using Axios. The client includes request/response interceptors and automatic retry logic.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getLogger">getLogger</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getMicroFrontEndAppConfig">getMicroFrontEndAppConfig</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getNavigationLinks">getNavigationLinks</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getRedirectUrl">getRedirectUrl</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getSelectField">getSelectField</a></td><td>Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store hence making it easier and keeping your codebase smaller and easier to maintain.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/getStore">getStore</a></td><td>Gets the global Redux store instance.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/initServiceWorker">initServiceWorker</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/InputMask">InputMask</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/InputText">InputText</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isCIBuild">isCIBuild</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isProd">isProd</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/isUserAuthorized">isUserAuthorized</a></td><td>Checks if the user is currently authorized/authenticated.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/LargeTextBox">LargeTextBox</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/listenStorageEvents">listenStorageEvents</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/loadable">loadable</a></td><td>Creates a lazily-loaded React component for code splitting. Wraps the component in Suspense with a customizable fallback.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/loadAppConfig">loadAppConfig</a></td><td>Loads the application configuration from a JSON file. Attempts to fetch from versioned path first, then falls back to unversioned path. Merges environment-specific configuration with base configuration.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/login">login</a></td><td>Initiates the login flow using OAuth/OIDC authorization code flow. If authorization code is present in URL, completes the authorization. Otherwise, redirects to the identity provider's login page.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/MaskedInputText">MaskedInputText</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/notifyGuestUnloadComplete">notifyGuestUnloadComplete</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/onAuthorizationFailure">onAuthorizationFailure</a></td><td>Registers a callback to handle authorization failures (401 errors). The callback should refresh the authentication token and return the new authorization header. The SDK will automatically retry the failed request with the new token.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/onGuestUnloadStart">onGuestUnloadStart</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Page">Page</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Radio">Radio</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RadioGroup">RadioGroup</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/redactPii">redactPii</a></td><td>Redacts personally identifiable information (PII) from data objects. Removes sensitive data like credit cards, SSNs, emails, passwords, addresses, etc.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RegisterService">RegisterService</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/removeDoubleSlash">removeDoubleSlash</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/removeStorageEvents">removeStorageEvents</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/render">render</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderHook">renderHook</a></td><td>Allows you to render a hook within a test React component without having to create that component yourself.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithHostData">renderWithHostData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRedux">renderWithRedux</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRouter">renderWithRouter</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/renderWithRouterRedux">renderWithRouterRedux</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RenderWithStateAddOns">RenderWithStateAddOns</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/RequireAuth">RequireAuth</a></td><td>A React component that ensures authentication for its children.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sdkBaseQuery">sdkBaseQuery</a></td><td>Base query function for RTK Query integration. Provides automatic error handling, authentication, and token refresh capabilities. Use this as the baseQuery for RTK Query API slices.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sendBAEvent"><del>sendBAEvent</del></a></td><td>Sends a business analytics event to Google Tag Manager data layer. Can send events to the host app or handle locally.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/sendMessageToHost">sendMessageToHost</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/SessionTimeout">SessionTimeout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setAppConfig">setAppConfig</a></td><td>Sets the entire application configuration. Replaces the current configuration with the provided config object.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setAppConfigValue">setAppConfigValue</a></td><td>Sets a value in the application configuration using dot notation. Creates nested objects if they don't exist.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setHostAppData">setHostAppData</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/setLoginParams">setLoginParams</a></td><td>Sets login parameters for the authentication flow. Stores parameters in the global window object for use across the application.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToResetSession">subscribeToResetSession</a></td><td>Registers a callback when the idle clock is reset.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToSessionExpiry">subscribeToSessionExpiry</a></td><td>Registers a callback when idle time crosses the expiry threshold.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/subscribeToSessionExpiryWarning">subscribeToSessionExpiryWarning</a></td><td>Registers a callback when idle time crosses the warn threshold.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/TextBox">TextBox</a></td><td>Text input field component with React Hook Form integration. Wraps the Dimsum TextBox component with form state management and validation.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/Toggle">Toggle</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/trackActivity">trackActivity</a></td><td>Tracks user interaction on a document and invokes a callback (iframe guests). Does not run <code>enforceIdleThresholds</code>; callback should use a guarded renewal path.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useAppDispatch">useAppDispatch</a></td><td>React hook to get the typed dispatch function. Provides type-safe dispatching of Redux actions.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useAppMiddleware">useAppMiddleware</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectQuery">useInjectQuery</a></td><td>React hook to dynamically inject RTK Query API slice into the Redux store. Registers the reducer and middleware for the API slice at runtime.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectReducer">useInjectReducer</a></td><td>A react hook that dynamically injects a reducer when the hook is run</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectSaga">useInjectSaga</a></td><td>A react hook that dynamically injects a saga when the hook is run</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useInjectSideEffect">useInjectSideEffect</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useMediaQueryList">useMediaQueryList</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useStateSelector">useStateSelector</a></td><td>Generic selector that receives a field selector function returned from getSelectField</td></tr><tr><td><a class="" href="/app-sdk/api/functions/useStateSelectorShallow">useStateSelectorShallow</a></td><td>Generic selector that receives a field selector function returned from getSelectField.</td></tr><tr><td><a class="" href="/app-sdk/api/functions/waitFor">waitFor</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/waitForElementToBeRemoved">waitForElementToBeRemoved</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/functions/withAppDecorator">withAppDecorator</a></td><td>-</td></tr></tbody></table>
|
|
21
21
|
<h2 class="anchor anchorTargetStickyNavbar_EtkZ" id="references">References<a href="#references" class="hash-link" aria-label="Direct link to References" title="Direct link to References" translate="no"></a></h2>
|
|
22
22
|
<h3 class="anchor anchorTargetStickyNavbar_EtkZ" id="cmicroapp">CMicroApp<a href="#cmicroapp" class="hash-link" aria-label="Direct link to CMicroApp" title="Direct link to CMicroApp" translate="no"></a></h3>
|
|
23
23
|
<p>Renames and re-exports <a class="" href="/app-sdk/api/classes/CMicroAppGuest">CMicroAppGuest</a></p>
|
|
24
24
|
<h2 class="anchor anchorTargetStickyNavbar_EtkZ" id="type-aliases">Type Aliases<a href="#type-aliases" class="hash-link" aria-label="Direct link to Type Aliases" title="Direct link to Type Aliases" translate="no"></a></h2>
|
|
25
25
|
<table><thead><tr><th>Type Alias</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/type-aliases/AppDispatch">AppDispatch</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/AppStore">AppStore</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/Await">Await</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/EMUI">EMUI</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/HostOptions"><del>HostOptions</del></a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/HostProvidedParams">HostProvidedParams</a></td><td>Host-provided values that can't be read from the app config.</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/ModuleOverrides">ModuleOverrides</a></td><td>Optional method overrides the host can supply to customise the module scripting object beyond the defaults.</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/OnHostInitCallback">OnHostInitCallback</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/OnInitCallback">OnInitCallback</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/OnMountCallback">OnMountCallback</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/OnUnMountCallback">OnUnMountCallback</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/RootState">RootState</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/type-aliases/SelectStateFieldFunction">SelectStateFieldFunction</a></td><td>-</td></tr></tbody></table>
|
|
26
26
|
<h2 class="anchor anchorTargetStickyNavbar_EtkZ" id="variables">Variables<a href="#variables" class="hash-link" aria-label="Direct link to Variables" title="Direct link to Variables" translate="no"></a></h2>
|
|
27
|
-
<table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/variables/act">act</a></td><td>Simply calls ReactDOMTestUtils.act(cb) If that's not available (older version of react) then it simply calls the given callback immediately</td></tr><tr><td><a class="" href="/app-sdk/api/variables/ariaLive">ariaLive</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/auth">auth</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/authReducer">authReducer</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/clearSideEffects">clearSideEffects</a></td><td>Clears all registered side effect listeners. Useful for cleanup or resetting the app state.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/createSideEffect">createSideEffect</a></td><td>Creates a new side effect listener. Alternative API for adding listeners.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/decorators">decorators</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/endSession">endSession</a></td><td>Ends the current user session and redirects to logout page. Revokes tokens and clears session storage.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/error">error</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/errorMiddleware">errorMiddleware</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/ErrorToast">ErrorToast</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/fireEvent">fireEvent</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/FormPropsContext">FormPropsContext</a></td><td>Side-channel context for the <code>useForm</code> configuration that the parent <code><Form></code> was created with.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/globalConstants">globalConstants</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/GuestMicroApp">GuestMicroApp</a></td><td>Component to load a guest microapp.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/history">history</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/httpClientProps">httpClientProps</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/logout">logout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MASK_PIPES">MASK_PIPES</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MASK_TYPES">MASK_TYPES</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/memoryHistory">memoryHistory</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MicroApp"><del>MicroApp</del></a></td><td>Component to render a guest microapp</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MicroIFrameApp"><del>MicroIFrameApp</del></a></td><td>Component to render a guest microapp in an iframe.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/NavigationPrompt">NavigationPrompt</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/NavigationPromptActions">NavigationPromptActions</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/removeSideEffect">removeSideEffect</a></td><td>Removes a side effect listener.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/resetUserIdleTime">resetUserIdleTime</a></td><td>Resets the user idle
|
|
27
|
+
<table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/variables/act">act</a></td><td>Simply calls ReactDOMTestUtils.act(cb) If that's not available (older version of react) then it simply calls the given callback immediately</td></tr><tr><td><a class="" href="/app-sdk/api/variables/ariaLive">ariaLive</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/auth">auth</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/authReducer">authReducer</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/clearSideEffects">clearSideEffects</a></td><td>Clears all registered side effect listeners. Useful for cleanup or resetting the app state.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/createSideEffect">createSideEffect</a></td><td>Creates a new side effect listener. Alternative API for adding listeners.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/decorators">decorators</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/endSession">endSession</a></td><td>Ends the current user session and redirects to logout page. Revokes tokens and clears session storage.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/error">error</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/errorMiddleware">errorMiddleware</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/ErrorToast">ErrorToast</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/fireEvent">fireEvent</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/FormPropsContext">FormPropsContext</a></td><td>Side-channel context for the <code>useForm</code> configuration that the parent <code><Form></code> was created with.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/globalConstants">globalConstants</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/GuestMicroApp">GuestMicroApp</a></td><td>Component to load a guest microapp.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/history">history</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/httpClientProps">httpClientProps</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/logout">logout</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MASK_PIPES">MASK_PIPES</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MASK_TYPES">MASK_TYPES</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/memoryHistory">memoryHistory</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MicroApp"><del>MicroApp</del></a></td><td>Component to render a guest microapp</td></tr><tr><td><a class="" href="/app-sdk/api/variables/MicroIFrameApp"><del>MicroIFrameApp</del></a></td><td>Component to render a guest microapp in an iframe.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/NavigationPrompt">NavigationPrompt</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/NavigationPromptActions">NavigationPromptActions</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/removeSideEffect">removeSideEffect</a></td><td>Removes a side effect listener.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/resetUserIdleTime">resetUserIdleTime</a></td><td>Resets the user idle clock without calling the auth introspection API. Used by the HTTP request interceptor. Runs through <code>enforceIdleThresholds()</code> first, so it cannot dismiss the warning modal or extend after expiry.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/screen">screen</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/startSideEffect">startSideEffect</a></td><td>Starts a side effect listener. Used to listen for specific actions and execute side effects.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/Themes">Themes</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/updateBAEventParameters">updateBAEventParameters</a></td><td>Updates the business analytics event parameters with new values</td></tr><tr><td><a class="" href="/app-sdk/api/variables/useAppSelector">useAppSelector</a></td><td>React hook to select data from Redux store with type safety. Automatically typed to the app's RootState.</td></tr><tr><td><a class="" href="/app-sdk/api/variables/VisuallyHidden">VisuallyHidden</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/WaitMessage">WaitMessage</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/waitMessageAction">waitMessageAction</a></td><td>-</td></tr><tr><td><a class="" href="/app-sdk/api/variables/within">within</a></td><td>-</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_PN5i"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_wOUn" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_je1V"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/app-sdk/api/classes/Analytics"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Analytics</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_EnZ4 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#classes" class="table-of-contents__link toc-highlight">Classes</a></li><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a></li><li><a href="#functions" class="table-of-contents__link toc-highlight">Functions</a></li><li><a href="#references" class="table-of-contents__link toc-highlight">References</a><ul><li><a href="#cmicroapp" class="table-of-contents__link toc-highlight">CMicroApp</a></li></ul></li><li><a href="#type-aliases" class="table-of-contents__link toc-highlight">Type Aliases</a></li><li><a href="#variables" class="table-of-contents__link toc-highlight">Variables</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/app-sdk/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://icemortgagetechnology.slack.com/archives/C01M49EGP6Z" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_iOdY"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_iOdY"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 ICE.</div></div></div></footer></div>
|
|
28
28
|
</body>
|
|
29
29
|
</html>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">AppConfig | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/interfaces/AppConfig"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AppConfig | App SDK"><meta data-rh="true" name="description" content="Properties"><meta data-rh="true" property="og:description" content="Properties"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/interfaces/AppConfig"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/AppConfig" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/AppConfig" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"AppConfig","item":"https://pui.ice.com/app-sdk/api/interfaces/AppConfig"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">GuestProps\<AppObjects, AppEvents\> | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/interfaces/GuestProps"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="GuestProps\<AppObjects, AppEvents\> | App SDK"><meta data-rh="true" name="description" content="Extends"><meta data-rh="true" property="og:description" content="Extends"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/interfaces/GuestProps"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/GuestProps" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/GuestProps" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"GuestProps\\<AppObjects, AppEvents\\>","item":"https://pui.ice.com/app-sdk/api/interfaces/GuestProps"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">UseStateSelectorOptions\<Selected\> | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/interfaces/UseStateSelectorOptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="UseStateSelectorOptions\<Selected\> | App SDK"><meta data-rh="true" name="description" content="Type Parameters"><meta data-rh="true" property="og:description" content="Type Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/interfaces/UseStateSelectorOptions"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/UseStateSelectorOptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/interfaces/UseStateSelectorOptions" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"UseStateSelectorOptions\\<Selected\\>","item":"https://pui.ice.com/app-sdk/api/interfaces/UseStateSelectorOptions"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">AppDispatch | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/type-aliases/AppDispatch"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AppDispatch | App SDK"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/type-aliases/AppDispatch"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/AppDispatch" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/AppDispatch" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"AppDispatch","item":"https://pui.ice.com/app-sdk/api/type-aliases/AppDispatch"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">AppStore | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/type-aliases/AppStore"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AppStore | App SDK"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/type-aliases/AppStore"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/AppStore" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/AppStore" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"AppStore","item":"https://pui.ice.com/app-sdk/api/type-aliases/AppStore"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">Await\<T\> | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/type-aliases/Await"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Await\<T\> | App SDK"><meta data-rh="true" name="description" content="Type Parameters"><meta data-rh="true" property="og:description" content="Type Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/type-aliases/Await"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/Await" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/Await" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"Await\\<T\\>","item":"https://pui.ice.com/app-sdk/api/type-aliases/Await"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.2">
|
|
6
6
|
<title data-rh="true">EMUI\<AppObjects, AppEvents\> | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/type-aliases/EMUI"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="EMUI\<AppObjects, AppEvents\> | App SDK"><meta data-rh="true" name="description" content="Type Declaration"><meta data-rh="true" property="og:description" content="Type Declaration"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/type-aliases/EMUI"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/EMUI" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/type-aliases/EMUI" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"EMUI\\<AppObjects, AppEvents\\>","item":"https://pui.ice.com/app-sdk/api/type-aliases/EMUI"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.e2e89d4b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.9f7b9b59.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.1a5a08af.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|