@elliemae/pui-app-sdk 5.40.3 → 5.40.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.
Files changed (436) hide show
  1. package/demo/{6879.3434f1e9.iframe.bundle.js → 1080.92f6b67a.iframe.bundle.js} +480 -480
  2. package/demo/1080.92f6b67a.iframe.bundle.js.br +0 -0
  3. package/demo/1080.92f6b67a.iframe.bundle.js.gz +0 -0
  4. package/demo/docs/{6879.3434f1e9.iframe.bundle.js → 1080.92f6b67a.iframe.bundle.js} +480 -480
  5. package/demo/docs/1080.92f6b67a.iframe.bundle.js.br +0 -0
  6. package/demo/docs/1080.92f6b67a.iframe.bundle.js.gz +0 -0
  7. package/demo/docs/iframe.html +1 -1
  8. package/demo/docs/index.html +1 -1
  9. package/demo/docs/{main.f4b9fb997236ae69d894.manager.bundle.js → main.cfd2e2085f77fe383f8d.manager.bundle.js} +1 -1
  10. package/demo/docs/{main.f4b9fb997236ae69d894.manager.bundle.js.br → main.cfd2e2085f77fe383f8d.manager.bundle.js.br} +0 -0
  11. package/demo/docs/{main.f4b9fb997236ae69d894.manager.bundle.js.gz → main.cfd2e2085f77fe383f8d.manager.bundle.js.gz} +0 -0
  12. package/demo/docs/main.f92b110f.iframe.bundle.js +5 -0
  13. package/demo/docs/main.f92b110f.iframe.bundle.js.br +0 -0
  14. package/demo/docs/main.f92b110f.iframe.bundle.js.gz +0 -0
  15. package/demo/docs/project.json +1 -1
  16. package/demo/iframe.html +1 -1
  17. package/demo/index.html +1 -1
  18. package/demo/{main.f4b9fb997236ae69d894.manager.bundle.js → main.cfd2e2085f77fe383f8d.manager.bundle.js} +1 -1
  19. package/demo/{main.f4b9fb997236ae69d894.manager.bundle.js.br → main.cfd2e2085f77fe383f8d.manager.bundle.js.br} +0 -0
  20. package/demo/{main.f4b9fb997236ae69d894.manager.bundle.js.gz → main.cfd2e2085f77fe383f8d.manager.bundle.js.gz} +0 -0
  21. package/demo/main.f92b110f.iframe.bundle.js +5 -0
  22. package/demo/main.f92b110f.iframe.bundle.js.br +0 -0
  23. package/demo/main.f92b110f.iframe.bundle.js.gz +0 -0
  24. package/demo/project.json +1 -1
  25. package/dist/cjs/utils/micro-frontend/guest-host-context.js +47 -0
  26. package/dist/cjs/utils/micro-frontend/guest.js +4 -3
  27. package/dist/cjs/utils/micro-frontend/host.js +4 -3
  28. package/dist/cjs/utils/micro-frontend/index.js +4 -1
  29. package/dist/cjs/utils/micro-frontend/module-so.js +5 -1
  30. package/dist/cjs/utils/micro-frontend/tests/guest-test-utils.js +27 -0
  31. package/dist/cjs/view/guest-microapp.js +30 -8
  32. package/dist/cjs/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap +2 -2
  33. package/dist/esm/utils/micro-frontend/guest-host-context.js +27 -0
  34. package/dist/esm/utils/micro-frontend/guest.js +4 -3
  35. package/dist/esm/utils/micro-frontend/host.js +4 -3
  36. package/dist/esm/utils/micro-frontend/index.js +4 -1
  37. package/dist/esm/utils/micro-frontend/module-so.js +5 -1
  38. package/dist/esm/utils/micro-frontend/tests/guest-test-utils.js +7 -0
  39. package/dist/esm/view/guest-microapp.js +33 -8
  40. package/dist/esm/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap +2 -2
  41. package/dist/types/lib/utils/micro-frontend/guest-host-context.d.ts +40 -0
  42. package/dist/types/lib/utils/micro-frontend/guest.d.ts +2 -1
  43. package/dist/types/lib/utils/micro-frontend/host.d.ts +2 -1
  44. package/dist/types/lib/utils/micro-frontend/module-so.d.ts +7 -5
  45. package/dist/types/lib/utils/micro-frontend/tests/guest-host-context.test.d.ts +1 -0
  46. package/dist/types/lib/utils/micro-frontend/tests/guest-test-utils.d.ts +2 -0
  47. package/dist/types/lib/view/guest-microapp.d.ts +12 -1
  48. package/dist/types/tsconfig.tsbuildinfo +1 -1
  49. package/package.json +6 -6
  50. package/build/docs/404.html +0 -16
  51. package/build/docs/api/classes/Analytics/index.html +0 -270
  52. package/build/docs/api/classes/CMicroAppGuest/index.html +0 -261
  53. package/build/docs/api/classes/CMicroAppHost/index.html +0 -346
  54. package/build/docs/api/classes/ErrorBoundary/index.html +0 -354
  55. package/build/docs/api/classes/GuestModule/index.html +0 -148
  56. package/build/docs/api/functions/AppRoot/index.html +0 -27
  57. package/build/docs/api/functions/Autocomplete/index.html +0 -22
  58. package/build/docs/api/functions/CheckBox/index.html +0 -22
  59. package/build/docs/api/functions/ComboBox/index.html +0 -27
  60. package/build/docs/api/functions/ComboBoxV3/index.html +0 -22
  61. package/build/docs/api/functions/ConnectForm/index.html +0 -22
  62. package/build/docs/api/functions/DateInput/index.html +0 -22
  63. package/build/docs/api/functions/DatePicker/index.html +0 -27
  64. package/build/docs/api/functions/DateRangePicker/index.html +0 -22
  65. package/build/docs/api/functions/DateTimePicker/index.html +0 -22
  66. package/build/docs/api/functions/Form/index.html +0 -34
  67. package/build/docs/api/functions/FormItemLayout/index.html +0 -22
  68. package/build/docs/api/functions/FormLayoutBlockItem/index.html +0 -22
  69. package/build/docs/api/functions/FormSubmitButton/index.html +0 -22
  70. package/build/docs/api/functions/InputMask/index.html +0 -22
  71. package/build/docs/api/functions/InputText/index.html +0 -22
  72. package/build/docs/api/functions/LargeTextBox/index.html +0 -22
  73. package/build/docs/api/functions/MaskedInputText/index.html +0 -22
  74. package/build/docs/api/functions/Page/index.html +0 -22
  75. package/build/docs/api/functions/Radio/index.html +0 -22
  76. package/build/docs/api/functions/RadioGroup/index.html +0 -22
  77. package/build/docs/api/functions/RegisterService/index.html +0 -27
  78. package/build/docs/api/functions/RenderWithStateAddOns/index.html +0 -22
  79. package/build/docs/api/functions/RequireAuth/index.html +0 -28
  80. package/build/docs/api/functions/SessionTimeout/index.html +0 -19
  81. package/build/docs/api/functions/TextBox/index.html +0 -27
  82. package/build/docs/api/functions/Toggle/index.html +0 -22
  83. package/build/docs/api/functions/authSaga/index.html +0 -19
  84. package/build/docs/api/functions/authorize/index.html +0 -44
  85. package/build/docs/api/functions/buildModuleParams/index.html +0 -31
  86. package/build/docs/api/functions/cleanup/index.html +0 -20
  87. package/build/docs/api/functions/configureStore/index.html +0 -56
  88. package/build/docs/api/functions/createGuestModule/index.html +0 -39
  89. package/build/docs/api/functions/createManager/index.html +0 -41
  90. package/build/docs/api/functions/enableReactAppForHostIntegration/index.html +0 -22
  91. package/build/docs/api/functions/fetchHostAppData/index.html +0 -24
  92. package/build/docs/api/functions/fetchUserSettings/index.html +0 -22
  93. package/build/docs/api/functions/getApiActionCreator/index.html +0 -30
  94. package/build/docs/api/functions/getAppConfig/index.html +0 -19
  95. package/build/docs/api/functions/getAppConfigValue/index.html +0 -35
  96. package/build/docs/api/functions/getAuthHTTPClient/index.html +0 -38
  97. package/build/docs/api/functions/getAuthorizationHeader/index.html +0 -23
  98. package/build/docs/api/functions/getHTTPClient/index.html +0 -36
  99. package/build/docs/api/functions/getHostAppDataByKey/index.html +0 -27
  100. package/build/docs/api/functions/getLogger/index.html +0 -19
  101. package/build/docs/api/functions/getMicroFrontEndAppConfig/index.html +0 -23
  102. package/build/docs/api/functions/getNavigationLinks/index.html +0 -19
  103. package/build/docs/api/functions/getRedirectUrl/index.html +0 -19
  104. package/build/docs/api/functions/getSelectField/index.html +0 -33
  105. package/build/docs/api/functions/getStore/index.html +0 -23
  106. package/build/docs/api/functions/initServiceWorker/index.html +0 -22
  107. package/build/docs/api/functions/isCIBuild/index.html +0 -19
  108. package/build/docs/api/functions/isProd/index.html +0 -19
  109. package/build/docs/api/functions/isUserAuthorized/index.html +0 -23
  110. package/build/docs/api/functions/listenStorageEvents/index.html +0 -19
  111. package/build/docs/api/functions/loadAppConfig/index.html +0 -30
  112. package/build/docs/api/functions/loadable/index.html +0 -37
  113. package/build/docs/api/functions/login/index.html +0 -62
  114. package/build/docs/api/functions/notifyGuestUnloadComplete/index.html +0 -26
  115. package/build/docs/api/functions/onAuthorizationFailure/index.html +0 -28
  116. package/build/docs/api/functions/onGuestUnloadStart/index.html +0 -19
  117. package/build/docs/api/functions/redactPii/index.html +0 -32
  118. package/build/docs/api/functions/removeDoubleSlash/index.html +0 -22
  119. package/build/docs/api/functions/removeStorageEvents/index.html +0 -19
  120. package/build/docs/api/functions/render/index.html +0 -392
  121. package/build/docs/api/functions/renderHook/index.html +0 -37
  122. package/build/docs/api/functions/renderWithHostData/index.html +0 -22
  123. package/build/docs/api/functions/renderWithRedux/index.html +0 -392
  124. package/build/docs/api/functions/renderWithRouter/index.html +0 -392
  125. package/build/docs/api/functions/renderWithRouterRedux/index.html +0 -392
  126. package/build/docs/api/functions/sdkBaseQuery/index.html +0 -37
  127. package/build/docs/api/functions/sendBAEvent/index.html +0 -34
  128. package/build/docs/api/functions/sendMessageToHost/index.html +0 -24
  129. package/build/docs/api/functions/setAppConfig/index.html +0 -27
  130. package/build/docs/api/functions/setAppConfigValue/index.html +0 -35
  131. package/build/docs/api/functions/setHostAppData/index.html +0 -25
  132. package/build/docs/api/functions/setLoginParams/index.html +0 -29
  133. package/build/docs/api/functions/subscribeToResetSession/index.html +0 -28
  134. package/build/docs/api/functions/subscribeToSessionExpiry/index.html +0 -28
  135. package/build/docs/api/functions/subscribeToSessionExpiryWarning/index.html +0 -28
  136. package/build/docs/api/functions/trackActivity/index.html +0 -31
  137. package/build/docs/api/functions/useAppDispatch/index.html +0 -24
  138. package/build/docs/api/functions/useAppMiddleware/index.html +0 -25
  139. package/build/docs/api/functions/useInjectQuery/index.html +0 -35
  140. package/build/docs/api/functions/useInjectReducer/index.html +0 -31
  141. package/build/docs/api/functions/useInjectSaga/index.html +0 -33
  142. package/build/docs/api/functions/useInjectSideEffect/index.html +0 -25
  143. package/build/docs/api/functions/useMediaQueryList/index.html +0 -26
  144. package/build/docs/api/functions/useStateSelector/index.html +0 -38
  145. package/build/docs/api/functions/useStateSelectorShallow/index.html +0 -39
  146. package/build/docs/api/functions/waitFor/index.html +0 -27
  147. package/build/docs/api/functions/waitForElementToBeRemoved/index.html +0 -27
  148. package/build/docs/api/functions/withAppDecorator/index.html +0 -26
  149. package/build/docs/api/index.html +0 -29
  150. package/build/docs/api/interfaces/AppConfig/index.html +0 -46
  151. package/build/docs/api/interfaces/GuestProps/index.html +0 -86
  152. package/build/docs/api/interfaces/UseStateSelectorOptions/index.html +0 -25
  153. package/build/docs/api/type-aliases/AppDispatch/index.html +0 -17
  154. package/build/docs/api/type-aliases/AppStore/index.html +0 -17
  155. package/build/docs/api/type-aliases/Await/index.html +0 -20
  156. package/build/docs/api/type-aliases/EMUI/index.html +0 -62
  157. package/build/docs/api/type-aliases/HostOptions/index.html +0 -28
  158. package/build/docs/api/type-aliases/HostProvidedParams/index.html +0 -33
  159. package/build/docs/api/type-aliases/ModuleOverrides/index.html +0 -47
  160. package/build/docs/api/type-aliases/OnHostInitCallback/index.html +0 -22
  161. package/build/docs/api/type-aliases/OnInitCallback/index.html +0 -22
  162. package/build/docs/api/type-aliases/OnMountCallback/index.html +0 -22
  163. package/build/docs/api/type-aliases/OnUnMountCallback/index.html +0 -22
  164. package/build/docs/api/type-aliases/RootState/index.html +0 -17
  165. package/build/docs/api/type-aliases/SelectStateFieldFunction/index.html +0 -29
  166. package/build/docs/api/variables/ErrorToast/index.html +0 -17
  167. package/build/docs/api/variables/FormPropsContext/index.html +0 -24
  168. package/build/docs/api/variables/GuestMicroApp/index.html +0 -20
  169. package/build/docs/api/variables/MASK_PIPES/index.html +0 -17
  170. package/build/docs/api/variables/MASK_TYPES/index.html +0 -17
  171. package/build/docs/api/variables/MicroApp/index.html +0 -21
  172. package/build/docs/api/variables/MicroIFrameApp/index.html +0 -21
  173. package/build/docs/api/variables/NavigationPrompt/index.html +0 -17
  174. package/build/docs/api/variables/NavigationPromptActions/index.html +0 -22
  175. package/build/docs/api/variables/Themes/index.html +0 -22
  176. package/build/docs/api/variables/VisuallyHidden/index.html +0 -17
  177. package/build/docs/api/variables/WaitMessage/index.html +0 -17
  178. package/build/docs/api/variables/act/index.html +0 -20
  179. package/build/docs/api/variables/ariaLive/index.html +0 -17
  180. package/build/docs/api/variables/auth/index.html +0 -40
  181. package/build/docs/api/variables/authReducer/index.html +0 -17
  182. package/build/docs/api/variables/clearSideEffects/index.html +0 -21
  183. package/build/docs/api/variables/createSideEffect/index.html +0 -19
  184. package/build/docs/api/variables/decorators/index.html +0 -222
  185. package/build/docs/api/variables/endSession/index.html +0 -37
  186. package/build/docs/api/variables/error/index.html +0 -17
  187. package/build/docs/api/variables/errorMiddleware/index.html +0 -17
  188. package/build/docs/api/variables/fireEvent/index.html +0 -17
  189. package/build/docs/api/variables/globalConstants/index.html +0 -22
  190. package/build/docs/api/variables/history/index.html +0 -17
  191. package/build/docs/api/variables/httpClientProps/index.html +0 -17
  192. package/build/docs/api/variables/logout/index.html +0 -22
  193. package/build/docs/api/variables/memoryHistory/index.html +0 -17
  194. package/build/docs/api/variables/removeSideEffect/index.html +0 -20
  195. package/build/docs/api/variables/resetUserIdleTime/index.html +0 -23
  196. package/build/docs/api/variables/screen/index.html +0 -17
  197. package/build/docs/api/variables/startSideEffect/index.html +0 -21
  198. package/build/docs/api/variables/updateBAEventParameters/index.html +0 -27
  199. package/build/docs/api/variables/useAppSelector/index.html +0 -21
  200. package/build/docs/api/variables/waitMessageAction/index.html +0 -43
  201. package/build/docs/api/variables/within/index.html +0 -17
  202. package/build/docs/assets/css/styles.0fad824b.css +0 -1
  203. package/build/docs/assets/js/04ee7372.a9b3e0ad.js +0 -1
  204. package/build/docs/assets/js/05fd5745.f77a9872.js +0 -1
  205. package/build/docs/assets/js/075aa584.dde55d25.js +0 -1
  206. package/build/docs/assets/js/0a1bd0e5.3336afb7.js +0 -1
  207. package/build/docs/assets/js/0f302db7.690bba2c.js +0 -1
  208. package/build/docs/assets/js/10c70e6f.3a611c9f.js +0 -1
  209. package/build/docs/assets/js/110b6cba.2039a4be.js +0 -1
  210. package/build/docs/assets/js/1126.2b1e83b8.js +0 -1
  211. package/build/docs/assets/js/1127.ce24a599.js +0 -1
  212. package/build/docs/assets/js/1154937a.58ab70e0.js +0 -1
  213. package/build/docs/assets/js/1298.f98e394e.js +0 -1
  214. package/build/docs/assets/js/14efea89.c724a605.js +0 -1
  215. package/build/docs/assets/js/15f40f8f.62fbc501.js +0 -1
  216. package/build/docs/assets/js/1617.443ab77e.js +0 -1
  217. package/build/docs/assets/js/16427680.5a41da14.js +0 -1
  218. package/build/docs/assets/js/16fba083.0c978e4b.js +0 -1
  219. package/build/docs/assets/js/1700.bb38b1b9.js +0 -1
  220. package/build/docs/assets/js/17896441.87af09c7.js +0 -1
  221. package/build/docs/assets/js/1a5ba401.bdd09a56.js +0 -1
  222. package/build/docs/assets/js/1ad86f56.5c4d3ed7.js +0 -1
  223. package/build/docs/assets/js/1cc7c915.18a50af2.js +0 -1
  224. package/build/docs/assets/js/1dfec420.e8ed9238.js +0 -1
  225. package/build/docs/assets/js/1fcf59a8.501bb96b.js +0 -1
  226. package/build/docs/assets/js/2026.f4b8efbd.js +0 -1
  227. package/build/docs/assets/js/213.07804718.js +0 -1
  228. package/build/docs/assets/js/2297.998393a9.js +0 -1
  229. package/build/docs/assets/js/22c6ac39.38c10213.js +0 -1
  230. package/build/docs/assets/js/242.98ba961c.js +0 -1
  231. package/build/docs/assets/js/247.f91b8960.js +0 -1
  232. package/build/docs/assets/js/24b1c163.4390b04b.js +0 -1
  233. package/build/docs/assets/js/25ae0bf1.3ff15c6f.js +0 -1
  234. package/build/docs/assets/js/2673.1111af38.js +0 -1
  235. package/build/docs/assets/js/27c4a013.bceaff37.js +0 -1
  236. package/build/docs/assets/js/27c8b774.1ec1881a.js +0 -1
  237. package/build/docs/assets/js/2805.21b4fb8d.js +0 -1
  238. package/build/docs/assets/js/2b2c5b3b.41587ade.js +0 -1
  239. package/build/docs/assets/js/3072782a.825cd627.js +0 -1
  240. package/build/docs/assets/js/3204d46b.7af2b3bd.js +0 -1
  241. package/build/docs/assets/js/322ec2e7.529db700.js +0 -1
  242. package/build/docs/assets/js/336f5910.34c060aa.js +0 -1
  243. package/build/docs/assets/js/3395.f8117aa5.js +0 -1
  244. package/build/docs/assets/js/3499.2c20c6ff.js +0 -1
  245. package/build/docs/assets/js/3552.2d0559a3.js +0 -1
  246. package/build/docs/assets/js/365a2c17.6afbd7ba.js +0 -1
  247. package/build/docs/assets/js/379bbc32.cfc06360.js +0 -1
  248. package/build/docs/assets/js/3992.aa5529d1.js +0 -2
  249. package/build/docs/assets/js/3992.aa5529d1.js.LICENSE.txt +0 -1
  250. package/build/docs/assets/js/3accd241.850fb650.js +0 -1
  251. package/build/docs/assets/js/3b0e1261.9caf419d.js +0 -1
  252. package/build/docs/assets/js/3b333d5b.831324f6.js +0 -1
  253. package/build/docs/assets/js/3cb0b0a9.99866080.js +0 -1
  254. package/build/docs/assets/js/3cd01694.04367956.js +0 -1
  255. package/build/docs/assets/js/4069.77c5dcc9.js +0 -1
  256. package/build/docs/assets/js/4134.d6069e6e.js +0 -1
  257. package/build/docs/assets/js/413bfdf1.2e754bf4.js +0 -1
  258. package/build/docs/assets/js/41f4ce7f.8662231d.js +0 -1
  259. package/build/docs/assets/js/4257.60660403.js +0 -1
  260. package/build/docs/assets/js/46eb403d.e5123d24.js +0 -1
  261. package/build/docs/assets/js/4772.988b91f1.js +0 -1
  262. package/build/docs/assets/js/4780.8d49dc64.js +0 -1
  263. package/build/docs/assets/js/47f7a134.2369c86a.js +0 -1
  264. package/build/docs/assets/js/4884.48d16d5b.js +0 -1
  265. package/build/docs/assets/js/4acce17e.b84485e3.js +0 -1
  266. package/build/docs/assets/js/4b10ac31.ffdbb394.js +0 -1
  267. package/build/docs/assets/js/4eef183e.99934dfe.js +0 -1
  268. package/build/docs/assets/js/50ae2c89.ea85453c.js +0 -1
  269. package/build/docs/assets/js/50b500dc.b1dafbf4.js +0 -1
  270. package/build/docs/assets/js/5113883b.19fc9d2f.js +0 -1
  271. package/build/docs/assets/js/5196.dda420ed.js +0 -1
  272. package/build/docs/assets/js/51cd08ce.eedf6a77.js +0 -1
  273. package/build/docs/assets/js/5248.5442863c.js +0 -1
  274. package/build/docs/assets/js/533e434c.6a22f28d.js +0 -1
  275. package/build/docs/assets/js/53defe29.b34f5bfe.js +0 -1
  276. package/build/docs/assets/js/5428.28b1d8b6.js +0 -1
  277. package/build/docs/assets/js/54dea6f0.7b5fa5e6.js +0 -1
  278. package/build/docs/assets/js/550f7dc1.a569914a.js +0 -1
  279. package/build/docs/assets/js/5575829c.04c44eb2.js +0 -1
  280. package/build/docs/assets/js/58e12487.6e6066d3.js +0 -1
  281. package/build/docs/assets/js/59169cbb.2d2d02ce.js +0 -1
  282. package/build/docs/assets/js/5964.fbd55ce8.js +0 -1
  283. package/build/docs/assets/js/5968.7a565a4e.js +0 -1
  284. package/build/docs/assets/js/5c5cf8ae.cf6912f5.js +0 -1
  285. package/build/docs/assets/js/5ca2639d.8b06c9ea.js +0 -1
  286. package/build/docs/assets/js/5da011d0.872006f0.js +0 -1
  287. package/build/docs/assets/js/5e13701d.8a6b7fd6.js +0 -1
  288. package/build/docs/assets/js/5e7ee35c.01ca7414.js +0 -1
  289. package/build/docs/assets/js/5e8c322a.0391dec4.js +0 -1
  290. package/build/docs/assets/js/5e95c892.f11d5bd6.js +0 -1
  291. package/build/docs/assets/js/5ebc190f.49776b06.js +0 -1
  292. package/build/docs/assets/js/5f21eb71.536ccef3.js +0 -1
  293. package/build/docs/assets/js/60781fed.87f57230.js +0 -1
  294. package/build/docs/assets/js/61b0e64b.c86eca9e.js +0 -1
  295. package/build/docs/assets/js/61f3b5cc.197d138c.js +0 -1
  296. package/build/docs/assets/js/62e1e335.d54d1d6e.js +0 -1
  297. package/build/docs/assets/js/6486.776625d1.js +0 -1
  298. package/build/docs/assets/js/6611.481d87ff.js +0 -2
  299. package/build/docs/assets/js/6611.481d87ff.js.LICENSE.txt +0 -9
  300. package/build/docs/assets/js/6aac2d5c.95d7104d.js +0 -1
  301. package/build/docs/assets/js/6b345055.f4f6c3b9.js +0 -1
  302. package/build/docs/assets/js/6b7fcc15.290796d9.js +0 -1
  303. package/build/docs/assets/js/6ca90961.8833c635.js +0 -1
  304. package/build/docs/assets/js/6d1f0509.55213557.js +0 -1
  305. package/build/docs/assets/js/6daa33e8.c1c74588.js +0 -1
  306. package/build/docs/assets/js/7080.73a89c35.js +0 -1
  307. package/build/docs/assets/js/7201.26026979.js +0 -1
  308. package/build/docs/assets/js/7344.12628cac.js +0 -1
  309. package/build/docs/assets/js/749b3cb7.660b1c4b.js +0 -1
  310. package/build/docs/assets/js/7516.78c3385c.js +0 -1
  311. package/build/docs/assets/js/7525.69d857f8.js +0 -1
  312. package/build/docs/assets/js/7540.ee4aa270.js +0 -1
  313. package/build/docs/assets/js/78fde597.9598cb2a.js +0 -1
  314. package/build/docs/assets/js/7985.6aac4971.js +0 -1
  315. package/build/docs/assets/js/7b224b5a.d21317ac.js +0 -1
  316. package/build/docs/assets/js/7c822e85.3cc0a954.js +0 -1
  317. package/build/docs/assets/js/7cde3459.802fae28.js +0 -1
  318. package/build/docs/assets/js/7d256524.087a46e5.js +0 -1
  319. package/build/docs/assets/js/7d48b3e7.5d6ce912.js +0 -1
  320. package/build/docs/assets/js/80392bdc.dbd30f9e.js +0 -1
  321. package/build/docs/assets/js/8049.5b4457b0.js +0 -1
  322. package/build/docs/assets/js/805daf1e.305437dc.js +0 -1
  323. package/build/docs/assets/js/8152.32ad98ca.js +0 -1
  324. package/build/docs/assets/js/821.19f6a696.js +0 -1
  325. package/build/docs/assets/js/822e0178.3c0d623a.js +0 -1
  326. package/build/docs/assets/js/82894961.81f97aaf.js +0 -1
  327. package/build/docs/assets/js/8290.f0834113.js +0 -1
  328. package/build/docs/assets/js/8355.bcde11e0.js +0 -1
  329. package/build/docs/assets/js/8389.b3f6164d.js +0 -1
  330. package/build/docs/assets/js/8585.e50595e8.js +0 -1
  331. package/build/docs/assets/js/85dc4c9b.d835c54a.js +0 -1
  332. package/build/docs/assets/js/8788.c86aea45.js +0 -1
  333. package/build/docs/assets/js/88a4c043.ca8fd05b.js +0 -1
  334. package/build/docs/assets/js/90579cbd.0835e6a5.js +0 -1
  335. package/build/docs/assets/js/90bbfd1d.d0fd53f0.js +0 -1
  336. package/build/docs/assets/js/9178.f2e05b02.js +0 -1
  337. package/build/docs/assets/js/9210.b5a9980e.js +0 -1
  338. package/build/docs/assets/js/9354.77e86f51.js +0 -1
  339. package/build/docs/assets/js/936.275fbed5.js +0 -1
  340. package/build/docs/assets/js/9550cc1f.e19e7779.js +0 -1
  341. package/build/docs/assets/js/9574.c7203040.js +0 -1
  342. package/build/docs/assets/js/97.d2ed6ba9.js +0 -1
  343. package/build/docs/assets/js/9852.cf8f89a9.js +0 -1
  344. package/build/docs/assets/js/9953.90bfd954.js +0 -1
  345. package/build/docs/assets/js/999f4a99.31e9f0f9.js +0 -1
  346. package/build/docs/assets/js/99a35e8f.3cb224e6.js +0 -1
  347. package/build/docs/assets/js/9ab62f73.a44012b0.js +0 -1
  348. package/build/docs/assets/js/9ea6fe4d.ebd612bc.js +0 -1
  349. package/build/docs/assets/js/a09470d9.16bfeef9.js +0 -1
  350. package/build/docs/assets/js/a0eb976e.f6504d94.js +0 -1
  351. package/build/docs/assets/js/a17fb045.0c651699.js +0 -1
  352. package/build/docs/assets/js/a2537f00.c241e3f2.js +0 -1
  353. package/build/docs/assets/js/a29a6e44.58d6b878.js +0 -1
  354. package/build/docs/assets/js/a3ecf861.0f55d8fd.js +0 -1
  355. package/build/docs/assets/js/a48fd09c.50989621.js +0 -1
  356. package/build/docs/assets/js/a6c41565.0821af7d.js +0 -1
  357. package/build/docs/assets/js/a6c5c03c.0e69962a.js +0 -1
  358. package/build/docs/assets/js/a769954d.02ea4cc3.js +0 -1
  359. package/build/docs/assets/js/a7861986.e4d90417.js +0 -1
  360. package/build/docs/assets/js/a7bd4aaa.3faf623f.js +0 -1
  361. package/build/docs/assets/js/a8687130.681fc6b9.js +0 -1
  362. package/build/docs/assets/js/a94703ab.9865def5.js +0 -1
  363. package/build/docs/assets/js/a9ba6591.bcdf3f9d.js +0 -1
  364. package/build/docs/assets/js/ab05b3aa.63cf7d9f.js +0 -1
  365. package/build/docs/assets/js/aba21aa0.4d968e31.js +0 -1
  366. package/build/docs/assets/js/ac9d64ec.dd98824b.js +0 -1
  367. package/build/docs/assets/js/aeb9810c.f3c24439.js +0 -1
  368. package/build/docs/assets/js/b0125fa2.c7fba4da.js +0 -1
  369. package/build/docs/assets/js/b0ccf0d8.89a4a7e2.js +0 -1
  370. package/build/docs/assets/js/b1474780.0982f737.js +0 -1
  371. package/build/docs/assets/js/b2a255cc.df3fdd56.js +0 -1
  372. package/build/docs/assets/js/b31a5f55.9a4737ac.js +0 -1
  373. package/build/docs/assets/js/b4285021.67b039a1.js +0 -1
  374. package/build/docs/assets/js/b784b5bb.7d7bb82c.js +0 -1
  375. package/build/docs/assets/js/b8c1226b.a92653b3.js +0 -1
  376. package/build/docs/assets/js/b93b454c.f87b4896.js +0 -1
  377. package/build/docs/assets/js/bc717899.36b37795.js +0 -1
  378. package/build/docs/assets/js/bf1a96cc.8abf8470.js +0 -1
  379. package/build/docs/assets/js/c10ec81d.0dff1cac.js +0 -1
  380. package/build/docs/assets/js/c254daed.d6764cd8.js +0 -1
  381. package/build/docs/assets/js/c377a04b.a6a0a334.js +0 -1
  382. package/build/docs/assets/js/c52b5473.1a1069c1.js +0 -1
  383. package/build/docs/assets/js/c5e9787b.448cc7d9.js +0 -1
  384. package/build/docs/assets/js/c7710052.d061cfdd.js +0 -1
  385. package/build/docs/assets/js/c8a9fc86.daf30d50.js +0 -1
  386. package/build/docs/assets/js/c90572d4.42231642.js +0 -1
  387. package/build/docs/assets/js/cfad4bb4.edde6aa3.js +0 -1
  388. package/build/docs/assets/js/d071c513.a096e87e.js +0 -1
  389. package/build/docs/assets/js/d0fd4a71.1d53f49d.js +0 -1
  390. package/build/docs/assets/js/d1d7a857.424e14dc.js +0 -1
  391. package/build/docs/assets/js/d38c25bf.1430a667.js +0 -1
  392. package/build/docs/assets/js/d3d37933.d7f15fe8.js +0 -1
  393. package/build/docs/assets/js/d71e6c8a.f4306e16.js +0 -1
  394. package/build/docs/assets/js/d9084ecb.61eb0649.js +0 -1
  395. package/build/docs/assets/js/de3ee31a.0992aa16.js +0 -1
  396. package/build/docs/assets/js/e0db4c79.6fcade57.js +0 -1
  397. package/build/docs/assets/js/e4ad89b2.9ca87caa.js +0 -1
  398. package/build/docs/assets/js/e876cff6.7c7560ed.js +0 -1
  399. package/build/docs/assets/js/e917d7c9.b54a542b.js +0 -1
  400. package/build/docs/assets/js/e9f568e8.b96fc01f.js +0 -1
  401. package/build/docs/assets/js/ea5986e4.ff0e5037.js +0 -1
  402. package/build/docs/assets/js/eb84a108.be29052f.js +0 -1
  403. package/build/docs/assets/js/ed6a4585.c5d8bf90.js +0 -1
  404. package/build/docs/assets/js/f4180cff.dae060fd.js +0 -1
  405. package/build/docs/assets/js/f7084923.91b0c545.js +0 -1
  406. package/build/docs/assets/js/f72a372a.4118877c.js +0 -1
  407. package/build/docs/assets/js/f72c86d0.d74270de.js +0 -1
  408. package/build/docs/assets/js/f8fa0321.c4c3a620.js +0 -1
  409. package/build/docs/assets/js/fc7c782f.bc0ad1ab.js +0 -1
  410. package/build/docs/assets/js/fce396bf.9f7f818c.js +0 -1
  411. package/build/docs/assets/js/fdb0d9e1.d2893206.js +0 -1
  412. package/build/docs/assets/js/fed4ae4f.e788c07f.js +0 -1
  413. package/build/docs/assets/js/fefe9566.113c5960.js +0 -1
  414. package/build/docs/assets/js/ff0bf96e.e457283e.js +0 -1
  415. package/build/docs/assets/js/ff6d65a9.39317a08.js +0 -1
  416. package/build/docs/assets/js/main.7d445fc8.js +0 -2
  417. package/build/docs/assets/js/main.7d445fc8.js.LICENSE.txt +0 -51
  418. package/build/docs/assets/js/runtime~main.5c8a1e20.js +0 -1
  419. package/build/docs/img/favicon.ico +0 -0
  420. package/build/docs/img/logo.jpeg +0 -0
  421. package/build/docs/img/logo.svg +0 -22
  422. package/build/docs/img/readme.md +0 -1
  423. package/build/docs/index.html +0 -102
  424. package/build/docs/readme.md +0 -1
  425. package/build/docs/sitemap.xml +0 -1
  426. package/build/docs/usage-guide/index.html +0 -580
  427. package/demo/6879.3434f1e9.iframe.bundle.js.br +0 -0
  428. package/demo/6879.3434f1e9.iframe.bundle.js.gz +0 -0
  429. package/demo/docs/6879.3434f1e9.iframe.bundle.js.br +0 -0
  430. package/demo/docs/6879.3434f1e9.iframe.bundle.js.gz +0 -0
  431. package/demo/docs/main.703b0e4c.iframe.bundle.js +0 -5
  432. package/demo/docs/main.703b0e4c.iframe.bundle.js.br +0 -0
  433. package/demo/docs/main.703b0e4c.iframe.bundle.js.gz +0 -0
  434. package/demo/main.703b0e4c.iframe.bundle.js +0 -5
  435. package/demo/main.703b0e4c.iframe.bundle.js.br +0 -0
  436. package/demo/main.703b0e4c.iframe.bundle.js.gz +0 -0
@@ -1,29 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/index" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.10.1">
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.0fad824b.css">
7
- <script src="/app-sdk/assets/js/runtime~main.5c8a1e20.js" defer="defer"></script>
8
- <script src="/app-sdk/assets/js/main.7d445fc8.js" defer="defer"></script>
9
- </head>
10
- <body>
11
- <svg style="display: none;"><defs>
12
- <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
- </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_JAhZ" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/app-sdk/"><div class="navbar__logo"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--light_SZPQ"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--dark_komm"></div><b class="navbar__title text--truncate">App SDK</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_h793 colorModeToggle_v_2a"><button class="clean-btn toggleButton_luUl toggleButtonDisabled_cKAk" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM lightToggleIcon_kcXC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM darkToggleIcon_ZFgA"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM systemToggleIcon_v1mL"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_S02n"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_Zl5R"><div class="docsWrapper_ueFZ"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ODdz" type="button"></button><div class="docRoot_hEeJ"><aside class="theme-doc-sidebar-container docSidebarContainer_iMMY"><div class="sidebarViewport_qKht"><div class="sidebar_pQSv"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_rgip"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--active" aria-current="page" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_IX6H">App SDK API</span></a><button aria-label="Collapse sidebar category &#x27;App SDK API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_IX6H">classes</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_IX6H">functions</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="interfaces" class="categoryLinkLabel_IX6H">interfaces</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/type-aliases/AppDispatch"><span title="type-aliases" class="categoryLinkLabel_IX6H">type-aliases</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/variables/ErrorToast"><span title="variables" class="categoryLinkLabel_IX6H">variables</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/"><span title="Getting Started" class="linkLabel_Jzo_">Getting Started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/usage-guide"><span title="Usage Guide" class="linkLabel_Jzo_">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_Ww0q"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_nUXI"><div class="docItemContainer_Lld7"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z125" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/app-sdk/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_keIu"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">App SDK API</span></li></ul></nav><div class="tocCollapsible_iI5M theme-doc-toc-mobile tocMobile_IiaZ"><button type="button" class="clean-btn tocCollapsibleButton_IsfN">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>App SDK API</h1></header>
15
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="classes">Classes<a href="#classes" class="hash-link" aria-label="Direct link to Classes" title="Direct link to Classes" translate="no">​</a></h2>
16
- <table><thead><tr><th>Class</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/app-sdk/api/classes/Analytics">Analytics</a></td><td>Analytics scripting object that captures business analytics events and performance timing measurements, forwarding them to multiple destinations.</td></tr><tr><td><a class="" href="/app-sdk/api/classes/CMicroAppGuest">CMicroAppGuest</a></td><td>Micro-frontend guest application class (singleton). Manages communication between a guest micro-app and its host application. Supports both SSF (Shared Service Framework) and App Bridge communication methods.</td></tr><tr><td><a class="" href="/app-sdk/api/classes/CMicroAppHost"><del>CMicroAppHost</del></a></td><td>Micro-frontend host application class (singleton). Manages hosting and coordination of multiple micro-frontend guest applications. Provides shared services like navigation, theming, analytics, and state management.</td></tr><tr><td><a class="" href="/app-sdk/api/classes/ErrorBoundary">ErrorBoundary</a></td><td>React error boundary component that catches JavaScript errors in child components. Logs errors and displays a fallback UI instead of crashing the app.</td></tr><tr><td><a class="" href="/app-sdk/api/classes/GuestModule">GuestModule</a></td><td>Default IModule implementation backed by a static parameters object. Hosts can instantiate this directly or use the <a class="" href="/app-sdk/api/functions/createGuestModule">createGuestModule</a> factory for a terser API.</td></tr></tbody></table>
17
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" 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
- <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
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" 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 &quot;manager&quot; 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&#x27;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&#x27;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&#x27;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>
21
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" 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
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" 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
- <p>Renames and re-exports <a class="" href="/app-sdk/api/classes/CMicroAppGuest">CMicroAppGuest</a></p>
24
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" 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
- <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&#x27;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
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" 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&#x27;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>&lt;Form&gt;</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 time counter. Call this when user performs an action to extend their session.</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&#x27;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_CXW_"><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_lW2Z" 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_jQ0h"></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_HU9B 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_uxYp"><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_uxYp"><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
- </body>
29
- </html>
@@ -1,46 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/interfaces/AppConfig" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.10.1">
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.0fad824b.css">
7
- <script src="/app-sdk/assets/js/runtime~main.5c8a1e20.js" defer="defer"></script>
8
- <script src="/app-sdk/assets/js/main.7d445fc8.js" defer="defer"></script>
9
- </head>
10
- <body>
11
- <svg style="display: none;"><defs>
12
- <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
- </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_JAhZ" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/app-sdk/"><div class="navbar__logo"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--light_SZPQ"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--dark_komm"></div><b class="navbar__title text--truncate">App SDK</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_h793 colorModeToggle_v_2a"><button class="clean-btn toggleButton_luUl toggleButtonDisabled_cKAk" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM lightToggleIcon_kcXC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM darkToggleIcon_ZFgA"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM systemToggleIcon_v1mL"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_S02n"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_Zl5R"><div class="docsWrapper_ueFZ"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ODdz" type="button"></button><div class="docRoot_hEeJ"><aside class="theme-doc-sidebar-container docSidebarContainer_iMMY"><div class="sidebarViewport_qKht"><div class="sidebar_pQSv"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_rgip"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--active" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_IX6H">App SDK API</span></a><button aria-label="Collapse sidebar category &#x27;App SDK API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_IX6H">classes</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_IX6H">functions</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="interfaces" class="categoryLinkLabel_IX6H">interfaces</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="AppConfig" class="linkLabel_Jzo_">AppConfig</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/GuestProps"><span title="GuestProps\&lt;AppObjects, AppEvents\&gt;" class="linkLabel_Jzo_">GuestProps\&lt;AppObjects, AppEvents\&gt;</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/UseStateSelectorOptions"><span title="UseStateSelectorOptions\&lt;Selected\&gt;" class="linkLabel_Jzo_">UseStateSelectorOptions\&lt;Selected\&gt;</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/type-aliases/AppDispatch"><span title="type-aliases" class="categoryLinkLabel_IX6H">type-aliases</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/variables/ErrorToast"><span title="variables" class="categoryLinkLabel_IX6H">variables</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/"><span title="Getting Started" class="linkLabel_Jzo_">Getting Started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/usage-guide"><span title="Usage Guide" class="linkLabel_Jzo_">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_Ww0q"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_nUXI"><div class="docItemContainer_Lld7"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z125" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/app-sdk/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_keIu"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/app-sdk/api/"><span>App SDK API</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">interfaces</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">AppConfig</span></li></ul></nav><div class="tocCollapsible_iI5M theme-doc-toc-mobile tocMobile_IiaZ"><button type="button" class="clean-btn tocCollapsibleButton_IsfN">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>AppConfig</h1></header>
15
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" translate="no">​</a></h2>
16
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="activeenv">activeEnv<a href="#activeenv" class="hash-link" aria-label="Direct link to activeEnv" title="Direct link to activeEnv" translate="no">​</a></h3>
17
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">activeEnv</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
18
- <hr>
19
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="appid">appId<a href="#appid" class="hash-link" aria-label="Direct link to appId" title="Direct link to appId" translate="no">​</a></h3>
20
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
21
- <hr>
22
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="brand">brand?<a href="#brand" class="hash-link" aria-label="Direct link to brand?" title="Direct link to brand?" translate="no">​</a></h3>
23
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional brand</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
24
- <hr>
25
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="env">env<a href="#env" class="hash-link" aria-label="Direct link to env" title="Direct link to env" translate="no">​</a></h3>
26
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">env</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">key</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">]</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Env</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
27
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="index-signature">Index Signature<a href="#index-signature" class="hash-link" aria-label="Direct link to Index Signature" title="Direct link to Index Signature" translate="no">​</a></h4>
28
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">key</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">]</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Env</span><br></div></code></pre></div></div>
29
- <hr>
30
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="serviceendpoints">serviceEndpoints<a href="#serviceendpoints" class="hash-link" aria-label="Direct link to serviceEndpoints" title="Direct link to serviceEndpoints" translate="no">​</a></h3>
31
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">serviceEndpoints</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> ServiceEndpoints</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
32
- <hr>
33
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="sessiontimeoutinterval">sessionTimeoutInterval?<a href="#sessiontimeoutinterval" class="hash-link" aria-label="Direct link to sessionTimeoutInterval?" title="Direct link to sessionTimeoutInterval?" translate="no">​</a></h3>
34
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional sessionTimeoutInterval</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
35
- <hr>
36
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="sessiontimeoutwarninterval">sessionTimeoutWarnInterval?<a href="#sessiontimeoutwarninterval" class="hash-link" aria-label="Direct link to sessionTimeoutWarnInterval?" title="Direct link to sessionTimeoutWarnInterval?" translate="no">​</a></h3>
37
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional sessionTimeoutWarnInterval</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
38
- <hr>
39
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="useparenthistory">useParentHistory?<a href="#useparenthistory" class="hash-link" aria-label="Direct link to useParentHistory?" title="Direct link to useParentHistory?" translate="no">​</a></h3>
40
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional useParentHistory</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
41
- <p>Whether to use the parent history for navigation.
42
- If true, the app will use the history from the parent window.
43
- If false, it will use its own history.
44
- Defaults to true.</p></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_CXW_"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/AppConfig.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_lW2Z" 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_jQ0h"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/app-sdk/api/functions/withAppDecorator"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">withAppDecorator()</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/app-sdk/api/interfaces/GuestProps"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">GuestProps\&lt;AppObjects, AppEvents\&gt;</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_HU9B thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#activeenv" class="table-of-contents__link toc-highlight">activeEnv</a></li><li><a href="#appid" class="table-of-contents__link toc-highlight">appId</a></li><li><a href="#brand" class="table-of-contents__link toc-highlight">brand?</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">env</a></li><li><a href="#serviceendpoints" class="table-of-contents__link toc-highlight">serviceEndpoints</a></li><li><a href="#sessiontimeoutinterval" class="table-of-contents__link toc-highlight">sessionTimeoutInterval?</a></li><li><a href="#sessiontimeoutwarninterval" class="table-of-contents__link toc-highlight">sessionTimeoutWarnInterval?</a></li><li><a href="#useparenthistory" class="table-of-contents__link toc-highlight">useParentHistory?</a></li></ul></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_uxYp"><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_uxYp"><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>
45
- </body>
46
- </html>
@@ -1,86 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/interfaces/GuestProps" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.10.1">
6
- <title data-rh="true">GuestProps\&lt;AppObjects, AppEvents\&gt; | 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\&lt;AppObjects, AppEvents\&gt; | 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.0fad824b.css">
7
- <script src="/app-sdk/assets/js/runtime~main.5c8a1e20.js" defer="defer"></script>
8
- <script src="/app-sdk/assets/js/main.7d445fc8.js" defer="defer"></script>
9
- </head>
10
- <body>
11
- <svg style="display: none;"><defs>
12
- <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
- </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_JAhZ" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/app-sdk/"><div class="navbar__logo"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--light_SZPQ"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--dark_komm"></div><b class="navbar__title text--truncate">App SDK</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_h793 colorModeToggle_v_2a"><button class="clean-btn toggleButton_luUl toggleButtonDisabled_cKAk" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM lightToggleIcon_kcXC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM darkToggleIcon_ZFgA"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM systemToggleIcon_v1mL"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_S02n"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_Zl5R"><div class="docsWrapper_ueFZ"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ODdz" type="button"></button><div class="docRoot_hEeJ"><aside class="theme-doc-sidebar-container docSidebarContainer_iMMY"><div class="sidebarViewport_qKht"><div class="sidebar_pQSv"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_rgip"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--active" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_IX6H">App SDK API</span></a><button aria-label="Collapse sidebar category &#x27;App SDK API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_IX6H">classes</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_IX6H">functions</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="interfaces" class="categoryLinkLabel_IX6H">interfaces</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="AppConfig" class="linkLabel_Jzo_">AppConfig</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/app-sdk/api/interfaces/GuestProps"><span title="GuestProps\&lt;AppObjects, AppEvents\&gt;" class="linkLabel_Jzo_">GuestProps\&lt;AppObjects, AppEvents\&gt;</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/UseStateSelectorOptions"><span title="UseStateSelectorOptions\&lt;Selected\&gt;" class="linkLabel_Jzo_">UseStateSelectorOptions\&lt;Selected\&gt;</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/type-aliases/AppDispatch"><span title="type-aliases" class="categoryLinkLabel_IX6H">type-aliases</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/variables/ErrorToast"><span title="variables" class="categoryLinkLabel_IX6H">variables</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/"><span title="Getting Started" class="linkLabel_Jzo_">Getting Started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/usage-guide"><span title="Usage Guide" class="linkLabel_Jzo_">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_Ww0q"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_nUXI"><div class="docItemContainer_Lld7"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z125" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/app-sdk/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_keIu"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/app-sdk/api/"><span>App SDK API</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">interfaces</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">GuestProps\&lt;AppObjects, AppEvents\&gt;</span></li></ul></nav><div class="tocCollapsible_iI5M theme-doc-toc-mobile tocMobile_IiaZ"><button type="button" class="clean-btn tocCollapsibleButton_IsfN">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>GuestProps&lt;AppObjects, AppEvents&gt;</h1></header>
15
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="extends">Extends<a href="#extends" class="hash-link" aria-label="Direct link to Extends" title="Direct link to Extends" translate="no">​</a></h2>
16
- <ul>
17
- <li class=""><code>InitOptions</code>&lt;<code>AppObjects</code>, <code>AppEvents</code>&gt;</li>
18
- </ul>
19
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="type-parameters">Type Parameters<a href="#type-parameters" class="hash-link" aria-label="Direct link to Type Parameters" title="Direct link to Type Parameters" translate="no">​</a></h2>
20
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="appobjects">AppObjects<a href="#appobjects" class="hash-link" aria-label="Direct link to AppObjects" title="Direct link to AppObjects" translate="no">​</a></h3>
21
- <p><code>AppObjects</code> <em>extends</em> <code>ScriptingObjects</code> = <code>Partial</code>&lt;<code>ScriptingObjectTypes</code>&gt;</p>
22
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="appevents">AppEvents<a href="#appevents" class="hash-link" aria-label="Direct link to AppEvents" title="Direct link to AppEvents" translate="no">​</a></h3>
23
- <p><code>AppEvents</code> <em>extends</em> <code>EventListeners</code> = <code>Events</code></p>
24
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" translate="no">​</a></h2>
25
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="containerid">containerId<a href="#containerid" class="hash-link" aria-label="Direct link to containerId" title="Direct link to containerId" translate="no">​</a></h3>
26
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">containerId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
27
- <p>DOM element ID where the guest app should render. Defaults to
28
- DEFAULT_CONTAINER_ID and can be overridden by the host via module
29
- parameters or the MountOptions passed to <code>mount()</code>.</p>
30
- <hr>
31
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="history">history<a href="#history" class="hash-link" aria-label="Direct link to history" title="Direct link to history" translate="no">​</a></h3>
32
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">history</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> History</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
33
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="overrides">Overrides<a href="#overrides" class="hash-link" aria-label="Direct link to Overrides" title="Direct link to Overrides" translate="no">​</a></h4>
34
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">history</span><br></div></code></pre></div></div>
35
- <hr>
36
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="homeroute">homeRoute?<a href="#homeroute" class="hash-link" aria-label="Direct link to homeRoute?" title="Direct link to homeRoute?" translate="no">​</a></h3>
37
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional homeRoute</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
38
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from">Inherited from<a href="#inherited-from" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
39
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">homeRoute</span><br></div></code></pre></div></div>
40
- <hr>
41
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="host">host?<a href="#host" class="hash-link" aria-label="Direct link to host?" title="Direct link to host?" translate="no">​</a></h3>
42
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional host</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> IMicroAppHost</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">Partial</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">ScriptingObjectTypes</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Events</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> IMicroFEHost</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">AppObjects</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> AppEvents</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> SSFGuest</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">AppObjects</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> AppEvents</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
43
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-1">Inherited from<a href="#inherited-from-1" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
44
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">host</span><br></div></code></pre></div></div>
45
- <hr>
46
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="hostbreakpoint">hostBreakpoint?<a href="#hostbreakpoint" class="hash-link" aria-label="Direct link to hostBreakpoint?" title="Direct link to hostBreakpoint?" translate="no">​</a></h3>
47
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional hostBreakpoint</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">keyof</span><span class="token plain"> BreakPoints</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
48
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-2">Inherited from<a href="#inherited-from-2" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
49
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">hostBreakpoint</span><br></div></code></pre></div></div>
50
- <hr>
51
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="hostname">hostName?<a href="#hostname" class="hash-link" aria-label="Direct link to hostName?" title="Direct link to hostName?" translate="no">​</a></h3>
52
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional hostName</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
53
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-3">Inherited from<a href="#inherited-from-3" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
54
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">hostName</span><br></div></code></pre></div></div>
55
- <hr>
56
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="hosturl">hostUrl?<a href="#hosturl" class="hash-link" aria-label="Direct link to hostUrl?" title="Direct link to hostUrl?" translate="no">​</a></h3>
57
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional hostUrl</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
58
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-4">Inherited from<a href="#inherited-from-4" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
59
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">hostUrl</span><br></div></code></pre></div></div>
60
- <hr>
61
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="hostviewportsize">hostViewportSize?<a href="#hostviewportsize" class="hash-link" aria-label="Direct link to hostViewportSize?" title="Direct link to hostViewportSize?" translate="no">​</a></h3>
62
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional hostViewportSize</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> ViewportSize</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
63
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-5">Inherited from<a href="#inherited-from-5" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
64
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">hostViewportSize</span><br></div></code></pre></div></div>
65
- <hr>
66
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="initialroute">initialRoute?<a href="#initialroute" class="hash-link" aria-label="Direct link to initialRoute?" title="Direct link to initialRoute?" translate="no">​</a></h3>
67
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional initialRoute</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> To</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
68
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-6">Inherited from<a href="#inherited-from-6" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
69
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">initialRoute</span><br></div></code></pre></div></div>
70
- <hr>
71
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="manifestpath">manifestPath?<a href="#manifestpath" class="hash-link" aria-label="Direct link to manifestPath?" title="Direct link to manifestPath?" translate="no">​</a></h3>
72
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional manifestPath</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
73
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-7">Inherited from<a href="#inherited-from-7" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no">​</a></h4>
74
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">manifestPath</span><br></div></code></pre></div></div>
75
- <hr>
76
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="prevstate">prevState<a href="#prevstate" class="hash-link" aria-label="Direct link to prevState" title="Direct link to prevState" translate="no">​</a></h3>
77
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">prevState</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> JSONValue</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
78
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="overrides-1">Overrides<a href="#overrides-1" class="hash-link" aria-label="Direct link to Overrides" title="Direct link to Overrides" translate="no">​</a></h4>
79
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">prevState</span><br></div></code></pre></div></div>
80
- <hr>
81
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="theme">theme<a href="#theme" class="hash-link" aria-label="Direct link to theme" title="Direct link to theme" translate="no">​</a></h3>
82
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">theme</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DefaultTheme</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
83
- <h4 class="anchor anchorTargetStickyNavbar_LxAM" id="overrides-2">Overrides<a href="#overrides-2" class="hash-link" aria-label="Direct link to Overrides" title="Direct link to Overrides" translate="no">​</a></h4>
84
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">InitOptions</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">theme</span><br></div></code></pre></div></div></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_CXW_"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/GuestProps.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_lW2Z" 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_jQ0h"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/app-sdk/api/interfaces/AppConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">AppConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/app-sdk/api/interfaces/UseStateSelectorOptions"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">UseStateSelectorOptions\&lt;Selected\&gt;</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_HU9B thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#extends" class="table-of-contents__link toc-highlight">Extends</a></li><li><a href="#type-parameters" class="table-of-contents__link toc-highlight">Type Parameters</a><ul><li><a href="#appobjects" class="table-of-contents__link toc-highlight">AppObjects</a></li><li><a href="#appevents" class="table-of-contents__link toc-highlight">AppEvents</a></li></ul></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#containerid" class="table-of-contents__link toc-highlight">containerId</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">history</a></li><li><a href="#homeroute" class="table-of-contents__link toc-highlight">homeRoute?</a></li><li><a href="#host" class="table-of-contents__link toc-highlight">host?</a></li><li><a href="#hostbreakpoint" class="table-of-contents__link toc-highlight">hostBreakpoint?</a></li><li><a href="#hostname" class="table-of-contents__link toc-highlight">hostName?</a></li><li><a href="#hosturl" class="table-of-contents__link toc-highlight">hostUrl?</a></li><li><a href="#hostviewportsize" class="table-of-contents__link toc-highlight">hostViewportSize?</a></li><li><a href="#initialroute" class="table-of-contents__link toc-highlight">initialRoute?</a></li><li><a href="#manifestpath" class="table-of-contents__link toc-highlight">manifestPath?</a></li><li><a href="#prevstate" class="table-of-contents__link toc-highlight">prevState</a></li><li><a href="#theme" class="table-of-contents__link toc-highlight">theme</a></li></ul></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_uxYp"><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_uxYp"><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>
85
- </body>
86
- </html>
@@ -1,25 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/interfaces/UseStateSelectorOptions" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.10.1">
6
- <title data-rh="true">UseStateSelectorOptions\&lt;Selected\&gt; | 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\&lt;Selected\&gt; | 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.0fad824b.css">
7
- <script src="/app-sdk/assets/js/runtime~main.5c8a1e20.js" defer="defer"></script>
8
- <script src="/app-sdk/assets/js/main.7d445fc8.js" defer="defer"></script>
9
- </head>
10
- <body>
11
- <svg style="display: none;"><defs>
12
- <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
- </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_JAhZ" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/app-sdk/"><div class="navbar__logo"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--light_SZPQ"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--dark_komm"></div><b class="navbar__title text--truncate">App SDK</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_h793 colorModeToggle_v_2a"><button class="clean-btn toggleButton_luUl toggleButtonDisabled_cKAk" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM lightToggleIcon_kcXC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM darkToggleIcon_ZFgA"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_DcpM systemToggleIcon_v1mL"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_S02n"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_Zl5R"><div class="docsWrapper_ueFZ"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ODdz" type="button"></button><div class="docRoot_hEeJ"><aside class="theme-doc-sidebar-container docSidebarContainer_iMMY"><div class="sidebarViewport_qKht"><div class="sidebar_pQSv"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_rgip"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--active" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_IX6H">App SDK API</span></a><button aria-label="Collapse sidebar category &#x27;App SDK API&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_IX6H">classes</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_IX6H">functions</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="interfaces" class="categoryLinkLabel_IX6H">interfaces</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="AppConfig" class="linkLabel_Jzo_">AppConfig</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/interfaces/GuestProps"><span title="GuestProps\&lt;AppObjects, AppEvents\&gt;" class="linkLabel_Jzo_">GuestProps\&lt;AppObjects, AppEvents\&gt;</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/app-sdk/api/interfaces/UseStateSelectorOptions"><span title="UseStateSelectorOptions\&lt;Selected\&gt;" class="linkLabel_Jzo_">UseStateSelectorOptions\&lt;Selected\&gt;</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/type-aliases/AppDispatch"><span title="type-aliases" class="categoryLinkLabel_IX6H">type-aliases</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/variables/ErrorToast"><span title="variables" class="categoryLinkLabel_IX6H">variables</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/"><span title="Getting Started" class="linkLabel_Jzo_">Getting Started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/usage-guide"><span title="Usage Guide" class="linkLabel_Jzo_">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_Ww0q"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_nUXI"><div class="docItemContainer_Lld7"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z125" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/app-sdk/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_keIu"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/app-sdk/api/"><span>App SDK API</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">interfaces</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">UseStateSelectorOptions\&lt;Selected\&gt;</span></li></ul></nav><div class="tocCollapsible_iI5M theme-doc-toc-mobile tocMobile_IiaZ"><button type="button" class="clean-btn tocCollapsibleButton_IsfN">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>UseStateSelectorOptions&lt;Selected&gt;</h1></header>
15
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="type-parameters">Type Parameters<a href="#type-parameters" class="hash-link" aria-label="Direct link to Type Parameters" title="Direct link to Type Parameters" translate="no">​</a></h2>
16
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="selected">Selected<a href="#selected" class="hash-link" aria-label="Direct link to Selected" title="Direct link to Selected" translate="no">​</a></h3>
17
- <p><code>Selected</code> = <code>unknown</code></p>
18
- <h2 class="anchor anchorTargetStickyNavbar_LxAM" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" translate="no">​</a></h2>
19
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="defaultvalue">defaultValue?<a href="#defaultvalue" class="hash-link" aria-label="Direct link to defaultValue?" title="Direct link to defaultValue?" translate="no">​</a></h3>
20
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional defaultValue</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Selected </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> Selected</span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
21
- <hr>
22
- <h3 class="anchor anchorTargetStickyNavbar_LxAM" id="equalityfn">equalityFn?<a href="#equalityfn" class="hash-link" aria-label="Direct link to equalityFn?" title="Direct link to equalityFn?" translate="no">​</a></h3>
23
- <div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">optional equalityFn</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> EqualityFn</span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain">Selected</span><span class="token operator" style="color:#393A34">&gt;</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div></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_CXW_"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/UseStateSelectorOptions.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_lW2Z" 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_jQ0h"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/app-sdk/api/interfaces/GuestProps"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">GuestProps\&lt;AppObjects, AppEvents\&gt;</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/app-sdk/api/type-aliases/AppDispatch"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">AppDispatch</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_HU9B thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#type-parameters" class="table-of-contents__link toc-highlight">Type Parameters</a><ul><li><a href="#selected" class="table-of-contents__link toc-highlight">Selected</a></li></ul></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#defaultvalue" class="table-of-contents__link toc-highlight">defaultValue?</a></li><li><a href="#equalityfn" class="table-of-contents__link toc-highlight">equalityFn?</a></li></ul></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_uxYp"><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_uxYp"><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>
24
- </body>
25
- </html>