@elliemae/pui-app-sdk 5.40.3 → 5.40.4

package/build/docs/assets/js/999f4a99.31e9f0f9.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[6095],{8568(e,t,n){n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"api/functions/getStore","title":"getStore()","description":"Gets the global Redux store instance.","source":"@site/docs/api/functions/getStore.md","sourceDirName":"api/functions","slug":"/api/functions/getStore","permalink":"/app-sdk/api/functions/getStore","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getStore.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getSelectField()","permalink":"/app-sdk/api/functions/getSelectField"},"next":{"title":"initServiceWorker()","permalink":"/app-sdk/api/functions/initServiceWorker"}}');var s=n(6070),i=n(5589);const o={},c="getStore()",a={},l=[{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"getstore",children:"getStore()"})}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"function getStore(): unknown;\n"})}),"\n",(0,s.jsx)(t.p,{children:"Gets the global Redux store instance."}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"unknown"})}),"\n",(0,s.jsx)(t.p,{children:"The configured Redux store"}),"\n",(0,s.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-typescript",children:"const store = getStore();\nstore.dispatch(someAction());\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5589(e,t,n){n.d(t,{R:()=>o,x:()=>c});var r=n(758);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/99a35e8f.3cb224e6.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[3849],{4687(e,n,i){i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>p});const o=JSON.parse('{"id":"api/functions/loadAppConfig","title":"loadAppConfig()","description":"Loads the application configuration from a JSON file.","source":"@site/docs/api/functions/loadAppConfig.md","sourceDirName":"api/functions","slug":"/api/functions/loadAppConfig","permalink":"/app-sdk/api/functions/loadAppConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/loadAppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"listenStorageEvents()","permalink":"/app-sdk/api/functions/listenStorageEvents"},"next":{"title":"loadable()","permalink":"/app-sdk/api/functions/loadable"}}');var t=i(6070),a=i(5589);const s={},r="loadAppConfig()",l={},p=[{value:"Parameters",id:"parameters",level:2},{value:"configPath?",id:"configpath",level:3},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Example",id:"example",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"loadappconfig",children:"loadAppConfig()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function loadAppConfig(configPath?: string): Promise<void>;\n"})}),"\n",(0,t.jsx)(n.p,{children:"Loads the application configuration from a JSON file.\nAttempts to fetch from versioned path first, then falls back to unversioned path.\nMerges environment-specific configuration with base configuration."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"configpath",children:"configPath?"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"string"})," = ",(0,t.jsx)(n.code,{children:"..."})]}),"\n",(0,t.jsx)(n.p,{children:"Path to the directory containing app.config.json (defaults to asset path)"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"Error if config file is not found or contains invalid JSON"}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"// Load from default location\nawait loadAppConfig();\n\n// Load from custom path\nawait loadAppConfig('/custom/path');\n\n// After loading, access config values\nconst apiUrl = getAppConfigValue('serviceEndpoints.api');\n"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},5589(e,n,i){i.d(n,{R:()=>s,x:()=>r});var o=i(758);const t={},a=o.createContext(t);function s(e){const n=o.useContext(a);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/9ab62f73.a44012b0.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7715],{2917(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"api/functions/FormLayoutBlockItem","title":"FormLayoutBlockItem()","description":"Parameters","source":"@site/docs/api/functions/FormLayoutBlockItem.md","sourceDirName":"api/functions","slug":"/api/functions/FormLayoutBlockItem","permalink":"/app-sdk/api/functions/FormLayoutBlockItem","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/FormLayoutBlockItem.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"FormItemLayout()","permalink":"/app-sdk/api/functions/FormItemLayout"},"next":{"title":"FormSubmitButton()","permalink":"/app-sdk/api/functions/FormSubmitButton"}}');var o=n(6070),a=n(5589);const s={},i="FormLayoutBlockItem()",c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function m(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"formlayoutblockitem",children:"FormLayoutBlockItem()"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"function FormLayoutBlockItem(__namedParameters: Props): Element;\n"})}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(t.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Props"})}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Element"})})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}},5589(e,t,n){n.d(t,{R:()=>s,x:()=>i});var r=n(758);const o={},a=r.createContext(o);function s(e){const t=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/9ea6fe4d.ebd612bc.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8255],{4144(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/functions/getApiActionCreator","title":"getApiActionCreator()","description":"Parameters","source":"@site/docs/api/functions/getApiActionCreator.md","sourceDirName":"api/functions","slug":"/api/functions/getApiActionCreator","permalink":"/app-sdk/api/functions/getApiActionCreator","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getApiActionCreator.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"fetchUserSettings()","permalink":"/app-sdk/api/functions/fetchUserSettings"},"next":{"title":"getAppConfig()","permalink":"/app-sdk/api/functions/getAppConfig"}}');var r=t(6070),s=t(5589);const a={},o="getApiActionCreator()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"api",id:"api",level:3},{value:"Returns",id:"returns",level:2},{value:"Description",id:"description",level:2},{value:"Examples",id:"examples",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"getapiactioncreator",children:"getApiActionCreator()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getApiActionCreator(api: string): (operation: string) => {\n[key: string]: ActionCreatorWithoutPayload<`${string}/${string}`>;\n};\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"api",children:"api"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"API name for which Redux Action Creators are required"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:"Redux Action Creators util function"}),"\n",(0,r.jsxs)(n.p,{children:["(",(0,r.jsx)(n.code,{children:"operation"}),": ",(0,r.jsx)(n.code,{children:"string"}),") => {\n[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"ActionCreatorWithoutPayload"}),"<",(0,r.jsx)(n.code,{children:"`${string}/${string}`"}),">;\n}"]}),"\n",(0,r.jsx)(n.h2,{id:"description",children:"Description"}),"\n",(0,r.jsx)(n.p,{children:"Creates API Redux Action Creators"}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-javascript",children:"import { getApiActionCreator } from '@elliemae/pui-app-sdk';\n const loansActionCreator = getApiActionCreator('loans');\n\n export const loans = {\n   ...loansActionCreator('create'),\n   ...loansActionCreator('get'),\n   ...loansActionCreator('save'),\n };\n\n const loansSlice = createSlice({\n   name: 'loans',\n   initialState: [],\n   reducers: {\n     getSuccess: (state, { payload }) => {\n       state.push(...payload);\n     },\n     saveSuccess: (state, { payload }) => {\n       state.push(payload);\n     },\n   },\n });\n"})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},5589(e,n,t){t.d(n,{R:()=>a,x:()=>o});var i=t(758);const r={},s=i.createContext(r);function a(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a09470d9.16bfeef9.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[2399],{6390(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/functions/listenStorageEvents","title":"listenStorageEvents()","description":"Returns","source":"@site/docs/api/functions/listenStorageEvents.md","sourceDirName":"api/functions","slug":"/api/functions/listenStorageEvents","permalink":"/app-sdk/api/functions/listenStorageEvents","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/listenStorageEvents.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"isUserAuthorized()","permalink":"/app-sdk/api/functions/isUserAuthorized"},"next":{"title":"loadAppConfig()","permalink":"/app-sdk/api/functions/loadAppConfig"}}');var i=n(6070),r=n(5589);const o={},a="listenStorageEvents()",c={},l=[{value:"Returns",id:"returns",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"listenstorageevents",children:"listenStorageEvents()"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"function listenStorageEvents(): void;\n"})}),"\n",(0,i.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"void"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5589(e,t,n){n.d(t,{R:()=>o,x:()=>a});var s=n(758);const i={},r=s.createContext(i);function o(e){const t=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/a0eb976e.f6504d94.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[6802],{4338(e,n,t){t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/functions/trackActivity","title":"trackActivity()","description":"Starts tracking user activity for session management.","source":"@site/docs/api/functions/trackActivity.md","sourceDirName":"api/functions","slug":"/api/functions/trackActivity","permalink":"/app-sdk/api/functions/trackActivity","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/trackActivity.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"subscribeToSessionExpiryWarning()","permalink":"/app-sdk/api/functions/subscribeToSessionExpiryWarning"},"next":{"title":"useAppDispatch()","permalink":"/app-sdk/api/functions/useAppDispatch"}}');var c=t(6070),s=t(5589);const r={},a="trackActivity()",o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"element",id:"element",level:3},{value:"cb",id:"cb",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{children:(0,c.jsx)(n.h1,{id:"trackactivity",children:"trackActivity()"})}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-ts",children:"function trackActivity(element: Document | null, cb: (...args: unknown[]) => unknown): () => void;\n"})}),"\n",(0,c.jsx)(n.p,{children:"Starts tracking user activity for session management.\nMonitors user interactions on the specified element and invokes callback."}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsx)(n.h3,{id:"element",children:"element"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Document"})," | ",(0,c.jsx)(n.code,{children:"null"})]}),"\n",(0,c.jsx)(n.p,{children:"DOM element to track activity on (typically document)"}),"\n",(0,c.jsx)(n.h3,{id:"cb",children:"cb"}),"\n",(0,c.jsxs)(n.p,{children:["(...",(0,c.jsx)(n.code,{children:"args"}),": ",(0,c.jsx)(n.code,{children:"unknown"}),"[]) => ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n",(0,c.jsx)(n.p,{children:"Callback function to invoke on user activity"}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:"Cleanup function to stop tracking"}),"\n",(0,c.jsxs)(n.p,{children:["() => ",(0,c.jsx)(n.code,{children:"void"})]}),"\n",(0,c.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-typescript",children:"const cleanup = trackActivity(document, renewSession);\n\n// Later, stop tracking\ncleanup();\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},5589(e,n,t){t.d(n,{R:()=>r,x:()=>a});var i=t(758);const c={},s=i.createContext(c);function r(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a17fb045.0c651699.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[465],{9154(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>m,frontMatter:()=>s,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/functions/Form","title":"Form()","description":"Form component with integrated React Hook Form state management and validation.","source":"@site/docs/api/functions/Form.md","sourceDirName":"api/functions","slug":"/api/functions/Form","permalink":"/app-sdk/api/functions/Form","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/Form.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"DateTimePicker()","permalink":"/app-sdk/api/functions/DateTimePicker"},"next":{"title":"FormItemLayout()","permalink":"/app-sdk/api/functions/FormItemLayout"}}');var i=t(6070),o=t(5589);const s={},a="Form()",l={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"TFieldValues",id:"tfieldvalues",level:3},{value:"TContext",id:"tcontext",level:3},{value:"Parameters",id:"parameters",level:2},{value:"props",id:"props",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function c(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"form",children:"Form()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function Form<TFieldValues, TContext>(props: FormProps<TFieldValues, TContext>): Element;\n"})}),"\n",(0,i.jsx)(n.p,{children:"Form component with integrated React Hook Form state management and validation.\nProvides form context to all child form fields and handles submission."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"tfieldvalues",children:"TFieldValues"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"TFieldValues"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"FieldValues"})," = ",(0,i.jsx)(n.code,{children:"FieldValues"})]}),"\n",(0,i.jsx)(n.p,{children:"Type of form field values"}),"\n",(0,i.jsx)(n.h3,{id:"tcontext",children:"TContext"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"TContext"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.code,{children:"object"})," = ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Additional context type"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"props",children:"props"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"FormProps"}),"<",(0,i.jsx)(n.code,{children:"TFieldValues"}),", ",(0,i.jsx)(n.code,{children:"TContext"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"Form component props"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Element"})}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-tsx",children:"import { Form, TextBox, FormSubmitButton } from '@elliemae/pui-app-sdk';\n\nfunction MyForm() {\n  const handleSubmit = (data) => {\n    console.log('Form data:', data);\n  };\n\n  return (\n    <Form onSubmit={handleSubmit}>\n      <TextBox\n        name=\"email\"\n        label=\"Email\"\n        rules={{ required: 'Email is required' }}\n      />\n      <FormSubmitButton>Submit</FormSubmitButton>\n    </Form>\n  );\n}\n"})})]})}function m(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},5589(e,n,t){t.d(n,{R:()=>s,x:()=>a});var r=t(758);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a2537f00.c241e3f2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[4465],{7727(e,a,n){n.r(a),n.d(a,{assets:()=>d,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/variables/auth","title":"auth","description":"Type Declaration","source":"@site/docs/api/variables/auth.md","sourceDirName":"api/variables","slug":"/api/variables/auth","permalink":"/app-sdk/api/variables/auth","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/auth.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ariaLive","permalink":"/app-sdk/api/variables/ariaLive"},"next":{"title":"authReducer","permalink":"/app-sdk/api/variables/authReducer"}}');var s=n(6070),t=n(5589);const l={},i="auth",d={},o=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"login",id:"login",level:3},{value:"Parameters",id:"parameters",level:4},{value:"__namedParameters",id:"__namedparameters",level:5},{value:"Returns",id:"returns",level:4},{value:"payload",id:"payload",level:5},{value:"type",id:"type",level:5},{value:"logout",id:"logout",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"__namedParameters",id:"__namedparameters-1",level:5},{value:"Returns",id:"returns-1",level:4},{value:"payload",id:"payload-1",level:5},{value:"type",id:"type-1",level:5}];function p(e){const a={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(a.header,{children:(0,s.jsx)(a.h1,{id:"auth",children:"auth"})}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"const auth: {\n  login: (__namedParameters: LoginParms) => {\n     payload: LoginParms;\n     type: string;\n  };\n  logout: (__namedParameters: LogoutParams) => {\n     payload: LogoutParams;\n     type: string;\n  };\n};\n"})}),"\n",(0,s.jsx)(a.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,s.jsx)(a.h3,{id:"login",children:"login"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"login: (__namedParameters: LoginParms) => {\n  payload: LoginParms;\n  type: string;\n};\n"})}),"\n",(0,s.jsx)(a.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(a.h5,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,s.jsx)(a.p,{children:(0,s.jsx)(a.code,{children:"LoginParms"})}),"\n",(0,s.jsx)(a.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"{\n  payload: LoginParms;\n  type: string;\n}\n"})}),"\n",(0,s.jsx)(a.h5,{id:"payload",children:"payload"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"payload: LoginParms;\n"})}),"\n",(0,s.jsx)(a.h5,{id:"type",children:"type"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"type: string;\n"})}),"\n",(0,s.jsx)(a.h3,{id:"logout",children:"logout"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"logout: (__namedParameters: LogoutParams) => {\n  payload: LogoutParams;\n  type: string;\n};\n"})}),"\n",(0,s.jsx)(a.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(a.h5,{id:"__namedparameters-1",children:"__namedParameters"}),"\n",(0,s.jsx)(a.p,{children:(0,s.jsx)(a.code,{children:"LogoutParams"})}),"\n",(0,s.jsx)(a.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"{\n  payload: LogoutParams;\n  type: string;\n}\n"})}),"\n",(0,s.jsx)(a.h5,{id:"payload-1",children:"payload"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"payload: LogoutParams;\n"})}),"\n",(0,s.jsx)(a.h5,{id:"type-1",children:"type"}),"\n",(0,s.jsx)(a.pre,{children:(0,s.jsx)(a.code,{className:"language-ts",children:"type: string;\n"})})]})}function c(e={}){const{wrapper:a}={...(0,t.R)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5589(e,a,n){n.d(a,{R:()=>l,x:()=>i});var r=n(758);const s={},t=r.createContext(s);function l(e){const a=r.useContext(t);return r.useMemo(function(){return"function"==typeof e?e(a):{...a,...e}},[a,e])}function i(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),r.createElement(t.Provider,{value:a},e.children)}}}]);

package/build/docs/assets/js/a29a6e44.58d6b878.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1303],{8010(e,n,s){s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>p,default:()=>d,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/type-aliases/EMUI","title":"EMUI\\\\<AppObjects, AppEvents\\\\>","description":"Type Declaration","source":"@site/docs/api/type-aliases/EMUI.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/EMUI","permalink":"/app-sdk/api/type-aliases/EMUI","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/EMUI.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Await\\\\<T\\\\>","permalink":"/app-sdk/api/type-aliases/Await"},"next":{"title":"~~HostOptions~~","permalink":"/app-sdk/api/type-aliases/HostOptions"}}');var t=s(6070),o=s(5589);const l={},p="EMUI<AppObjects, AppEvents>",a={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"__host?",id:"__host",level:3},{value:"_ASSET_PATH",id:"_asset_path",level:3},{value:"_BASE_PATH",id:"_base_path",level:3},{value:"app?",id:"app",level:3},{value:"appId",id:"appid",level:3},{value:"getHost?",id:"gethost",level:3},{value:"Returns",id:"returns",level:4},{value:"logger?",id:"logger",level:3},{value:"loginParams",id:"loginparams",level:3},{value:"logRocket?",id:"logrocket",level:3},{value:"logRocketConfig?",id:"logrocketconfig",level:3},{value:"logRocketConfig.appId",id:"logrocketconfigappid",level:4},{value:"logRocketConfig.childDomains?",id:"logrocketconfigchilddomains",level:4},{value:"logRocketConfig.parentDomain?",id:"logrocketconfigparentdomain",level:4},{value:"logRocketConfig.rootHostname?",id:"logrocketconfigroothostname",level:4},{value:"MicroAppHost?",id:"microapphost",level:3},{value:"uuid",id:"uuid",level:3},{value:"version",id:"version",level:3},{value:"Type Parameters",id:"type-parameters",level:2},{value:"AppObjects",id:"appobjects",level:3},{value:"AppEvents",id:"appevents",level:3}];function r(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"emuiappobjects-appevents",children:"EMUI<AppObjects, AppEvents>"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"type EMUI<AppObjects, AppEvents> = {\n[key: string]: \n  | IMicroAppGuest<AppObjects, AppEvents>\n  | IMicroAppGuest<AppObjects, AppEvents>[];\n} & {\n  __host?: IMicroFEHost<AppObjects, AppEvents>;\n  _ASSET_PATH: string;\n  _BASE_PATH: string;\n  app?: IMicroAppGuest;\n  appId: string;\n  getHost?: () => \n     | IMicroFEHost<AppObjects, AppEvents>\n     | SSFGuest<AppObjects, AppEvents>\n     | IMicroAppHost\n    | null;\n  logger?: Logger;\n  loginParams: LoginParams;\n  logRocket?: typeof LogRocket;\n  logRocketConfig?: {\n     appId: string;\n     childDomains?: string[];\n     parentDomain?: string;\n     rootHostname?: string;\n  };\n  MicroAppHost?:   | IMicroFEHost<AppObjects, AppEvents>\n     | IMicroAppHost\n     | SSFGuest<AppObjects, AppEvents>;\n  uuid: string;\n  version: string;\n};\n"})}),"\n",(0,t.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,t.jsx)(n.h3,{id:"__host",children:"__host?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional __host?: IMicroFEHost<AppObjects, AppEvents>;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"_asset_path",children:"_ASSET_PATH"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"_ASSET_PATH: string;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"_base_path",children:"_BASE_PATH"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"_BASE_PATH: string;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"app",children:"app?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional app?: IMicroAppGuest;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"appid",children:"appId"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"appId: string;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"gethost",children:"getHost?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional getHost?: () => \n  | IMicroFEHost<AppObjects, AppEvents>\n  | SSFGuest<AppObjects, AppEvents>\n  | IMicroAppHost\n  | null;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:["| ",(0,t.jsx)(n.code,{children:"IMicroFEHost"}),"<",(0,t.jsx)(n.code,{children:"AppObjects"}),", ",(0,t.jsx)(n.code,{children:"AppEvents"}),">\n| ",(0,t.jsx)(n.code,{children:"SSFGuest"}),"<",(0,t.jsx)(n.code,{children:"AppObjects"}),", ",(0,t.jsx)(n.code,{children:"AppEvents"}),">\n| ",(0,t.jsx)(n.code,{children:"IMicroAppHost"}),"\n| ",(0,t.jsx)(n.code,{children:"null"})]}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional logger?: Logger;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"loginparams",children:"loginParams"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"loginParams: LoginParams;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"logrocket",children:"logRocket?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional logRocket?: typeof LogRocket;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"logrocketconfig",children:"logRocketConfig?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional logRocketConfig?: {\n  appId: string;\n  childDomains?: string[];\n  parentDomain?: string;\n  rootHostname?: string;\n};\n"})}),"\n",(0,t.jsx)(n.h4,{id:"logrocketconfigappid",children:"logRocketConfig.appId"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"appId: string;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"logrocketconfigchilddomains",children:"logRocketConfig.childDomains?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional childDomains?: string[];\n"})}),"\n",(0,t.jsx)(n.h4,{id:"logrocketconfigparentdomain",children:"logRocketConfig.parentDomain?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional parentDomain?: string;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"logrocketconfigroothostname",children:"logRocketConfig.rootHostname?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional rootHostname?: string;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"microapphost",children:"MicroAppHost?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional MicroAppHost?: \n  | IMicroFEHost<AppObjects, AppEvents>\n  | IMicroAppHost\n| SSFGuest<AppObjects, AppEvents>;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"uuid",children:"uuid"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"uuid: string;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"version: string;\n"})}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"AppObjects"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"AppEvents"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"EventListeners"})," = ",(0,t.jsx)(n.code,{children:"Events"})]})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(r,{...e})}):r(e)}},5589(e,n,s){s.d(n,{R:()=>l,x:()=>p});var i=s(758);const t={},o=i.createContext(t);function l(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function p(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a3ecf861.0f55d8fd.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1701],{8717(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>p});const r=JSON.parse('{"id":"api/functions/LargeTextBox","title":"LargeTextBox()","description":"Parameters","source":"@site/docs/api/functions/LargeTextBox.md","sourceDirName":"api/functions","slug":"/api/functions/LargeTextBox","permalink":"/app-sdk/api/functions/LargeTextBox","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/LargeTextBox.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"InputText()","permalink":"/app-sdk/api/functions/InputText"},"next":{"title":"MaskedInputText()","permalink":"/app-sdk/api/functions/MaskedInputText"}}');var a=n(6070),s=n(5589);const i={},o="LargeTextBox()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"largetextbox",children:"LargeTextBox()"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"function LargeTextBox(__namedParameters: LargeTextBoxProps): Element;\n"})}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"LargeTextBoxProps"})}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"Element"})})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},5589(e,t,n){n.d(t,{R:()=>i,x:()=>o});var r=n(758);const a={},s=r.createContext(a);function i(e){const t=r.useContext(s);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/a48fd09c.50989621.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[6526],{8742(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>t,toc:()=>p});const t=JSON.parse('{"id":"api/functions/setLoginParams","title":"setLoginParams()","description":"Sets login parameters for the authentication flow.","source":"@site/docs/api/functions/setLoginParams.md","sourceDirName":"api/functions","slug":"/api/functions/setLoginParams","permalink":"/app-sdk/api/functions/setLoginParams","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/setLoginParams.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setHostAppData()","permalink":"/app-sdk/api/functions/setHostAppData"},"next":{"title":"subscribeToResetSession()","permalink":"/app-sdk/api/functions/subscribeToResetSession"}}');var i=s(6070),r=s(5589);const a={},o="setLoginParams()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"setloginparams",children:"setLoginParams()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'function setLoginParams(params: Omit<LoginParams, "redirectUri"> & {\n  redirectUri?: string;\n}): void;\n'})}),"\n",(0,i.jsx)(n.p,{children:"Sets login parameters for the authentication flow.\nStores parameters in the global window object for use across the application."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Omit"}),"<",(0,i.jsx)(n.code,{children:"LoginParams"}),", ",(0,i.jsx)(n.code,{children:'"redirectUri"'}),"> & {\n",(0,i.jsx)(n.code,{children:"redirectUri?"}),": ",(0,i.jsx)(n.code,{children:"string"}),";\n}"]}),"\n",(0,i.jsx)(n.p,{children:"Login parameters"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"setLoginParams({\n  clientId: 'my-app',\n  scope: 'openid profile email'\n});\n"})})]})}function d(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},5589(e,n,s){s.d(n,{R:()=>a,x:()=>o});var t=s(758);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a6c41565.0821af7d.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[5126],{3134(e,n,i){i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"api/functions/login","title":"login()","description":"Initiates the login flow using OAuth/OIDC authorization code flow.","source":"@site/docs/api/functions/login.md","sourceDirName":"api/functions","slug":"/api/functions/login","permalink":"/app-sdk/api/functions/login","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/login.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"loadable()","permalink":"/app-sdk/api/functions/loadable"},"next":{"title":"notifyGuestUnloadComplete()","permalink":"/app-sdk/api/functions/notifyGuestUnloadComplete"}}');var r=i(6070),l=i(5589);const t={},o="login()",d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"clientId",id:"clientid",level:4},{value:"disableRememberMe?",id:"disablerememberme",level:4},{value:"instanceId?",id:"instanceid",level:4},{value:"isConsumerUser",id:"isconsumeruser",level:4},{value:"isSSO?",id:"issso",level:4},{value:"responseType",id:"responsetype",level:4},{value:"scope",id:"scope",level:4},{value:"siteId?",id:"siteid",level:4},{value:"useCompactIdpPage?",id:"usecompactidppage",level:4},{value:"userId?",id:"userid",level:4},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"login",children:"login()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function login(params: {\n  clientId: string;\n  disableRememberMe?: boolean;\n  instanceId?: number;\n  isConsumerUser: boolean;\n  isSSO?: boolean;\n  responseType: string;\n  scope: string;\n  siteId?: number;\n  useCompactIdpPage?: boolean;\n  userId?: string;\n}): Promise<{\n  authorized: boolean;\n}>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Initiates the login flow using OAuth/OIDC authorization code flow.\nIf authorization code is present in URL, completes the authorization.\nOtherwise, redirects to the identity provider's login page."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,r.jsx)(n.p,{children:"Login parameters"}),"\n",(0,r.jsx)(n.h4,{id:"clientid",children:"clientId"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"OAuth client ID"}),"\n",(0,r.jsx)(n.h4,{id:"disablerememberme",children:"disableRememberMe?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.p,{children:'(Optional) Whether to disable the\n"Remember Me" option.'}),"\n",(0,r.jsx)(n.h4,{id:"instanceid",children:"instanceId?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.p,{children:"(Optional) The instance identifier."}),"\n",(0,r.jsx)(n.h4,{id:"isconsumeruser",children:"isConsumerUser"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.p,{children:"Whether user is a consumer user"}),"\n",(0,r.jsx)(n.h4,{id:"issso",children:"isSSO?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.p,{children:"(Optional). Determines whether to use SSO or not."}),"\n",(0,r.jsx)(n.h4,{id:"responsetype",children:"responseType"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"OAuth response type (typically 'code')"}),"\n",(0,r.jsx)(n.h4,{id:"scope",children:"scope"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"OAuth scopes (e.g., 'openid profile email')"}),"\n",(0,r.jsx)(n.h4,{id:"siteid",children:"siteId?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.p,{children:"(Optional) The site identifier."}),"\n",(0,r.jsx)(n.h4,{id:"usecompactidppage",children:"useCompactIdpPage?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.p,{children:"(Optional). Determines whether to use a compact or\nfull IDP page."}),"\n",(0,r.jsx)(n.h4,{id:"userid",children:"userId?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"(Optional) The user identifier."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<{\n",(0,r.jsx)(n.code,{children:"authorized"}),": ",(0,r.jsx)(n.code,{children:"boolean"}),";\n}>"]}),"\n",(0,r.jsx)(n.p,{children:"Promise with authorization status"}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const result = await login({\n  clientId: 'my-app',\n  scope: 'openid profile',\n  responseType: 'code',\n  isConsumerUser: false\n});\nif (result.authorized) {\n  // User is now logged in\n}\n"})})]})}function p(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},5589(e,n,i){i.d(n,{R:()=>t,x:()=>o});var s=i(758);const r={},l=s.createContext(r);function t(e){const n=s.useContext(l);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a6c5c03c.0e69962a.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8737],{8584(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"api/functions/RequireAuth","title":"RequireAuth()","description":"A React component that ensures authentication for its children.","source":"@site/docs/api/functions/RequireAuth.md","sourceDirName":"api/functions","slug":"/api/functions/RequireAuth","permalink":"/app-sdk/api/functions/RequireAuth","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/RequireAuth.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"RenderWithStateAddOns()","permalink":"/app-sdk/api/functions/RenderWithStateAddOns"},"next":{"title":"SessionTimeout()","permalink":"/app-sdk/api/functions/SessionTimeout"}}');var r=t(6070),s=t(5589);const o={},a="RequireAuth()",c={},u=[{value:"Parameters",id:"parameters",level:2},{value:"children",id:"children",level:3},{value:"Returns",id:"returns",level:2}];function h(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"requireauth",children:"RequireAuth()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function RequireAuth(children: RequireAuthProps): Element;\n"})}),"\n",(0,r.jsx)(n.p,{children:"A React component that ensures authentication for its children."}),"\n",(0,r.jsx)(n.p,{children:"If the user is authorized, it renders the children within the AuthManager\ncontext. Otherwise, it renders the Login component to prompt for\nauthentication, passing relevant props."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"children",children:"children"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"RequireAuthProps"})}),"\n",(0,r.jsx)(n.p,{children:"The child components to render, which require\nauthentication."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Element"})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},5589(e,n,t){t.d(n,{R:()=>o,x:()=>a});var i=t(758);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a769954d.02ea4cc3.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[2290],{3311(e,s,n){n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>o,default:()=>p,frontMatter:()=>d,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/type-aliases/ModuleOverrides","title":"ModuleOverrides","description":"Optional method overrides the host can supply to customise","source":"@site/docs/api/type-aliases/ModuleOverrides.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/ModuleOverrides","permalink":"/app-sdk/api/type-aliases/ModuleOverrides","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/ModuleOverrides.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"HostProvidedParams","permalink":"/app-sdk/api/type-aliases/HostProvidedParams"},"next":{"title":"OnHostInitCallback","permalink":"/app-sdk/api/type-aliases/OnHostInitCallback"}}');var r=n(6070),l=n(5589);const d={},o="ModuleOverrides",t={},a=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"getCapabilities?",id:"getcapabilities",level:3},{value:"Returns",id:"returns",level:4},{value:"log?",id:"log",level:3},{value:"Parameters",id:"parameters",level:4},{value:"message",id:"message",level:5},{value:"logLevel",id:"loglevel",level:5},{value:"Returns",id:"returns-1",level:4},{value:"unload?",id:"unload",level:3},{value:"Returns",id:"returns-2",level:4}];function c(e){const s={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"moduleoverrides",children:"ModuleOverrides"})}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"type ModuleOverrides = {\n[method: string]: ((...args: any[]) => any) | undefined;\n  getCapabilities?: () => Promise<Record<string, unknown>>;\n  log?: (message: LogMessage | string, logLevel: keyof typeof LogLevels) => Promise<void>;\n  unload?: () => Promise<void>;\n};\n"})}),"\n",(0,r.jsx)(s.p,{children:"Optional method overrides the host can supply to customise\nthe module scripting object beyond the defaults."}),"\n",(0,r.jsxs)(s.p,{children:["Typed keys shadow the corresponding ",(0,r.jsx)(s.a,{href:"/app-sdk/api/classes/GuestModule",children:"GuestModule"})," methods.\nThe index signature allows adding host-specific methods that the\nguest can discover through the scripting object protocol."]}),"\n",(0,r.jsx)(s.p,{children:"Overrides are applied via Object.assign so they become own\nenumerable properties on the instance \u2014 required for SSF's\n_toJSON discovery (for\u2026in enumeration)."}),"\n",(0,r.jsx)(s.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"[method: string]: ((...args: any[]) => any) | undefined\n"})}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"getcapabilities",children:"getCapabilities?"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"optional getCapabilities?: () => Promise<Record<string, unknown>>;\n"})}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"unknown"}),">>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"log",children:"log?"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"optional log?: (message: LogMessage | string, logLevel: keyof typeof LogLevels) => Promise<void>;\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(s.h5,{id:"message",children:"message"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"LogMessage"})," | ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h5,{id:"loglevel",children:"logLevel"}),"\n",(0,r.jsxs)(s.p,{children:["keyof ",(0,r.jsx)(s.em,{children:"typeof"})," ",(0,r.jsx)(s.code,{children:"LogLevels"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"unload",children:"unload?"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"optional unload?: () => Promise<void>;\n"})}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]})]})}function p(e={}){const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},5589(e,s,n){n.d(s,{R:()=>d,x:()=>o});var i=n(758);const r={},l=i.createContext(r);function d(e){const s=i.useContext(l);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/a7861986.e4d90417.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1973],{9364(e,n,t){t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>p});const a=JSON.parse('{"id":"api/type-aliases/OnUnMountCallback","title":"OnUnMountCallback","description":"Parameters","source":"@site/docs/api/type-aliases/OnUnMountCallback.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/OnUnMountCallback","permalink":"/app-sdk/api/type-aliases/OnUnMountCallback","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/OnUnMountCallback.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"OnMountCallback","permalink":"/app-sdk/api/type-aliases/OnMountCallback"},"next":{"title":"RootState","permalink":"/app-sdk/api/type-aliases/RootState"}}');var s=t(6070),l=t(5589);const i={},o="OnUnMountCallback",r={},p=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"Returns",id:"returns",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"onunmountcallback",children:"OnUnMountCallback"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"type OnUnMountCallback = (options: MountOptions) => JSONValue;\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"MountOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"JSONValue"})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},5589(e,n,t){t.d(n,{R:()=>i,x:()=>o});var a=t(758);const s={},l=a.createContext(s);function i(e){const n=a.useContext(l);return a.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(l.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/a7bd4aaa.3faf623f.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[4717],{4237(n,e,s){s.r(e),s.d(e,{default:()=>d});s(758);var r=s(6194);function o(n,e){return`docs-${n}-${e}`}var i=s(2166),t=s(1977),a=s(8924),l=s(6070);function c(n){const{version:e}=n;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(a.A,{version:e.version,tag:o(e.pluginId,e.version)}),(0,l.jsx)(r.be,{children:e.noIndex&&(0,l.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function u(n){const{version:e,route:s}=n;return(0,l.jsx)(r.e3,{className:e.className,children:(0,l.jsx)(i.n,{version:e,children:(0,t.v)(s.routes)})})}function d(n){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(c,{...n}),(0,l.jsx)(u,{...n})]})}}}]);

package/build/docs/assets/js/a8687130.681fc6b9.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7651],{9212(e,s,n){n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/functions/sendMessageToHost","title":"sendMessageToHost()","description":"Parameters","source":"@site/docs/api/functions/sendMessageToHost.md","sourceDirName":"api/functions","slug":"/api/functions/sendMessageToHost","permalink":"/app-sdk/api/functions/sendMessageToHost","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/sendMessageToHost.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~sendBAEvent()~~","permalink":"/app-sdk/api/functions/sendBAEvent"},"next":{"title":"setAppConfig()","permalink":"/app-sdk/api/functions/setAppConfig"}}');var r=n(6070),o=n(5589);const i={},a="sendMessageToHost()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"message",id:"message",level:3},{value:"hostedAppUrl?",id:"hostedappurl",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const s={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"sendmessagetohost",children:"sendMessageToHost()"})}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"function sendMessageToHost(message: MessageArgs, hostedAppUrl?: string): void;\n"})}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(s.h3,{id:"message",children:"message"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"MessageArgs"})}),"\n",(0,r.jsx)(s.h3,{id:"hostedappurl",children:"hostedAppUrl?"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"string"})," = ",(0,r.jsx)(s.code,{children:"document.referrer"})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"void"})})]})}function l(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},5589(e,s,n){n.d(s,{R:()=>i,x:()=>a});var t=n(758);const r={},o=t.createContext(r);function i(e){const s=t.useContext(o);return t.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/a94703ab.9865def5.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9048],{7165(e,t,n){n.r(t),n.d(t,{default:()=>Se});var a=n(758),i=n(3526),s=n(6194),o=n(4157),l=n(818),r=n(806),c=n(8114),d=n(4886),u=n(7144);const m="backToTopButton_ODdz",b="backToTopButtonShow_y5Pe";var h=n(6070);function p(){const{shown:e,scrollToTop:t}=function({threshold:e}){const[t,n]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:o}=(0,d.gk)();return(0,d.Mq)(({scrollY:t},a)=>{const s=a?.scrollY;s&&(i.current?i.current=!1:t>=s?(o(),n(!1)):t<e?n(!1):t+window.innerHeight<document.documentElement.scrollHeight&&n(!0))}),(0,u.$)(e=>{e.location.hash&&(i.current=!0,n(!1))}),{shown:t,scrollToTop:()=>s(0)}}({threshold:300});return(0,h.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,i.A)("clean-btn",o.G.common.backToTopButton,m,e&&b),type:"button",onClick:t})}var x=n(6843),f=n(5557),j=n(3527),_=n(540),g=n(278);function v(e){return(0,h.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,h.jsxs)("g",{fill:"#7a7a7a",children:[(0,h.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,h.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const A="collapseSidebarButton_KR0Z",C="collapseSidebarButtonIcon_B6b8";function k({onClick:e}){return(0,h.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,i.A)("button button--secondary button--outline",A),onClick:e,children:(0,h.jsx)(v,{className:C})})}var S=n(7691),N=n(358);const T=Symbol("EmptyContext"),I=a.createContext(T);function y({children:e}){const[t,n]=(0,a.useState)(null),i=(0,a.useMemo)(()=>({expandedItem:t,setExpandedItem:n}),[t]);return(0,h.jsx)(I.Provider,{value:i,children:e})}var L=n(1464),w=n(3603),E=n(2052),B=n(4949),M=n(1100),H=n(9404);const P="menuExternalLink_viBA",G="linkLabel_Jzo_";function D({label:e}){return(0,h.jsx)("span",{title:e,className:G,children:e})}function R({item:e,onItemClick:t,activePath:n,level:a,index:s,...r}){const{href:c,label:d,className:u,autoAddBaseUrl:m}=e,b=(0,l.w8)(e,n),p=(0,M.A)(c);return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(a),"menu__list-item",u),children:(0,h.jsxs)(E.A,{className:(0,i.A)("menu__link",!p&&P,{"menu__link--active":b}),autoAddBaseUrl:m,"aria-current":b?"page":void 0,to:c,...p&&{onClick:t?()=>t(e):void 0},...r,children:[(0,h.jsx)(D,{label:d}),!p&&(0,h.jsx)(H.A,{})]})},d)}const W="categoryLink_nibH",F="categoryLinkLabel_IX6H";function Z({collapsed:e,categoryLabel:t,onClick:n}){return(0,h.jsx)("button",{"aria-label":e?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:t}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:t}),"aria-expanded":!e,type:"button",className:"clean-btn menu__caret",onClick:n})}function z({label:e}){return(0,h.jsx)("span",{title:e,className:F,children:e})}function U(e){return 0===(0,l.Y)(e.item.items,e.activePath).length?(0,h.jsx)(V,{...e}):(0,h.jsx)(Y,{...e})}function V({item:e,...t}){if("string"!=typeof e.href)return null;const{type:n,collapsed:a,collapsible:i,items:s,linkUnlisted:o,...l}=e,r={type:"link",...l};return(0,h.jsx)(R,{item:r,...t})}function Y({item:e,onItemClick:t,activePath:n,level:s,index:r,...c}){const{items:d,label:u,collapsible:m,className:b,href:p}=e,{docs:{sidebar:{autoCollapseCategories:x}}}=(0,_.p)(),f=function(e){const t=(0,B.A)();return(0,a.useMemo)(()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0,[e,t])}(e),j=(0,l.w8)(e,n),g=(0,w.ys)(p,n),{collapsed:v,setCollapsed:A}=(0,L.u)({initialState:()=>!!m&&(!j&&e.collapsed)}),{expandedItem:C,setExpandedItem:k}=function(){const e=(0,a.useContext)(I);if(e===T)throw new N.dV("DocSidebarItemsExpandedStateProvider");return e}(),S=(e=!v)=>{k(e?null:r),A(e)};!function({isActive:e,collapsed:t,updateCollapsed:n,activePath:i}){const s=(0,N.ZC)(e),o=(0,N.ZC)(i);(0,a.useEffect)(()=>{(e&&!s||e&&s&&i!==o)&&t&&n(!1)},[e,s,t,n,i,o])}({isActive:j,collapsed:v,updateCollapsed:S,activePath:n}),(0,a.useEffect)(()=>{m&&null!=C&&C!==r&&x&&A(!0)},[m,C,r,A,x]);return(0,h.jsxs)("li",{className:(0,i.A)(o.G.docs.docSidebarItemCategory,o.G.docs.docSidebarItemCategoryLevel(s),"menu__list-item",{"menu__list-item--collapsed":v},b),children:[(0,h.jsxs)("div",{className:(0,i.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g}),children:[(0,h.jsx)(E.A,{className:(0,i.A)(W,"menu__link",{"menu__link--sublist":m,"menu__link--sublist-caret":!p&&m,"menu__link--active":j}),onClick:n=>{t?.(e),m&&(p?g?(n.preventDefault(),S()):S(!1):(n.preventDefault(),S()))},"aria-current":g?"page":void 0,role:m&&!p?"button":void 0,"aria-expanded":m&&!p?!v:void 0,href:m?f??"#":f,...c,children:(0,h.jsx)(z,{label:u})}),p&&m&&(0,h.jsx)(Z,{collapsed:v,categoryLabel:u,onClick:e=>{e.preventDefault(),S()}})]}),(0,h.jsx)(L.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:v,children:(0,h.jsx)(X,{items:d,tabIndex:v?-1:0,onItemClick:t,activePath:n,level:s+1})})]})}const q="menuHtmlItem_SZFj";function O({item:e,level:t,index:n}){const{value:a,defaultStyle:s,className:l}=e;return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(t),s&&[q,"menu__list-item"],l),dangerouslySetInnerHTML:{__html:a}},n)}function J({item:e,...t}){switch(e.type){case"category":return(0,h.jsx)(U,{item:e,...t});case"html":return(0,h.jsx)(O,{item:e,...t});default:return(0,h.jsx)(R,{item:e,...t})}}function K({items:e,...t}){const n=(0,l.Y)(e,t.activePath);return(0,h.jsx)(y,{children:n.map((e,n)=>(0,h.jsx)(J,{item:e,index:n,...t},n))})}const X=(0,a.memo)(K),Q="menu_rgip",$="menuWithAnnouncementBar_s4rk";function ee({path:e,sidebar:t,className:n}){const s=function(){const{isActive:e}=(0,S.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)(({scrollY:t})=>{e&&n(0===t)},[e]),e&&t}();return(0,h.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,i.A)("menu thin-scrollbar",Q,s&&$,n),children:(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(X,{items:t,activePath:e,level:1})})})}const te="sidebar_pQSv",ne="sidebarWithHideableNavbar_J2dL",ae="sidebarHidden_bZaf",ie="sidebarLogo_Zbug";function se({path:e,sidebar:t,onCollapse:n,isHidden:a}){const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:o}}}=(0,_.p)();return(0,h.jsxs)("div",{className:(0,i.A)(te,s&&ne,a&&ae),children:[s&&(0,h.jsx)(g.A,{tabIndex:-1,className:ie}),(0,h.jsx)(ee,{path:e,sidebar:t}),o&&(0,h.jsx)(k,{onClick:n})]})}const oe=a.memo(se);var le=n(3894),re=n(8363);const ce=({sidebar:e,path:t})=>{const n=(0,re.M)();return(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(X,{items:e,activePath:t,onItemClick:e=>{"category"===e.type&&e.href&&n.toggle(),"link"===e.type&&n.toggle()},level:1})})};function de(e){return(0,h.jsx)(le.GX,{component:ce,props:e})}const ue=a.memo(de);function me(e){const t=(0,j.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,h.jsxs)(h.Fragment,{children:[n&&(0,h.jsx)(oe,{...e}),a&&(0,h.jsx)(ue,{...e})]})}const be="expandButton_tdlP",he="expandButtonIcon_OsPF";function pe({toggleSidebar:e}){return(0,h.jsx)("div",{className:be,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:e,onClick:e,children:(0,h.jsx)(v,{className:he})})}const xe={docSidebarContainer:"docSidebarContainer_iMMY",docSidebarContainerHidden:"docSidebarContainerHidden_QX40",sidebarViewport:"sidebarViewport_qKht"};function fe({children:e}){const t=(0,r.t)();return(0,h.jsx)(a.Fragment,{children:e},t?.name??"noSidebar")}function je({sidebar:e,hiddenSidebarContainer:t,setHiddenSidebarContainer:n}){const{pathname:s}=(0,f.zy)(),[l,r]=(0,a.useState)(!1),c=(0,a.useCallback)(()=>{l&&r(!1),!l&&(0,x.O)()&&r(!0),n(e=>!e)},[n,l]);return(0,h.jsx)("aside",{className:(0,i.A)(o.G.docs.docSidebarContainer,xe.docSidebarContainer,t&&xe.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(xe.docSidebarContainer)&&t&&r(!0)},children:(0,h.jsx)(fe,{children:(0,h.jsxs)("div",{className:(0,i.A)(xe.sidebarViewport,l&&xe.sidebarViewportHidden),children:[(0,h.jsx)(me,{sidebar:e,path:s,onCollapse:c,isHidden:l}),l&&(0,h.jsx)(pe,{toggleSidebar:c})]})})})}const _e={docMainContainer:"docMainContainer_Ww0q",docMainContainerEnhanced:"docMainContainerEnhanced_seLG",docItemWrapperEnhanced:"docItemWrapperEnhanced_W3U_"};function ge({hiddenSidebarContainer:e,children:t}){const n=(0,r.t)();return(0,h.jsx)("main",{className:(0,i.A)(_e.docMainContainer,(e||!n)&&_e.docMainContainerEnhanced),children:(0,h.jsx)("div",{className:(0,i.A)("container padding-top--md padding-bottom--lg",_e.docItemWrapper,e&&_e.docItemWrapperEnhanced),children:t})})}const ve="docRoot_hEeJ",Ae="docsWrapper_ueFZ";function Ce({children:e}){const t=(0,r.t)(),[n,i]=(0,a.useState)(!1);return(0,h.jsxs)("div",{className:Ae,children:[(0,h.jsx)(p,{}),(0,h.jsxs)("div",{className:ve,children:[t&&(0,h.jsx)(je,{sidebar:t.items,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}),(0,h.jsx)(ge,{hiddenSidebarContainer:n,children:e})]})]})}var ke=n(5876);function Se(e){const t=(0,l.B5)(e);if(!t)return(0,h.jsx)(ke.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,h.jsx)(s.e3,{className:(0,i.A)(o.G.page.docsDocPage),children:(0,h.jsx)(r.V,{name:a,items:c,children:(0,h.jsx)(Ce,{children:n})})})}},5876(e,t,n){n.d(t,{A:()=>l});n(758);var a=n(3526),i=n(8114),s=n(6445),o=n(6070);function l({className:e}){return(0,o.jsx)("main",{className:(0,a.A)("container margin-vert--xl",e),children:(0,o.jsx)("div",{className:"row",children:(0,o.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,o.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,o.jsx)(i.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}}}]);

package/build/docs/assets/js/a9ba6591.bcdf3f9d.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9119],{9200(e,o,n){n.r(o),n.d(o,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/variables/FormPropsContext","title":"FormPropsContext","description":"Side-channel context for the useForm configuration that the parent","source":"@site/docs/api/variables/FormPropsContext.md","sourceDirName":"api/variables","slug":"/api/variables/FormPropsContext","permalink":"/app-sdk/api/variables/FormPropsContext","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/FormPropsContext.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ErrorToast","permalink":"/app-sdk/api/variables/ErrorToast"},"next":{"title":"GuestMicroApp","permalink":"/app-sdk/api/variables/GuestMicroApp"}}');var t=n(6070),a=n(5589);const s={},i="FormPropsContext",l={},d=[];function c(e){const o={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.header,{children:(0,t.jsx)(o.h1,{id:"formpropscontext",children:"FormPropsContext"})}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-ts",children:'const FormPropsContext: Context<\n  | Partial<{\n  context: any;\n  criteriaMode: CriteriaMode;\n  defaultValues:   | AsyncDefaultValues<FieldValues>\n     | {\n   [key: string]: any;\n   };\n  delayError: number;\n  disabled: boolean;\n  errors: FieldErrors<FieldValues>;\n  formControl?: Omit<UseFormReturn<FieldValues, any, FieldValues>, "formState">;\n  mode: "onBlur" | "onChange" | "onSubmit" | "all" | "onTouched";\n  progressive: boolean;\n  resetOptions:   | Partial<{\n     keepDefaultValues: boolean;\n     keepDirty: boolean;\n     keepDirtyValues: boolean;\n     keepErrors: boolean;\n     keepFieldsRef: boolean;\n     keepIsSubmitSuccessful: boolean;\n     keepIsSubmitted: boolean;\n     keepIsValid: boolean;\n     keepIsValidating: boolean;\n     keepSubmitCount: boolean;\n     keepTouched: boolean;\n     keepValues: boolean;\n   }>\n     | undefined;\n  resolver: Resolver<FieldValues, any, FieldValues>;\n  reValidateMode: "onBlur" | "onChange" | "onSubmit";\n  shouldFocusError: boolean;\n  shouldUnregister: boolean;\n  shouldUseNativeValidation: boolean;\n  validate: ValidateForm<FieldValues>;\n  values: TFieldValues;\n}>\n| undefined>;\n'})}),"\n",(0,t.jsxs)(o.p,{children:["Side-channel context for the ",(0,t.jsx)(o.code,{children:"useForm"})," configuration that the parent\n",(0,t.jsx)(o.code,{children:"<Form>"})," was created with."]}),"\n",(0,t.jsxs)(o.p,{children:["react-hook-form's ",(0,t.jsx)(o.code,{children:"FormProvider"})," only forwards a fixed allow-list of\n",(0,t.jsx)(o.code,{children:"UseFormReturn"})," fields into its context (see node_modules/react-hook-form),\nso extra props such as ",(0,t.jsx)(o.code,{children:"mode"})," cannot ride along on ",(0,t.jsx)(o.code,{children:"useFormContext()"}),".\nThis context exposes the original ",(0,t.jsx)(o.code,{children:"reactHookFormProps"})," to descendants\n(e.g. ",(0,t.jsx)(o.code,{children:"FormSubmitButton"}),") that need to read ",(0,t.jsx)(o.code,{children:"mode"}),"."]})]})}function p(e={}){const{wrapper:o}={...(0,a.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},5589(e,o,n){n.d(o,{R:()=>s,x:()=>i});var r=n(758);const t={},a=r.createContext(t);function s(e){const o=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(o):{...o,...e}},[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(a.Provider,{value:o},e.children)}}}]);

package/build/docs/assets/js/ab05b3aa.63cf7d9f.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1788],{8883(e,t,a){a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/variables/NavigationPrompt","title":"NavigationPrompt","description":"","source":"@site/docs/api/variables/NavigationPrompt.md","sourceDirName":"api/variables","slug":"/api/variables/NavigationPrompt","permalink":"/app-sdk/api/variables/NavigationPrompt","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/NavigationPrompt.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~MicroIFrameApp~~","permalink":"/app-sdk/api/variables/MicroIFrameApp"},"next":{"title":"NavigationPromptActions","permalink":"/app-sdk/api/variables/NavigationPromptActions"}}');var n=a(6070),o=a(5589);const r={},s="NavigationPrompt",p={},c=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"navigationprompt",children:"NavigationPrompt"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"const NavigationPrompt: NamedExoticComponent<NavigationPromptProps>;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},5589(e,t,a){a.d(t,{R:()=>r,x:()=>s});var i=a(758);const n={},o=i.createContext(n);function r(e){const t=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/aba21aa0.4d968e31.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[5742],{7093(e){e.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]);

package/build/docs/assets/js/ac9d64ec.dd98824b.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8862],{4247(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>p,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/functions/setAppConfigValue","title":"setAppConfigValue()","description":"Sets a value in the application configuration using dot notation.","source":"@site/docs/api/functions/setAppConfigValue.md","sourceDirName":"api/functions","slug":"/api/functions/setAppConfigValue","permalink":"/app-sdk/api/functions/setAppConfigValue","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/setAppConfigValue.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setAppConfig()","permalink":"/app-sdk/api/functions/setAppConfig"},"next":{"title":"setHostAppData()","permalink":"/app-sdk/api/functions/setHostAppData"}}');var s=t(6070),a=t(5589);const p={},r="setAppConfigValue()",l={},o=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Type",id:"type",level:3},{value:"Parameters",id:"parameters",level:2},{value:"key",id:"key",level:3},{value:"value",id:"value",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"setappconfigvalue",children:"setAppConfigValue()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function setAppConfigValue<Type>(key: string, value: Type): AppConfig;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Sets a value in the application configuration using dot notation.\nCreates nested objects if they don't exist."}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Type"})}),"\n",(0,s.jsx)(n.p,{children:"Type of the value being set"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"key",children:"key"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Dot-notation path to set (e.g., 'serviceEndpoints.api')"}),"\n",(0,s.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Type"})}),"\n",(0,s.jsx)(n.p,{children:"Value to set at the specified path"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/app-sdk/api/interfaces/AppConfig",children:(0,s.jsx)(n.code,{children:"AppConfig"})})}),"\n",(0,s.jsx)(n.p,{children:"The updated configuration object"}),"\n",(0,s.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"setAppConfigValue('serviceEndpoints.api', 'https://new-api.com');\nsetAppConfigValue('customSetting.enabled', true);\n"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},5589(e,n,t){t.d(n,{R:()=>p,x:()=>r});var i=t(758);const s={},a=i.createContext(s);function p(e){const n=i.useContext(a);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:p(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/aeb9810c.f3c24439.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[3072],{1752(e,n,t){t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/getAuthHTTPClient","title":"getAuthHTTPClient()","description":"Creates an authenticated HTTP client instance with authorization headers.","source":"@site/docs/api/functions/getAuthHTTPClient.md","sourceDirName":"api/functions","slug":"/api/functions/getAuthHTTPClient","permalink":"/app-sdk/api/functions/getAuthHTTPClient","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getAuthHTTPClient.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getAppConfigValue()","permalink":"/app-sdk/api/functions/getAppConfigValue"},"next":{"title":"getAuthorizationHeader()","permalink":"/app-sdk/api/functions/getAuthorizationHeader"}}');var i=t(6070),r=t(5589);const a={},l="getAuthHTTPClient()",o={},c=[{value:"Parameters",id:"parameters",level:2},{value:"config?",id:"config",level:3},{value:"baseURL?",id:"baseurl",level:4},{value:"headers?",id:"headers",level:4},{value:"rest?",id:"rest",level:4},{value:"sendLogRocketSessionHeader?",id:"sendlogrocketsessionheader",level:4},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"getauthhttpclient",children:"getAuthHTTPClient()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getAuthHTTPClient(config?: {\n  baseURL?: string;\n  headers?: RequestConfig;\n  rest?: any[];\n  sendLogRocketSessionHeader?: boolean;\n}): AxiosInstance;\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates an authenticated HTTP client instance with authorization headers.\nAutomatically includes the current user's authorization token in all requests."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"config?"}),"\n",(0,i.jsx)(n.p,{children:"Configuration options"}),"\n",(0,i.jsx)(n.h4,{id:"baseurl",children:"baseURL?"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.p,{children:"Base URL for API requests (defaults to app config value)"}),"\n",(0,i.jsx)(n.h4,{id:"headers",children:"headers?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"RequestConfig"})," = ",(0,i.jsx)(n.code,{children:"{}"})]}),"\n",(0,i.jsx)(n.p,{children:"Custom headers to include in requests"}),"\n",(0,i.jsx)(n.h4,{id:"rest",children:"rest?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"sendlogrocketsessionheader",children:"sendLogRocketSessionHeader?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"boolean"})," = ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"Include LogRocket session URL in headers"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"AxiosInstance"})}),"\n",(0,i.jsx)(n.p,{children:"Configured Axios instance with auth headers"}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"const client = getAuthHTTPClient();\nconst response = await client.get('/secure/endpoint');\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5589(e,n,t){t.d(n,{R:()=>a,x:()=>l});var s=t(758);const i={},r=s.createContext(i);function a(e){const n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/b0125fa2.c7fba4da.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[4004],{8056(e,t,n){n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/functions/DateTimePicker","title":"DateTimePicker()","description":"Parameters","source":"@site/docs/api/functions/DateTimePicker.md","sourceDirName":"api/functions","slug":"/api/functions/DateTimePicker","permalink":"/app-sdk/api/functions/DateTimePicker","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/DateTimePicker.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"DateRangePicker()","permalink":"/app-sdk/api/functions/DateRangePicker"},"next":{"title":"Form()","permalink":"/app-sdk/api/functions/Form"}}');var i=n(6070),a=n(5589);const s={},c="DateTimePicker()",o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"datetimepicker",children:"DateTimePicker()"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"function DateTimePicker(__namedParameters: DateTimePickerProps): Element;\n"})}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(t.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"DateTimePickerProps"})}),"\n",(0,i.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"Element"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5589(e,t,n){n.d(t,{R:()=>s,x:()=>c});var r=n(758);const i={},a=r.createContext(i);function s(e){const t=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/b0ccf0d8.89a4a7e2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9149],{5700(e,n,r){r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>i,metadata:()=>t,toc:()=>u});const t=JSON.parse('{"id":"api/functions/useInjectReducer","title":"useInjectReducer()","description":"A react hook that dynamically injects a reducer when the hook is run","source":"@site/docs/api/functions/useInjectReducer.md","sourceDirName":"api/functions","slug":"/api/functions/useInjectReducer","permalink":"/app-sdk/api/functions/useInjectReducer","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/useInjectReducer.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useInjectQuery()","permalink":"/app-sdk/api/functions/useInjectQuery"},"next":{"title":"useInjectSaga()","permalink":"/app-sdk/api/functions/useInjectSaga"}}');var c=r(6070),s=r(5589);const i={},d="useInjectReducer()",a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"key",id:"key",level:4},{value:"reducer",id:"reducer",level:4},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function o(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{children:(0,c.jsx)(n.h1,{id:"useinjectreducer",children:"useInjectReducer()"})}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-ts",children:"function useInjectReducer(options: {\n  key: string;\n  reducer: Reducer;\n}): boolean;\n"})}),"\n",(0,c.jsx)(n.p,{children:"A react hook that dynamically injects a reducer when the hook is run"}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,c.jsx)(n.h4,{id:"key",children:"key"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"string"})}),"\n",(0,c.jsx)(n.p,{children:"The key to inject the reducer under"}),"\n",(0,c.jsx)(n.h4,{id:"reducer",children:"reducer"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"Reducer"})}),"\n",(0,c.jsx)(n.p,{children:"The reducer that will be injected"}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"boolean"})}),"\n",(0,c.jsx)(n.p,{children:"flag indicating whether or not the reducer has finished injecting"}),"\n",(0,c.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-ts",children:'function BooksManager() {\n useInjectReducer({ key: "books", reducer: booksReducer })\n\n return null;\n}\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(o,{...e})}):o(e)}},5589(e,n,r){r.d(n,{R:()=>i,x:()=>d});var t=r(758);const c={},s=t.createContext(c);function i(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/b1474780.0982f737.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8820],{4443(e,r,a){a.r(r),a.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>l,frontMatter:()=>p,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/variables/MicroIFrameApp","title":"~~MicroIFrameApp~~","description":"Component to render a guest microapp in an iframe.","source":"@site/docs/api/variables/MicroIFrameApp.md","sourceDirName":"api/variables","slug":"/api/variables/MicroIFrameApp","permalink":"/app-sdk/api/variables/MicroIFrameApp","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/MicroIFrameApp.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~MicroApp~~","permalink":"/app-sdk/api/variables/MicroApp"},"next":{"title":"NavigationPrompt","permalink":"/app-sdk/api/variables/NavigationPrompt"}}');var n=a(6070),t=a(5589);const p={},o="MicroIFrameApp",s={},c=[{value:"Deprecated",id:"deprecated",level:2}];function d(e){const r={code:"code",del:"del",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"microiframeapp",children:(0,n.jsx)(r.del,{children:"MicroIFrameApp"})})}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"const MicroIFrameApp: NamedExoticComponent<Props>;\n"})}),"\n",(0,n.jsx)(r.p,{children:"Component to render a guest microapp in an iframe."}),"\n",(0,n.jsx)(r.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,n.jsxs)(r.p,{children:["This component is deprecated and will be removed in future versions.\nUse the ",(0,n.jsx)(r.code,{children:"GuestMicroApp"})," component instead."]})]})}function l(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},5589(e,r,a){a.d(r,{R:()=>p,x:()=>o});var i=a(758);const n={},t=i.createContext(n);function p(e){const r=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:p(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/b2a255cc.df3fdd56.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7954],{4093(e,t,r){r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>n,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"api/variables/clearSideEffects","title":"clearSideEffects","description":"Clears all registered side effect listeners.","source":"@site/docs/api/variables/clearSideEffects.md","sourceDirName":"api/variables","slug":"/api/variables/clearSideEffects","permalink":"/app-sdk/api/variables/clearSideEffects","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/clearSideEffects.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"authReducer","permalink":"/app-sdk/api/variables/authReducer"},"next":{"title":"createSideEffect","permalink":"/app-sdk/api/variables/createSideEffect"}}');var a=r(6070),i=r(5589);const n={},c="clearSideEffects",l={},d=[{value:"Returns",id:"returns",level:2}];function o(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"clearsideeffects",children:"clearSideEffects"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"const clearSideEffects: () => void = listenerMiddleware.clearListeners;\n"})}),"\n",(0,a.jsx)(t.p,{children:"Clears all registered side effect listeners.\nUseful for cleanup or resetting the app state."}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"void"})})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},5589(e,t,r){r.d(t,{R:()=>n,x:()=>c});var s=r(758);const a={},i=s.createContext(a);function n(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:n(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/b31a5f55.9a4737ac.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[5407],{5914(e,r,l){l.r(r),l.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>a,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/functions/renderWithRedux","title":"renderWithRedux()","description":"Parameters","source":"@site/docs/api/functions/renderWithRedux.md","sourceDirName":"api/functions","slug":"/api/functions/renderWithRedux","permalink":"/app-sdk/api/functions/renderWithRedux","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/renderWithRedux.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"renderWithHostData()","permalink":"/app-sdk/api/functions/renderWithHostData"},"next":{"title":"renderWithRouter()","permalink":"/app-sdk/api/functions/renderWithRouter"}}');var s=l(6070),t=l(5589);const a={},i="renderWithRedux()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"ui",id:"ui",level:3},{value:"__namedParameters?",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2},{value:"asFragment",id:"asfragment",level:3},{value:"Returns",id:"returns-1",level:4},{value:"baseElement",id:"baseelement",level:3},{value:"container",id:"container",level:3},{value:"debug",id:"debug",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"baseElement?",id:"baseelement-1",level:5},{value:"maxLength?",id:"maxlength",level:5},{value:"options?",id:"options",level:5},{value:"Returns",id:"returns-2",level:4},{value:"findAllByAltText",id:"findallbyalttext",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"args",id:"args",level:5},{value:"Returns",id:"returns-3",level:4},{value:"findAllByDisplayValue",id:"findallbydisplayvalue",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"args",id:"args-1",level:5},{value:"Returns",id:"returns-4",level:4},{value:"findAllByLabelText",id:"findallbylabeltext",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"args",id:"args-2",level:5},{value:"Returns",id:"returns-5",level:4},{value:"findAllByPlaceholderText",id:"findallbyplaceholdertext",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"args",id:"args-3",level:5},{value:"Returns",id:"returns-6",level:4},{value:"findAllByRole",id:"findallbyrole",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"args",id:"args-4",level:5},{value:"Returns",id:"returns-7",level:4},{value:"findAllByTestId",id:"findallbytestid",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"args",id:"args-5",level:5},{value:"Returns",id:"returns-8",level:4},{value:"findAllByText",id:"findallbytext",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"args",id:"args-6",level:5},{value:"Returns",id:"returns-9",level:4},{value:"findAllByTitle",id:"findallbytitle",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"args",id:"args-7",level:5},{value:"Returns",id:"returns-10",level:4},{value:"findByAltText",id:"findbyalttext",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"args",id:"args-8",level:5},{value:"Returns",id:"returns-11",level:4},{value:"findByDisplayValue",id:"findbydisplayvalue",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"args",id:"args-9",level:5},{value:"Returns",id:"returns-12",level:4},{value:"findByLabelText",id:"findbylabeltext",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"args",id:"args-10",level:5},{value:"Returns",id:"returns-13",level:4},{value:"findByPlaceholderText",id:"findbyplaceholdertext",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"args",id:"args-11",level:5},{value:"Returns",id:"returns-14",level:4},{value:"findByRole",id:"findbyrole",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"args",id:"args-12",level:5},{value:"Returns",id:"returns-15",level:4},{value:"findByTestId",id:"findbytestid",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"args",id:"args-13",level:5},{value:"Returns",id:"returns-16",level:4},{value:"findByText",id:"findbytext",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"args",id:"args-14",level:5},{value:"Returns",id:"returns-17",level:4},{value:"findByTitle",id:"findbytitle",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"args",id:"args-15",level:5},{value:"Returns",id:"returns-18",level:4},{value:"getAllByAltText",id:"getallbyalttext",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"args",id:"args-16",level:5},{value:"Returns",id:"returns-19",level:4},{value:"getAllByDisplayValue",id:"getallbydisplayvalue",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"args",id:"args-17",level:5},{value:"Returns",id:"returns-20",level:4},{value:"getAllByLabelText",id:"getallbylabeltext",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"args",id:"args-18",level:5},{value:"Returns",id:"returns-21",level:4},{value:"getAllByPlaceholderText",id:"getallbyplaceholdertext",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"args",id:"args-19",level:5},{value:"Returns",id:"returns-22",level:4},{value:"getAllByRole",id:"getallbyrole",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"args",id:"args-20",level:5},{value:"Returns",id:"returns-23",level:4},{value:"getAllByTestId",id:"getallbytestid",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"args",id:"args-21",level:5},{value:"Returns",id:"returns-24",level:4},{value:"getAllByText",id:"getallbytext",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"args",id:"args-22",level:5},{value:"Returns",id:"returns-25",level:4},{value:"getAllByTitle",id:"getallbytitle",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"args",id:"args-23",level:5},{value:"Returns",id:"returns-26",level:4},{value:"getByAltText",id:"getbyalttext",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"args",id:"args-24",level:5},{value:"Returns",id:"returns-27",level:4},{value:"getByDisplayValue",id:"getbydisplayvalue",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"args",id:"args-25",level:5},{value:"Returns",id:"returns-28",level:4},{value:"getByLabelText",id:"getbylabeltext",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"args",id:"args-26",level:5},{value:"Returns",id:"returns-29",level:4},{value:"getByPlaceholderText",id:"getbyplaceholdertext",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"args",id:"args-27",level:5},{value:"Returns",id:"returns-30",level:4},{value:"getByRole",id:"getbyrole",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"args",id:"args-28",level:5},{value:"Returns",id:"returns-31",level:4},{value:"getByTestId",id:"getbytestid",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"args",id:"args-29",level:5},{value:"Returns",id:"returns-32",level:4},{value:"getByText",id:"getbytext",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"args",id:"args-30",level:5},{value:"Returns",id:"returns-33",level:4},{value:"getByTitle",id:"getbytitle",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"args",id:"args-31",level:5},{value:"Returns",id:"returns-34",level:4},{value:"queryAllByAltText",id:"queryallbyalttext",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"args",id:"args-32",level:5},{value:"Returns",id:"returns-35",level:4},{value:"queryAllByDisplayValue",id:"queryallbydisplayvalue",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"args",id:"args-33",level:5},{value:"Returns",id:"returns-36",level:4},{value:"queryAllByLabelText",id:"queryallbylabeltext",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"args",id:"args-34",level:5},{value:"Returns",id:"returns-37",level:4},{value:"queryAllByPlaceholderText",id:"queryallbyplaceholdertext",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"args",id:"args-35",level:5},{value:"Returns",id:"returns-38",level:4},{value:"queryAllByRole",id:"queryallbyrole",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"args",id:"args-36",level:5},{value:"Returns",id:"returns-39",level:4},{value:"queryAllByTestId",id:"queryallbytestid",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"args",id:"args-37",level:5},{value:"Returns",id:"returns-40",level:4},{value:"queryAllByText",id:"queryallbytext",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"args",id:"args-38",level:5},{value:"Returns",id:"returns-41",level:4},{value:"queryAllByTitle",id:"queryallbytitle",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"args",id:"args-39",level:5},{value:"Returns",id:"returns-42",level:4},{value:"queryByAltText",id:"querybyalttext",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"args",id:"args-40",level:5},{value:"Returns",id:"returns-43",level:4},{value:"queryByDisplayValue",id:"querybydisplayvalue",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"args",id:"args-41",level:5},{value:"Returns",id:"returns-44",level:4},{value:"queryByLabelText",id:"querybylabeltext",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"args",id:"args-42",level:5},{value:"Returns",id:"returns-45",level:4},{value:"queryByPlaceholderText",id:"querybyplaceholdertext",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"args",id:"args-43",level:5},{value:"Returns",id:"returns-46",level:4},{value:"queryByRole",id:"querybyrole",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"args",id:"args-44",level:5},{value:"Returns",id:"returns-47",level:4},{value:"queryByTestId",id:"querybytestid",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"args",id:"args-45",level:5},{value:"Returns",id:"returns-48",level:4},{value:"queryByText",id:"querybytext",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"args",id:"args-46",level:5},{value:"Returns",id:"returns-49",level:4},{value:"queryByTitle",id:"querybytitle",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"args",id:"args-47",level:5},{value:"Returns",id:"returns-50",level:4},{value:"rerender",id:"rerender",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"ui",id:"ui-1",level:5},{value:"Returns",id:"returns-51",level:4},{value:"store",id:"store",level:3},{value:"unmount",id:"unmount",level:3},{value:"Returns",id:"returns-52",level:4}];function h(e){const r={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"renderwithredux",children:"renderWithRedux()"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"function renderWithRedux(ui: ReactElement, __namedParameters?: Args): {\n  asFragment: () => DocumentFragment;\n  baseElement: HTMLElement;\n  container: HTMLElement;\n  debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;\n  findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n  findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n  findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n  getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n  getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;\n  getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n  getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n  queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n  queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;\n  queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n  queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  rerender: (ui: ReactNode) => void;\n  store: ToolkitStore<EmptyObject & {\n     breakpoint: BreakpointState;\n     error: ErrorState;\n     liveMessage: LiveMessageState;\n     waitMessage: WaitMessageState;\n   }, \n     | AnyAction\n     | {\n     payload: WaitMessageState;\n     type: string;\n   }\n     | {\n     payload: Breakpoints;\n     type: string;\n   }, MiddlewareArray<[ListenerMiddleware<unknown, ThunkDispatch<unknown, unknown, AnyAction>, unknown>, ThunkMiddleware<CombinedState<{\n     breakpoint: BreakpointState;\n     error: ErrorState;\n     liveMessage: LiveMessageState;\n     waitMessage: WaitMessageState;\n  }>, AnyAction>, ...(SagaMiddleware<object> | Middleware<any, any, Dispatch<AnyAction>>)[]]>>;\n  unmount: () => void;\n};\n"})}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(r.h3,{id:"ui",children:"ui"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"ReactElement"})}),"\n",(0,s.jsx)(r.h3,{id:"__namedparameters",children:"__namedParameters?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Args"})," = ",(0,s.jsx)(r.code,{children:"..."})]}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"{\n  asFragment: () => DocumentFragment;\n  baseElement: HTMLElement;\n  container: HTMLElement;\n  debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;\n  findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n  findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n  findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n  findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n  getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n  getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n  getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;\n  getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n  getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n  queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n  queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n  queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n  queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n  queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;\n  queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n  queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n  rerender: (ui: ReactNode) => void;\n  store: ToolkitStore<EmptyObject & {\n     breakpoint: BreakpointState;\n     error: ErrorState;\n     liveMessage: LiveMessageState;\n     waitMessage: WaitMessageState;\n   }, \n     | AnyAction\n     | {\n     payload: WaitMessageState;\n     type: string;\n   }\n     | {\n     payload: Breakpoints;\n     type: string;\n   }, MiddlewareArray<[ListenerMiddleware<unknown, ThunkDispatch<unknown, unknown, AnyAction>, unknown>, ThunkMiddleware<CombinedState<{\n     breakpoint: BreakpointState;\n     error: ErrorState;\n     liveMessage: LiveMessageState;\n     waitMessage: WaitMessageState;\n  }>, AnyAction>, ...(SagaMiddleware<object> | Middleware<any, any, Dispatch<AnyAction>>)[]]>>;\n  unmount: () => void;\n}\n"})}),"\n",(0,s.jsx)(r.h3,{id:"asfragment",children:"asFragment"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"asFragment: () => DocumentFragment;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"DocumentFragment"})}),"\n",(0,s.jsx)(r.h3,{id:"baseelement",children:"baseElement"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"baseElement: HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h3,{id:"container",children:"container"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"container: HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h3,{id:"debug",children:"debug"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"baseelement-1",children:"baseElement?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Element"})," | ",(0,s.jsx)(r.code,{children:"DocumentFragment"})," | (",(0,s.jsx)(r.code,{children:"Element"})," | ",(0,s.jsx)(r.code,{children:"DocumentFragment"}),")[]"]}),"\n",(0,s.jsx)(r.h5,{id:"maxlength",children:"maxLength?"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"number"})}),"\n",(0,s.jsx)(r.h5,{id:"options",children:"options?"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PrettyFormatOptions"})}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbyalttext",children:"findAllByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbydisplayvalue",children:"findAllByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-1",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbylabeltext",children:"findAllByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-2",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbyplaceholdertext",children:"findAllByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-3",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbyrole",children:"findAllByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-4",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbytestid",children:"findAllByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-5",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbytext",children:"findAllByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-6",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findallbytitle",children:"findAllByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-7",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbyalttext",children:"findByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-8",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbydisplayvalue",children:"findByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-9",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbylabeltext",children:"findByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-10",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbyplaceholdertext",children:"findByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-11",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbyrole",children:"findByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-12",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbytestid",children:"findByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-13",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbytext",children:"findByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-14",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-17",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"findbytitle",children:"findByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-15",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),", ",(0,s.jsx)(r.code,{children:"waitForOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-18",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"Promise"})}),"\n",(0,s.jsx)(r.h3,{id:"getallbyalttext",children:"getAllByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-16",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-19",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbydisplayvalue",children:"getAllByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-17",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-20",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbylabeltext",children:"getAllByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-18",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-21",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbyplaceholdertext",children:"getAllByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-19",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-22",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbyrole",children:"getAllByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-20",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-23",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbytestid",children:"getAllByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-21",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-24",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbytext",children:"getAllByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-22",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-25",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getallbytitle",children:"getAllByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-23",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-26",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"getbyalttext",children:"getByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-24",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-27",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbydisplayvalue",children:"getByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-25",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-28",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbylabeltext",children:"getByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-26",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-29",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbyplaceholdertext",children:"getByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-27",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-30",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbyrole",children:"getByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-28",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-31",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbytestid",children:"getByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-29",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-32",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbytext",children:"getByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-32",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-30",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-33",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"getbytitle",children:"getByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-31",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-34",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"HTMLElement"})}),"\n",(0,s.jsx)(r.h3,{id:"queryallbyalttext",children:"queryAllByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-32",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-35",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbydisplayvalue",children:"queryAllByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-33",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-36",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbylabeltext",children:"queryAllByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-34",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-37",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbyplaceholdertext",children:"queryAllByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-35",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-38",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbyrole",children:"queryAllByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-36",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-39",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbytestid",children:"queryAllByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-37",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-40",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbytext",children:"queryAllByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-38",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-41",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"queryallbytitle",children:"queryAllByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-41",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-39",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-42",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"}),"[]"]}),"\n",(0,s.jsx)(r.h3,{id:"querybyalttext",children:"queryByAltText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-42",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-40",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-43",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybydisplayvalue",children:"queryByDisplayValue"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-41",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-44",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybylabeltext",children:"queryByLabelText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-44",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-42",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-45",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybyplaceholdertext",children:"queryByPlaceholderText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-45",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-43",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-46",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybyrole",children:"queryByRole"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-46",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-44",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"ByRoleMatcher"}),", ",(0,s.jsx)(r.code,{children:"ByRoleOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-47",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybytestid",children:"queryByTestId"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-45",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-48",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybytext",children:"queryByText"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-48",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-46",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"SelectorMatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-49",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"querybytitle",children:"queryByTitle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-49",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"args-47",children:"args"}),"\n",(0,s.jsxs)(r.p,{children:["...[",(0,s.jsx)(r.code,{children:"Matcher"}),", ",(0,s.jsx)(r.code,{children:"MatcherOptions"}),"]"]}),"\n",(0,s.jsx)(r.h4,{id:"returns-50",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"HTMLElement"})," | ",(0,s.jsx)(r.code,{children:"null"})]}),"\n",(0,s.jsx)(r.h3,{id:"rerender",children:"rerender"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"rerender: (ui: ReactNode) => void;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"parameters-50",children:"Parameters"}),"\n",(0,s.jsx)(r.h5,{id:"ui-1",children:"ui"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"ReactNode"})}),"\n",(0,s.jsx)(r.h4,{id:"returns-51",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h3,{id:"store",children:"store"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"store: ToolkitStore<EmptyObject & {\n  breakpoint: BreakpointState;\n  error: ErrorState;\n  liveMessage: LiveMessageState;\n  waitMessage: WaitMessageState;\n}, \n  | AnyAction\n  | {\n  payload: WaitMessageState;\n  type: string;\n}\n  | {\n  payload: Breakpoints;\n  type: string;\n}, MiddlewareArray<[ListenerMiddleware<unknown, ThunkDispatch<unknown, unknown, AnyAction>, unknown>, ThunkMiddleware<CombinedState<{\n  breakpoint: BreakpointState;\n  error: ErrorState;\n  liveMessage: LiveMessageState;\n  waitMessage: WaitMessageState;\n}>, AnyAction>, ...(SagaMiddleware<object> | Middleware<any, any, Dispatch<AnyAction>>)[]]>>;\n"})}),"\n",(0,s.jsx)(r.h3,{id:"unmount",children:"unmount"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"unmount: () => void;\n"})}),"\n",(0,s.jsx)(r.h4,{id:"returns-52",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})})]})}function o(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},5589(e,r,l){l.d(r,{R:()=>a,x:()=>i});var n=l(758);const s={},t=n.createContext(s);function a(e){const r=n.useContext(t);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/b4285021.67b039a1.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7259],{2153(e,a,s){s.r(a),s.d(a,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>p});const t=JSON.parse('{"id":"api/variables/WaitMessage","title":"WaitMessage","description":"","source":"@site/docs/api/variables/WaitMessage.md","sourceDirName":"api/variables","slug":"/api/variables/WaitMessage","permalink":"/app-sdk/api/variables/WaitMessage","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/WaitMessage.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"VisuallyHidden","permalink":"/app-sdk/api/variables/VisuallyHidden"},"next":{"title":"act","permalink":"/app-sdk/api/variables/act"}}');var i=s(6070),n=s(5589);const r={},o="WaitMessage",l={},p=[];function c(e){const a={code:"code",h1:"h1",header:"header",pre:"pre",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(a.header,{children:(0,i.jsx)(a.h1,{id:"waitmessage",children:"WaitMessage"})}),"\n",(0,i.jsx)(a.pre,{children:(0,i.jsx)(a.code,{className:"language-ts",children:"const WaitMessage: NamedExoticComponent<WaitMessageProps>;\n"})})]})}function d(e={}){const{wrapper:a}={...(0,n.R)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},5589(e,a,s){s.d(a,{R:()=>r,x:()=>o});var t=s(758);const i={},n=t.createContext(i);function r(e){const a=t.useContext(n);return t.useMemo(function(){return"function"==typeof e?e(a):{...a,...e}},[a,e])}function o(e){let a;return a=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(n.Provider,{value:a},e.children)}}}]);

package/build/docs/assets/js/b784b5bb.7d7bb82c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[5349],{9706(e,n,r){r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/functions/removeDoubleSlash","title":"removeDoubleSlash()","description":"Parameters","source":"@site/docs/api/functions/removeDoubleSlash.md","sourceDirName":"api/functions","slug":"/api/functions/removeDoubleSlash","permalink":"/app-sdk/api/functions/removeDoubleSlash","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/removeDoubleSlash.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"redactPii()","permalink":"/app-sdk/api/functions/redactPii"},"next":{"title":"removeStorageEvents()","permalink":"/app-sdk/api/functions/removeStorageEvents"}}');var s=r(6070),i=r(5589);const o={},a="removeDoubleSlash()",l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"url",id:"url",level:3},{value:"Returns",id:"returns",level:2}];function u(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"removedoubleslash",children:"removeDoubleSlash()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function removeDoubleSlash(url: string): string;\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},5589(e,n,r){r.d(n,{R:()=>o,x:()=>a});var t=r(758);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/b8c1226b.a92653b3.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7977],{1093(e,t,i){i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>n,toc:()=>p});const n=JSON.parse('{"id":"api/variables/within","title":"within","description":"","source":"@site/docs/api/variables/within.md","sourceDirName":"api/variables","slug":"/api/variables/within","permalink":"/app-sdk/api/variables/within","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/within.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"waitMessageAction","permalink":"/app-sdk/api/variables/waitMessageAction"},"next":{"title":"Getting Started","permalink":"/app-sdk/"}}');var a=i(6070),s=i(5589);const r={},o="within",c={},p=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"within",children:"within"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"const within: typeof getQueriesForElement;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},5589(e,t,i){i.d(t,{R:()=>r,x:()=>o});var n=i(758);const a={},s=n.createContext(a);function r(e){const t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/b93b454c.f87b4896.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[617],{4889(e,t,n){n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"api/functions/fetchUserSettings","title":"fetchUserSettings()","description":"Parameters","source":"@site/docs/api/functions/fetchUserSettings.md","sourceDirName":"api/functions","slug":"/api/functions/fetchUserSettings","permalink":"/app-sdk/api/functions/fetchUserSettings","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/fetchUserSettings.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"fetchHostAppData()","permalink":"/app-sdk/api/functions/fetchHostAppData"},"next":{"title":"getApiActionCreator()","permalink":"/app-sdk/api/functions/getApiActionCreator"}}');var r=n(6070),i=n(5589);const a={},c="fetchUserSettings()",o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"fetchusersettings",children:"fetchUserSettings()"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"function fetchUserSettings(__namedParameters: UsersRequestParams): Promise<Record<string, unknown>>;\n"})}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"UsersRequestParams"})}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"Record"}),"<",(0,r.jsx)(t.code,{children:"string"}),", ",(0,r.jsx)(t.code,{children:"unknown"}),">>"]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},5589(e,t,n){n.d(t,{R:()=>a,x:()=>c});var s=n(758);const r={},i=s.createContext(r);function a(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);