@elliemae/pui-app-sdk 5.48.1 → 5.48.2

package/build/docs/assets/js/5e8c322a.ad9de8ba.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[594],{8302(e,s,r){r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>o,frontMatter:()=>d,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/index","title":"App SDK API","description":"Classes","source":"@site/docs/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/app-sdk/api/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","next":{"title":"Analytics","permalink":"/app-sdk/api/classes/Analytics"}}');var t=r(6070),n=r(5676);const d={},a="App SDK API",c={},l=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Functions",id:"functions",level:2},{value:"References",id:"references",level:2},{value:"CMicroApp",id:"cmicroapp",level:3},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Variables",id:"variables",level:2}];function h(e){const s={a:"a",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"app-sdk-api",children:"App SDK API"})}),"\n",(0,t.jsx)(s.h2,{id:"classes",children:"Classes"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Class"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/Analytics",children:"Analytics"})}),(0,t.jsx)(s.td,{children:"Analytics scripting object that captures business analytics events and performance timing measurements, forwarding them to multiple destinations."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/CMicroAppGuest",children:"CMicroAppGuest"})}),(0,t.jsx)(s.td,{children:"Micro-frontend guest application class (singleton). Manages communication between a guest micro-app and its host application. Supports both SSF (Shared Service Framework) and App Bridge communication methods."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/CMicroAppHost",children:(0,t.jsx)(s.del,{children:"CMicroAppHost"})})}),(0,t.jsx)(s.td,{children:"Micro-frontend host application class (singleton). Manages hosting and coordination of multiple micro-frontend guest applications. Provides shared services like navigation, theming, analytics, and state management."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/ErrorBoundary",children:"ErrorBoundary"})}),(0,t.jsx)(s.td,{children:"React error boundary component that catches JavaScript errors in child components. Logs errors and displays a fallback UI instead of crashing the app."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/GuestModule",children:"GuestModule"})}),(0,t.jsxs)(s.td,{children:["Default IModule implementation backed by a static parameters object. Hosts can instantiate this directly or use the ",(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/createGuestModule",children:"createGuestModule"})," factory for a terser API."]})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Interface"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/interfaces/AppConfig",children:"AppConfig"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/interfaces/GuestProps",children:"GuestProps"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/interfaces/UseStateSelectorOptions",children:"UseStateSelectorOptions"})}),(0,t.jsx)(s.td,{children:"-"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"functions",children:"Functions"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Function"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/AppRoot",children:"AppRoot"})}),(0,t.jsx)(s.td,{children:"Root component for SDK-based applications. Provides Redux store, routing, theming, error boundaries, and session management."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/authorize",children:"authorize"})}),(0,t.jsx)(s.td,{children:"Handles the OAuth authorization callback after redirect from IDP. Exchanges authorization code for access token and initializes user session."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/authSaga",children:"authSaga"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/Autocomplete",children:"Autocomplete"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/buildModuleParams",children:"buildModuleParams"})}),(0,t.jsx)(s.td,{children:"Build a ModuleParameters object for a self-initializing guest."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/CheckBox",children:"CheckBox"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/cleanup",children:"cleanup"})}),(0,t.jsx)(s.td,{children:"Unmounts React trees that were mounted with render."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/ComboBox",children:"ComboBox"})}),(0,t.jsx)(s.td,{children:"Dropdown/select field component with React Hook Form integration. Wraps the Dimsum ComboBox component with form state management and validation."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/ComboBoxV3",children:"ComboBoxV3"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/configureStore",children:"configureStore"})}),(0,t.jsx)(s.td,{children:"Creates and configures the Redux store with SDK middleware and enhancers. Includes saga middleware, listener middleware, RTK Query support, and hot reloading."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/ConnectForm",children:"ConnectForm"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/createGuestModule",children:"createGuestModule"})}),(0,t.jsx)(s.td,{children:"Create a module scripting object for a guest micro-app. The host registers this before rendering GuestMicroApp so the guest can pull its init parameters via module.getParameters()."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/createManager",children:"createManager"})}),(0,t.jsx)(s.td,{children:'Creates a "manager" component that will inject the provided reducer and saga when mounted. It only renders its children after both the reducer and saga have been injected. This is the recommended way to use redux-injectors.'})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/DateInput",children:"DateInput"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/DatePicker",children:"DatePicker"})}),(0,t.jsx)(s.td,{children:"Date picker field component with React Hook Form integration. Wraps the Dimsum DatePicker component with form state management and validation."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/DateRangePicker",children:"DateRangePicker"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/DateTimePicker",children:"DateTimePicker"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/enableReactAppForHostIntegration",children:"enableReactAppForHostIntegration"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/fetchHostAppData",children:"fetchHostAppData"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/fetchUserSettings",children:"fetchUserSettings"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/Form",children:"Form"})}),(0,t.jsx)(s.td,{children:"Form component with integrated React Hook Form state management and validation. Provides form context to all child form fields and handles submission."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/FormItemLayout",children:"FormItemLayout"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/FormLayoutBlockItem",children:"FormLayoutBlockItem"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/FormSubmitButton",children:"FormSubmitButton"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getApiActionCreator",children:"getApiActionCreator"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getAppConfig",children:"getAppConfig"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getAppConfigValue",children:"getAppConfigValue"})}),(0,t.jsx)(s.td,{children:"Gets a value from the application configuration using dot notation. Returns a deep clone to prevent accidental mutations."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getAuthHTTPClient",children:"getAuthHTTPClient"})}),(0,t.jsx)(s.td,{children:"Creates an authenticated HTTP client instance with authorization headers. Automatically includes the current user's authorization token in all requests."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getAuthorizationHeader",children:"getAuthorizationHeader"})}),(0,t.jsx)(s.td,{children:"Gets the current authorization header value from session storage."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getHostAppDataByKey",children:"getHostAppDataByKey"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getHTTPClient",children:"getHTTPClient"})}),(0,t.jsx)(s.td,{children:"Creates a basic HTTP client instance using Axios. The client includes request/response interceptors and automatic retry logic."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getLogger",children:"getLogger"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getMicroFrontEndAppConfig",children:"getMicroFrontEndAppConfig"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getNavigationLinks",children:"getNavigationLinks"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getRedirectUrl",children:"getRedirectUrl"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getSelectField",children:"getSelectField"})}),(0,t.jsx)(s.td,{children:"Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store hence making it easier and keeping your codebase smaller and easier to maintain."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/getStore",children:"getStore"})}),(0,t.jsx)(s.td,{children:"Gets the global Redux store instance."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/initServiceWorker",children:"initServiceWorker"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/InputMask",children:"InputMask"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/InputText",children:"InputText"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/isCIBuild",children:"isCIBuild"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/isProd",children:"isProd"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/isUserAuthorized",children:"isUserAuthorized"})}),(0,t.jsx)(s.td,{children:"Checks if the user is currently authorized/authenticated."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/LargeTextBox",children:"LargeTextBox"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/listenStorageEvents",children:"listenStorageEvents"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/loadable",children:"loadable"})}),(0,t.jsx)(s.td,{children:"Creates a lazily-loaded React component for code splitting. Wraps the component in Suspense with a customizable fallback."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/loadAppConfig",children:"loadAppConfig"})}),(0,t.jsx)(s.td,{children:"Loads the application configuration from a JSON file. Attempts to fetch from versioned path first, then falls back to unversioned path. Merges environment-specific configuration with base configuration."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/login",children:"login"})}),(0,t.jsx)(s.td,{children:"Initiates the login flow using OAuth/OIDC authorization code flow. If authorization code is present in URL, completes the authorization. Otherwise, redirects to the identity provider's login page."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/MaskedInputText",children:"MaskedInputText"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/notifyGuestUnloadComplete",children:"notifyGuestUnloadComplete"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/onAuthorizationFailure",children:"onAuthorizationFailure"})}),(0,t.jsx)(s.td,{children:"Registers a callback to handle authorization failures (401 errors). The callback should refresh the authentication token and return the new authorization header. The SDK will automatically retry the failed request with the new token."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/onGuestUnloadStart",children:"onGuestUnloadStart"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/Page",children:"Page"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/Radio",children:"Radio"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/RadioGroup",children:"RadioGroup"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/redactPii",children:"redactPii"})}),(0,t.jsx)(s.td,{children:"Redacts personally identifiable information (PII) from data objects. Removes sensitive data like credit cards, SSNs, emails, passwords, addresses, etc."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/RegisterService",children:"RegisterService"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/removeDoubleSlash",children:"removeDoubleSlash"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/removeStorageEvents",children:"removeStorageEvents"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/render",children:"render"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/renderHook",children:"renderHook"})}),(0,t.jsx)(s.td,{children:"Allows you to render a hook within a test React component without having to create that component yourself."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/renderWithHostData",children:"renderWithHostData"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/renderWithRedux",children:"renderWithRedux"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/renderWithRouter",children:"renderWithRouter"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/renderWithRouterRedux",children:"renderWithRouterRedux"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/RenderWithStateAddOns",children:"RenderWithStateAddOns"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/RequireAuth",children:"RequireAuth"})}),(0,t.jsx)(s.td,{children:"A React component that ensures authentication for its children."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/sdkBaseQuery",children:"sdkBaseQuery"})}),(0,t.jsx)(s.td,{children:"Base query function for RTK Query integration. Provides automatic error handling, authentication, and token refresh capabilities. Use this as the baseQuery for RTK Query API slices."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/sendBAEvent",children:(0,t.jsx)(s.del,{children:"sendBAEvent"})})}),(0,t.jsx)(s.td,{children:"Sends a business analytics event to Google Tag Manager data layer. Can send events to the host app or handle locally."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/sendMessageToHost",children:"sendMessageToHost"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/SessionTimeout",children:"SessionTimeout"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/setAppConfig",children:"setAppConfig"})}),(0,t.jsx)(s.td,{children:"Sets the entire application configuration. Replaces the current configuration with the provided config object."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/setAppConfigValue",children:"setAppConfigValue"})}),(0,t.jsx)(s.td,{children:"Sets a value in the application configuration using dot notation. Creates nested objects if they don't exist."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/setHostAppData",children:"setHostAppData"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/setLoginParams",children:"setLoginParams"})}),(0,t.jsx)(s.td,{children:"Sets login parameters for the authentication flow. Stores parameters in the global window object for use across the application."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/setSessionTimeoutInterval",children:"setSessionTimeoutInterval"})}),(0,t.jsx)(s.td,{children:"Allows developers to provide a custom value for session expiry."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/subscribeToResetSession",children:"subscribeToResetSession"})}),(0,t.jsx)(s.td,{children:"Registers a callback when the idle clock is reset."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/subscribeToSessionExpiry",children:"subscribeToSessionExpiry"})}),(0,t.jsx)(s.td,{children:"Registers a callback when idle time crosses the expiry threshold."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/subscribeToSessionExpiryWarning",children:"subscribeToSessionExpiryWarning"})}),(0,t.jsx)(s.td,{children:"Registers a callback when idle time crosses the warn threshold."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/TextBox",children:"TextBox"})}),(0,t.jsx)(s.td,{children:"Text input field component with React Hook Form integration. Wraps the Dimsum TextBox component with form state management and validation."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/Toggle",children:"Toggle"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/trackActivity",children:"trackActivity"})}),(0,t.jsxs)(s.td,{children:["Tracks user interaction on a document and invokes a callback (iframe guests). Does not run ",(0,t.jsx)(s.code,{children:"enforceIdleThresholds"}),"; callback should use a guarded renewal path."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useAppDispatch",children:"useAppDispatch"})}),(0,t.jsx)(s.td,{children:"React hook to get the typed dispatch function. Provides type-safe dispatching of Redux actions."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useAppMiddleware",children:"useAppMiddleware"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useInjectQuery",children:"useInjectQuery"})}),(0,t.jsx)(s.td,{children:"React hook to dynamically inject RTK Query API slice into the Redux store. Registers the reducer and middleware for the API slice at runtime."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useInjectReducer",children:"useInjectReducer"})}),(0,t.jsx)(s.td,{children:"A react hook that dynamically injects a reducer when the hook is run"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useInjectSaga",children:"useInjectSaga"})}),(0,t.jsx)(s.td,{children:"A react hook that dynamically injects a saga when the hook is run"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useInjectSideEffect",children:"useInjectSideEffect"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useMediaQueryList",children:"useMediaQueryList"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useStateSelector",children:"useStateSelector"})}),(0,t.jsx)(s.td,{children:"Generic selector that receives a field selector function returned from getSelectField"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/useStateSelectorShallow",children:"useStateSelectorShallow"})}),(0,t.jsx)(s.td,{children:"Generic selector that receives a field selector function returned from getSelectField."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/waitFor",children:"waitFor"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/waitForElementToBeRemoved",children:"waitForElementToBeRemoved"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/functions/withAppDecorator",children:"withAppDecorator"})}),(0,t.jsx)(s.td,{children:"-"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"references",children:"References"}),"\n",(0,t.jsx)(s.h3,{id:"cmicroapp",children:"CMicroApp"}),"\n",(0,t.jsxs)(s.p,{children:["Renames and re-exports ",(0,t.jsx)(s.a,{href:"/app-sdk/api/classes/CMicroAppGuest",children:"CMicroAppGuest"})]}),"\n",(0,t.jsx)(s.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Type Alias"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/AppDispatch",children:"AppDispatch"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/AppStore",children:"AppStore"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/Await",children:"Await"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/EMUI",children:"EMUI"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/HostOptions",children:(0,t.jsx)(s.del,{children:"HostOptions"})})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/HostProvidedParams",children:"HostProvidedParams"})}),(0,t.jsx)(s.td,{children:"Host-provided values that can't be read from the app config."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/ModuleOverrides",children:"ModuleOverrides"})}),(0,t.jsx)(s.td,{children:"Optional method overrides the host can supply to customise the module scripting object beyond the defaults."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/OnHostInitCallback",children:"OnHostInitCallback"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/OnInitCallback",children:"OnInitCallback"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/OnMountCallback",children:"OnMountCallback"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/OnUnMountCallback",children:"OnUnMountCallback"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/RootState",children:"RootState"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/type-aliases/SelectStateFieldFunction",children:"SelectStateFieldFunction"})}),(0,t.jsx)(s.td,{children:"-"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"variables",children:"Variables"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Variable"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/act",children:"act"})}),(0,t.jsx)(s.td,{children:"Simply calls ReactDOMTestUtils.act(cb) If that's not available (older version of react) then it simply calls the given callback immediately"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/ariaLive",children:"ariaLive"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/auth",children:"auth"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/authReducer",children:"authReducer"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/clearSideEffects",children:"clearSideEffects"})}),(0,t.jsx)(s.td,{children:"Clears all registered side effect listeners. Useful for cleanup or resetting the app state."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/createSideEffect",children:"createSideEffect"})}),(0,t.jsx)(s.td,{children:"Creates a new side effect listener. Alternative API for adding listeners."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/decorators",children:"decorators"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/endSession",children:"endSession"})}),(0,t.jsx)(s.td,{children:"Ends the current user session and redirects to logout page. Revokes tokens and clears session storage."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/error",children:"error"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/errorMiddleware",children:"errorMiddleware"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/ErrorToast",children:"ErrorToast"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/fireEvent",children:"fireEvent"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/FormPropsContext",children:"FormPropsContext"})}),(0,t.jsxs)(s.td,{children:["Side-channel context for the ",(0,t.jsx)(s.code,{children:"useForm"})," configuration that the parent ",(0,t.jsx)(s.code,{children:"<Form>"})," was created with."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/globalConstants",children:"globalConstants"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/GuestMicroApp",children:"GuestMicroApp"})}),(0,t.jsx)(s.td,{children:"Component to load a guest microapp."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/history",children:"history"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/httpClientProps",children:"httpClientProps"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/logout",children:"logout"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/MASK_PIPES",children:"MASK_PIPES"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/MASK_TYPES",children:"MASK_TYPES"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/memoryHistory",children:"memoryHistory"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/MicroApp",children:(0,t.jsx)(s.del,{children:"MicroApp"})})}),(0,t.jsx)(s.td,{children:"Component to render a guest microapp"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/MicroIFrameApp",children:(0,t.jsx)(s.del,{children:"MicroIFrameApp"})})}),(0,t.jsx)(s.td,{children:"Component to render a guest microapp in an iframe."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/NavigationPrompt",children:"NavigationPrompt"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/NavigationPromptActions",children:"NavigationPromptActions"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/removeSideEffect",children:"removeSideEffect"})}),(0,t.jsx)(s.td,{children:"Removes a side effect listener."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/resetUserIdleTime",children:"resetUserIdleTime"})}),(0,t.jsxs)(s.td,{children:["Resets the user idle clock without calling the auth introspection API. Used by the HTTP request interceptor. Runs through ",(0,t.jsx)(s.code,{children:"enforceIdleThresholds()"})," first, so it cannot dismiss the warning modal or extend after expiry."]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/screen",children:"screen"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/startSideEffect",children:"startSideEffect"})}),(0,t.jsx)(s.td,{children:"Starts a side effect listener. Used to listen for specific actions and execute side effects."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/Themes",children:"Themes"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/updateBAEventParameters",children:"updateBAEventParameters"})}),(0,t.jsx)(s.td,{children:"Updates the business analytics event parameters with new values"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/useAppSelector",children:"useAppSelector"})}),(0,t.jsx)(s.td,{children:"React hook to select data from Redux store with type safety. Automatically typed to the app's RootState."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/VisuallyHidden",children:"VisuallyHidden"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/WaitMessage",children:"WaitMessage"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/waitMessageAction",children:"waitMessageAction"})}),(0,t.jsx)(s.td,{children:"-"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/app-sdk/api/variables/within",children:"within"})}),(0,t.jsx)(s.td,{children:"-"})]})]})]})]})}function o(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},5676(e,s,r){r.d(s,{R:()=>d,x:()=>a});var i=r(758);const t={},n=i.createContext(t);function d(e){const s=i.useContext(n);return i.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(t):e.components||t:d(e.components),i.createElement(n.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/5ebc190f.ecc2a581.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9816],{6976(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"api/functions/cleanup","title":"cleanup()","description":"Unmounts React trees that were mounted with render.","source":"@site/docs/api/functions/cleanup.md","sourceDirName":"api/functions","slug":"/api/functions/cleanup","permalink":"/app-sdk/api/functions/cleanup","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/cleanup.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"buildModuleParams()","permalink":"/app-sdk/api/functions/buildModuleParams"},"next":{"title":"configureStore()","permalink":"/app-sdk/api/functions/configureStore"}}');var s=t(6070),i=t(5676);const o={},a="cleanup()",c={},u=[{value:"Returns",id:"returns",level:2}];function p(e){const n={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)(n.header,{children:(0,s.jsx)(n.h1,{id:"cleanup",children:"cleanup()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function cleanup(): void;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Unmounts React trees that were mounted with render."}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5676(e,n,t){t.d(n,{R:()=>o,x:()=>a});var r=t(758);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);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(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/5f21eb71.2e6801fb.js

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

package/build/docs/assets/js/60781fed.32f4477c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[574],{855(e,s,r){r.r(s),r.d(s,{assets:()=>o,contentTitle:()=>d,default:()=>l,frontMatter:()=>a,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/functions/createGuestModule","title":"createGuestModule()","description":"Create a module scripting object for a guest micro-app.","source":"@site/docs/api/functions/createGuestModule.md","sourceDirName":"api/functions","slug":"/api/functions/createGuestModule","permalink":"/app-sdk/api/functions/createGuestModule","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/createGuestModule.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"configureStore()","permalink":"/app-sdk/api/functions/configureStore"},"next":{"title":"createManager()","permalink":"/app-sdk/api/functions/createManager"}}');var i=r(6070),n=r(5676);const a={},d="createGuestModule()",o={},c=[{value:"Parameters",id:"parameters",level:2},{value:"guestId",id:"guestid",level:3},{value:"params?",id:"params",level:3},{value:"overrides?",id:"overrides",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"createguestmodule",children:"createGuestModule()"})}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"function createGuestModule(\n   guestId: string, \n   params?: HostProvidedParams, \n   overrides?: ModuleOverrides): IModule;\n"})}),"\n",(0,i.jsx)(s.p,{children:"Create a module scripting object for a guest micro-app.\nThe host registers this before rendering GuestMicroApp so the guest\ncan pull its init parameters via module.getParameters()."}),"\n",(0,i.jsxs)(s.p,{children:["Internally calls ",(0,i.jsx)(s.a,{href:"/app-sdk/api/functions/buildModuleParams",children:"buildModuleParams"})," to merge the app config\nvalues (hostUrl, manifestPath, homeRoute) with host-provided values\n(theme, history, initialRoute). When nested under a parent iframe,\nresolveGuestOpenHistory is applied to ",(0,i.jsx)(s.code,{children:"params.history"})," automatically\n(same behavior as ",(0,i.jsx)(s.a,{href:"/app-sdk/api/variables/GuestMicroApp",children:"GuestMicroApp"}),")."]}),"\n",(0,i.jsxs)(s.p,{children:["Register the returned object via ",(0,i.jsx)(s.a,{href:"/app-sdk/api/classes/CMicroAppGuest#addscriptingobject",children:"CMicroApp.addScriptingObject"}),"\n(not directly on the app bridge) so it is added to both the App Bridge\nand the SSF Host."]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(s.h3,{id:"guestid",children:"guestId"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"string"})}),"\n",(0,i.jsx)(s.p,{children:"App id as defined in app.config.json (e.g. 'loanapp')"}),"\n",(0,i.jsx)(s.h3,{id:"params",children:"params?"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/app-sdk/api/type-aliases/HostProvidedParams",children:(0,i.jsx)(s.code,{children:"HostProvidedParams"})})," = ",(0,i.jsx)(s.code,{children:"{}"})]}),"\n",(0,i.jsx)(s.p,{children:"Host-provided values (theme, history, initialRoute, custom keys)"}),"\n",(0,i.jsx)(s.h3,{id:"overrides",children:"overrides?"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/app-sdk/api/type-aliases/ModuleOverrides",children:(0,i.jsx)(s.code,{children:"ModuleOverrides"})})," = ",(0,i.jsx)(s.code,{children:"{}"})]}),"\n",(0,i.jsx)(s.p,{children:"Method overrides / additions (e.g. custom getCapabilities)"}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"IModule"})}),"\n",(0,i.jsxs)(s.p,{children:["IModule scripting object ready for ",(0,i.jsx)(s.a,{href:"/app-sdk/api/classes/CMicroAppGuest#addscriptingobject",children:"CMicroApp.addScriptingObject"})]})]})}function l(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5676(e,s,r){r.d(s,{R:()=>a,x:()=>d});var t=r(758);const i={},n=t.createContext(i);function a(e){const s=t.useContext(n);return t.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(n.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/61b0e64b.85fb194f.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1413],{2072(e,n,a){a.r(n),a.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/functions/createManager","title":"createManager()","description":"Creates a \\"manager\\" component that will inject the provided reducer and saga","source":"@site/docs/api/functions/createManager.md","sourceDirName":"api/functions","slug":"/api/functions/createManager","permalink":"/app-sdk/api/functions/createManager","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/createManager.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"createGuestModule()","permalink":"/app-sdk/api/functions/createGuestModule"},"next":{"title":"enableReactAppForHostIntegration()","permalink":"/app-sdk/api/functions/enableReactAppForHostIntegration"}}');var t=a(6070),s=a(5676);const i={},c="createManager()",d={},o=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"key",id:"key",level:4},{value:"name",id:"name",level:4},{value:"reducer?",id:"reducer",level:4},{value:"saga?",id:"saga",level:4},{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",h4:"h4",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"createmanager",children:"createManager()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function createManager(options: {\n  key: string;\n  name: string;\n  reducer?: Reducer;\n  saga?: Saga;\n}): ComponentType<{\n  children: ReactNode;\n}>;\n"})}),"\n",(0,t.jsx)(n.p,{children:'Creates a "manager" component that will inject the provided reducer and saga\nwhen mounted.  It only renders its children after both the reducer and saga\nhave been injected.  This is the recommended way to use redux-injectors.'}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,t.jsx)(n.h4,{id:"key",children:"key"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"The key to inject the reducer under"}),"\n",(0,t.jsx)(n.h4,{id:"name",children:"name"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"The name to give the manager that shows up in the react devtools"}),"\n",(0,t.jsx)(n.h4,{id:"reducer",children:"reducer?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Reducer"})}),"\n",(0,t.jsx)(n.p,{children:"The reducer that will be injected"}),"\n",(0,t.jsx)(n.h4,{id:"saga",children:"saga?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Saga"})}),"\n",(0,t.jsx)(n.p,{children:"The saga that will be injected"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ComponentType"}),"<{\n",(0,t.jsx)(n.code,{children:"children"}),": ",(0,t.jsx)(n.code,{children:"ReactNode"}),";\n}>"]}),"\n",(0,t.jsx)(n.p,{children:"The manager"}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'const BooksManager = createManager({ name: "BooksManager", key: "books", reducer: booksReducer, saga: booksSaga })\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},5676(e,n,a){a.d(n,{R:()=>i,x:()=>c});var r=a(758);const t={},s=r.createContext(t);function i(e){const n=r.useContext(s);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/61f3b5cc.9bcbaf57.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8952],{4475(e,n,s){s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/interfaces/AppConfig","title":"AppConfig","description":"Properties","source":"@site/docs/api/interfaces/AppConfig.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/AppConfig","permalink":"/app-sdk/api/interfaces/AppConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/AppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"withAppDecorator()","permalink":"/app-sdk/api/functions/withAppDecorator"},"next":{"title":"GuestProps\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/interfaces/GuestProps"}}');var t=s(6070),r=s(5676);const a={},o="AppConfig",l={},p=[{value:"Properties",id:"properties",level:2},{value:"activeEnv",id:"activeenv",level:3},{value:"appId",id:"appid",level:3},{value:"brand?",id:"brand",level:3},{value:"env",id:"env",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"serviceEndpoints",id:"serviceendpoints",level:3},{value:"sessionTimeoutInterval?",id:"sessiontimeoutinterval",level:3},{value:"sessionTimeoutWarnInterval?",id:"sessiontimeoutwarninterval",level:3},{value:"useParentHistory?",id:"useparenthistory",level:3}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"appconfig",children:"AppConfig"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"activeenv",children:"activeEnv"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"activeEnv: string;\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\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.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"brand",children:"brand?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional brand?: string;\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"env",children:"env"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"env: {\n[key: string]: Env;\n};\n"})}),"\n",(0,t.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"[key: string]: Env\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"serviceendpoints",children:"serviceEndpoints"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"serviceEndpoints: ServiceEndpoints;\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sessiontimeoutinterval",children:"sessionTimeoutInterval?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional sessionTimeoutInterval?: string;\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sessiontimeoutwarninterval",children:"sessionTimeoutWarnInterval?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional sessionTimeoutWarnInterval?: string;\n"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"useparenthistory",children:"useParentHistory?"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"optional useParentHistory?: boolean;\n"})}),"\n",(0,t.jsx)(n.p,{children:"Whether to use the parent history for navigation.\nIf true, the app will use the history from the parent window.\nIf false, it will use its own history.\nDefaults to true."})]})}function c(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},5676(e,n,s){s.d(n,{R:()=>a,x:()=>o});var i=s(758);const t={},r=i.createContext(t);function a(e){const n=i.useContext(r);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(t):e.components||t:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/62e1e335.56ca432b.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9849],{5115(e,t,s){s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/type-aliases/HostProvidedParams","title":"HostProvidedParams","description":"Host-provided values that can\'t be read from the app config.","source":"@site/docs/api/type-aliases/HostProvidedParams.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/HostProvidedParams","permalink":"/app-sdk/api/type-aliases/HostProvidedParams","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/HostProvidedParams.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~HostOptions~~","permalink":"/app-sdk/api/type-aliases/HostOptions"},"next":{"title":"ModuleOverrides","permalink":"/app-sdk/api/type-aliases/ModuleOverrides"}}');var n=s(6070),a=s(5676);const r={},o="HostProvidedParams",d={},l=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"history?",id:"history",level:3},{value:"initialRoute?",id:"initialroute",level:3},{value:"theme?",id:"theme",level:3}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"hostprovidedparams",children:"HostProvidedParams"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"type HostProvidedParams = {\n[key: string]: unknown;\n  history?: History;\n  initialRoute?: To;\n  theme?: DefaultTheme;\n};\n"})}),"\n",(0,n.jsx)(t.p,{children:"Host-provided values that can't be read from the app config."}),"\n",(0,n.jsx)(t.h2,{id:"indexable",children:"Indexable"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"[key: string]: unknown\n"})}),"\n",(0,n.jsx)(t.p,{children:"Additional host-defined key-value pairs"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"history",children:"history?"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"optional history?: History;\n"})}),"\n",(0,n.jsx)(t.p,{children:"Host-provided history object (by reference, App Bridge only \u2014 not for SSF)"}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"initialroute",children:"initialRoute?"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"optional initialRoute?: To;\n"})}),"\n",(0,n.jsx)(t.p,{children:"Route to navigate to on open (only when useParentHistory is false)"}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"theme",children:"theme?"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"optional theme?: DefaultTheme;\n"})}),"\n",(0,n.jsx)(t.p,{children:"Styled-components theme"})]})}function c(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},5676(e,t,s){s.d(t,{R:()=>r,x:()=>o});var i=s(758);const n={},a=i.createContext(n);function r(e){const t=i.useContext(a);return i.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(n):e.components||n:r(e.components),i.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/6aac2d5c.f4d186f2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[3282],{9123(e,n,t){t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/functions/getAppConfig","title":"getAppConfig()","description":"Returns","source":"@site/docs/api/functions/getAppConfig.md","sourceDirName":"api/functions","slug":"/api/functions/getAppConfig","permalink":"/app-sdk/api/functions/getAppConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getAppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getApiActionCreator()","permalink":"/app-sdk/api/functions/getApiActionCreator"},"next":{"title":"getAppConfigValue()","permalink":"/app-sdk/api/functions/getAppConfigValue"}}');var p=t(6070),o=t(5676);const s={},r="getAppConfig()",a={},c=[{value:"Returns",id:"returns",level:2}];function u(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(n.header,{children:(0,p.jsx)(n.h1,{id:"getappconfig",children:"getAppConfig()"})}),"\n",(0,p.jsx)(n.pre,{children:(0,p.jsx)(n.code,{className:"language-ts",children:"function getAppConfig(): AppConfig;\n"})}),"\n",(0,p.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,p.jsx)(n.p,{children:(0,p.jsx)(n.a,{href:"/app-sdk/api/interfaces/AppConfig",children:(0,p.jsx)(n.code,{children:"AppConfig"})})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,p.jsx)(n,{...e,children:(0,p.jsx)(u,{...e})}):u(e)}},5676(e,n,t){t.d(n,{R:()=>s,x:()=>r});var i=t(758);const p={},o=i.createContext(p);function s(e){const n=i.useContext(o);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(p):e.components||p:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/6b345055.445af2c9.js

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

package/build/docs/assets/js/6b7fcc15.adc2c7a0.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6372],{6466(e,s,t){t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/type-aliases/HostOptions","title":"~~HostOptions~~","description":"Deprecated","source":"@site/docs/api/type-aliases/HostOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/HostOptions","permalink":"/app-sdk/api/type-aliases/HostOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/HostOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EMUI\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/type-aliases/EMUI"},"next":{"title":"HostProvidedParams","permalink":"/app-sdk/api/type-aliases/HostProvidedParams"}}');var n=t(6070),r=t(5676);const a={},o="HostOptions",l={},d=[{value:"Deprecated",id:"deprecated",level:2},{value:"Properties",id:"properties",level:2},{value:"<del>history</del>",id:"history",level:3},{value:"<del>systemVersion</del>",id:"systemversion",level:3},{value:"<del>theme</del>",id:"theme",level:3}];function p(e){const s={code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"hostoptions",children:(0,n.jsx)(s.del,{children:"HostOptions"})})}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"type HostOptions = {\n  history: History;\n  systemVersion: string;\n  theme: DefaultTheme;\n};\n"})}),"\n",(0,n.jsx)(s.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,n.jsx)(s.p,{children:"Use CMicroApp with selfInitialize: true instead"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"history",children:(0,n.jsx)(s.del,{children:"history"})}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"history: History;\n"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"systemversion",children:(0,n.jsx)(s.del,{children:"systemVersion"})}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"systemVersion: string;\n"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"theme",children:(0,n.jsx)(s.del,{children:"theme"})}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ts",children:"theme: DefaultTheme;\n"})})]})}function c(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},5676(e,s,t){t.d(s,{R:()=>a,x:()=>o});var i=t(758);const n={},r=i.createContext(n);function a(e){const s=i.useContext(r);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(n):e.components||n:a(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/6ca90961.9adc051a.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1650],{6489(e,t,n){n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>r,toc:()=>p});const r=JSON.parse('{"id":"api/functions/getLogger","title":"getLogger()","description":"Returns","source":"@site/docs/api/functions/getLogger.md","sourceDirName":"api/functions","slug":"/api/functions/getLogger","permalink":"/app-sdk/api/functions/getLogger","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getLogger.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getHostAppDataByKey()","permalink":"/app-sdk/api/functions/getHostAppDataByKey"},"next":{"title":"getMicroFrontEndAppConfig()","permalink":"/app-sdk/api/functions/getMicroFrontEndAppConfig"}}');var o=n(6070),i=n(5676);const s={},c="getLogger()",a={},p=[{value:"Returns",id:"returns",level:2}];function g(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"getlogger",children:"getLogger()"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"function getLogger(): MicroFrontEndLogger;\n"})}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"MicroFrontEndLogger"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(g,{...e})}):g(e)}},5676(e,t,n){n.d(t,{R:()=>s,x:()=>c});var r=n(758);const o={},i=r.createContext(o);function s(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(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/6d1f0509.d1f42df3.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8736],{9752(e,t,s){s.r(t),s.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/variables/GuestMicroApp","title":"GuestMicroApp","description":"Component to load a guest microapp.","source":"@site/docs/api/variables/GuestMicroApp.md","sourceDirName":"api/variables","slug":"/api/variables/GuestMicroApp","permalink":"/app-sdk/api/variables/GuestMicroApp","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/GuestMicroApp.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"FormPropsContext","permalink":"/app-sdk/api/variables/FormPropsContext"},"next":{"title":"MASK\\\\_PIPES","permalink":"/app-sdk/api/variables/MASK_PIPES"}}');var n=s(6070),i=s(5676);const o={},a="GuestMicroApp",p={},c=[{value:"Param",id:"param",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"guestmicroapp",children:"GuestMicroApp"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:'const GuestMicroApp: NamedExoticComponent<Omit<GuestMicroAppParams, "containerId">>;\n'})}),"\n",(0,n.jsx)(t.p,{children:"Component to load a guest microapp."}),"\n",(0,n.jsxs)(t.p,{children:["For guests with ",(0,n.jsx)(t.code,{children:"selfInitialize: true"}),", the host must register a module\nscripting object (via ",(0,n.jsx)(t.a,{href:"/app-sdk/api/functions/createGuestModule",children:"createGuestModule"})," or a ",(0,n.jsx)(t.a,{href:"/app-sdk/api/classes/GuestModule",children:"GuestModule"}),"\nsubclass) through ",(0,n.jsx)(t.a,{href:"/app-sdk/api/classes/CMicroAppGuest#addscriptingobject",children:"CMicroApp.addScriptingObject"})," before rendering\nthis component, and remove it on teardown. Host-provided ",(0,n.jsx)(t.code,{children:"theme"})," and\n",(0,n.jsx)(t.code,{children:"history"})," for self-initializing guests belong on that module SO \u2014 not on\nGuestMicroApp / OpenAppParams."]}),"\n",(0,n.jsxs)(t.p,{children:["When this app is itself a nested guest (running inside a parent iframe),\nGuestMicroApp automatically forwards the shared grandparent history\nto child guests \u2014 callers do not need to pass ",(0,n.jsx)(t.code,{children:"history"})," explicitly."]}),"\n",(0,n.jsx)(t.h2,{id:"param",children:"Param"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.strong,{children:"props"})}),"\n",(0,n.jsx)(t.p,{children:"The props for the MicroApp component."})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},5676(e,t,s){s.d(t,{R:()=>o,x:()=>a});var r=s(758);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.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(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/6daa33e8.1fb97c28.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9422],{4459(e,t,n){n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/getSelectField","title":"getSelectField()","description":"Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store","source":"@site/docs/api/functions/getSelectField.md","sourceDirName":"api/functions","slug":"/api/functions/getSelectField","permalink":"/app-sdk/api/functions/getSelectField","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getSelectField.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getRedirectUrl()","permalink":"/app-sdk/api/functions/getRedirectUrl"},"next":{"title":"getStore()","permalink":"/app-sdk/api/functions/getStore"}}');var o=n(6070),i=n(5676);const r={},l="getSelectField()",a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"stateName",id:"statename",level:3},{value:"Returns",id:"returns",level:2},{value:"Description",id:"description",level:2},{value:"Example",id:"example",level:3}];function d(e){const t={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"getselectfield",children:"getSelectField()"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"function getSelectField(stateName: string): (fieldName: string | string[], defaultValue: unknown) => (state: {\n}, stateValue: unknown) => unknown;\n"})}),"\n",(0,o.jsx)(t.p,{children:"Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store\nhence making it easier and keeping your codebase smaller and easier to maintain."}),"\n",(0,o.jsx)(t.p,{children:"For this to work as expected, ensure you always select ONLY what you need. Don't select state objects that contain fields that you won't use, if you do so\nthen everytime any of those gets updated it will trigger a rerender even though you're not actually using that field."}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(t.h3,{id:"statename",children:"stateName"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"string"})}),"\n",(0,o.jsx)(t.p,{children:"the redux store's state name of the state you want to access."}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(t.p,{children:["A ",(0,o.jsx)(t.em,{children:"selectField"})," function that returns a selector function to be used inside a ",(0,o.jsx)(t.em,{children:"useSelector"})," hook or a ",(0,o.jsx)(t.em,{children:"select"})," side effect"]}),"\n",(0,o.jsxs)(t.p,{children:["(",(0,o.jsx)(t.code,{children:"fieldName"}),": ",(0,o.jsx)(t.code,{children:"string"})," | ",(0,o.jsx)(t.code,{children:"string"}),"[], ",(0,o.jsx)(t.code,{children:"defaultValue"}),": ",(0,o.jsx)(t.code,{children:"unknown"}),") => (",(0,o.jsx)(t.code,{children:"state"}),": {\n}, ",(0,o.jsx)(t.code,{children:"stateValue"}),": ",(0,o.jsx)(t.code,{children:"unknown"}),") => ",(0,o.jsx)(t.code,{children:"unknown"})]}),"\n",(0,o.jsx)(t.h2,{id:"description",children:"Description"}),"\n",(0,o.jsx)(t.p,{children:"Generic Redux State Selector Helper."}),"\n",(0,o.jsx)(t.h3,{id:"example",children:"Example"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-javascript",children:"// reducer.js\nimport { getSelectField } from 'elliemae/pui-app-sdk';\n\nconst name = 'someState';\nexport selectSomeState = getSelectField(name);\n\n// use-some-state.js hook. NOTE: You can create a hook for each main state\nimport { selectSomeState } from 'slices/some-slice';\nimport { useSelector, shallowEqual } from 'react-redux';\n\nexport const useSelectSomeState = (fieldName, defaultValue) => {\n const finalDefaultValue = useMemo(() => defaultValue, []);\n useSelector(selectSomeState(fieldName, finalDefaultValue), shallowEqual);\n}\n\n// some-component.js\nimport { useSelectSomeState } from 'custom-hooks/state-selectors.js'\n\nexport const SomeComponent = () => {\n  const someField = useSelectSomeState('someField');\n  ...\n}\nexport const SomeOtherComponent = () => {\n  const someSubField = useSelectSomeState('someField.someSubField');\n  ...\n}\nexport const AnotherComponent = () => {\n  const [firstField, secondField, thirdField] = useSelectSomeState(['firstField', 'secondField', 'thirdField']);\n  ...\n}\n\n"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},5676(e,t,n){n.d(t,{R:()=>r,x:()=>l});var s=n(758);const o={},i=s.createContext(o);function r(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/749b3cb7.3801df4d.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7884],{7140(e,t,a){a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>n,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/variables/createSideEffect","title":"createSideEffect","description":"Creates a new side effect listener.","source":"@site/docs/api/variables/createSideEffect.md","sourceDirName":"api/variables","slug":"/api/variables/createSideEffect","permalink":"/app-sdk/api/variables/createSideEffect","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/createSideEffect.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"clearSideEffects","permalink":"/app-sdk/api/variables/clearSideEffects"},"next":{"title":"decorators","permalink":"/app-sdk/api/variables/decorators"}}');var i=a(6070),s=a(5676);const n={},c="createSideEffect",o={},d=[];function p(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"createsideeffect",children:"createSideEffect"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"const createSideEffect: TypedAddListener<CombinedState<{\n  breakpoint: BreakpointState;\n  error: ErrorState;\n  liveMessage: LiveMessageState;\n  waitMessage: WaitMessageState;\n}>, AppDispatch>;\n"})}),"\n",(0,i.jsx)(t.p,{children:"Creates a new side effect listener.\nAlternative API for adding listeners."})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5676(e,t,a){a.d(t,{R:()=>n,x:()=>c});var r=a(758);const i={},s=r.createContext(i);function n(e){const t=r.useContext(s);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:n(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/77982fdd.2c32b564.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6550],{8480(e,s,n){n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/functions/setSessionTimeoutInterval","title":"setSessionTimeoutInterval()","description":"Allows developers to provide a custom value for session expiry.","source":"@site/docs/api/functions/setSessionTimeoutInterval.md","sourceDirName":"api/functions","slug":"/api/functions/setSessionTimeoutInterval","permalink":"/app-sdk/api/functions/setSessionTimeoutInterval","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/setSessionTimeoutInterval.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setLoginParams()","permalink":"/app-sdk/api/functions/setLoginParams"},"next":{"title":"subscribeToResetSession()","permalink":"/app-sdk/api/functions/subscribeToResetSession"}}');var t=n(6070),r=n(5676);const o={},a="setSessionTimeoutInterval()",l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Customize",id:"customize",level:3},{value:"sessionExpiryInterval",id:"sessionexpiryinterval",level:4},{value:"sessionWarnInterval",id:"sessionwarninterval",level:4},{value:"Returns",id:"returns",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"setsessiontimeoutinterval",children:"setSessionTimeoutInterval()"})}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ts",children:"function setSessionTimeoutInterval(Customize: {\n  sessionExpiryInterval: number;\n  sessionWarnInterval: number;\n}): void;\n"})}),"\n",(0,t.jsx)(s.p,{children:"Allows developers to provide a custom value for session expiry."}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(s.h3,{id:"customize",children:"Customize"}),"\n",(0,t.jsx)(s.p,{children:"session timeout warn and expiry intervals"}),"\n",(0,t.jsx)(s.h4,{id:"sessionexpiryinterval",children:"sessionExpiryInterval"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"number"})," = ",(0,t.jsx)(s.code,{children:"MIN_SESSION_TIMEOUT"})]}),"\n",(0,t.jsx)(s.h4,{id:"sessionwarninterval",children:"sessionWarnInterval"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"number"})," = ",(0,t.jsx)(s.code,{children:"DEFAULT_SESSION_WARN"})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},5676(e,s,n){n.d(s,{R:()=>o,x:()=>a});var i=n(758);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.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(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/78fde597.c9c25e7e.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4658],{1629(e,n,i){i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"api/functions/configureStore","title":"configureStore()","description":"Creates and configures the Redux store with SDK middleware and enhancers.","source":"@site/docs/api/functions/configureStore.md","sourceDirName":"api/functions","slug":"/api/functions/configureStore","permalink":"/app-sdk/api/functions/configureStore","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/configureStore.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"cleanup()","permalink":"/app-sdk/api/functions/cleanup"},"next":{"title":"createGuestModule()","permalink":"/app-sdk/api/functions/createGuestModule"}}');var t=i(6070),d=i(5676);const s={},c="configureStore()",o={},a=[{value:"Parameters",id:"parameters",level:2},{value:"initialState?",id:"initialstate",level:3},{value:"history",id:"history",level:3},{value:"middlewareConfig?",id:"middlewareconfig",level:3},{value:"injectedReducers?",id:"injectedreducers",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,d.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"configurestore",children:"configureStore()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function configureStore(\n   initialState?: CombinedState, \n   history: History, \n   middlewareConfig?: MiddlewareConfig, \n   injectedReducers?: InjectedReducers): 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,t.jsx)(n.p,{children:"Creates and configures the Redux store with SDK middleware and enhancers.\nIncludes saga middleware, listener middleware, RTK Query support, and hot reloading."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"initialstate",children:"initialState?"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"CombinedState"})," = ",(0,t.jsx)(n.code,{children:"..."})]}),"\n",(0,t.jsx)(n.p,{children:"Initial Redux state (defaults to empty object)"}),"\n",(0,t.jsx)(n.h3,{id:"history",children:"history"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"History"})}),"\n",(0,t.jsx)(n.p,{children:"History instance for routing integration"}),"\n",(0,t.jsx)(n.h3,{id:"middlewareconfig",children:"middlewareConfig?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"MiddlewareConfig"})}),"\n",(0,t.jsx)(n.p,{children:"Middleware configuration options"}),"\n",(0,t.jsx)(n.h3,{id:"injectedreducers",children:"injectedReducers?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"InjectedReducers"})}),"\n",(0,t.jsx)(n.p,{children:"Pre-injected reducers"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ToolkitStore"}),"<",(0,t.jsx)(n.code,{children:"EmptyObject"})," & {\n",(0,t.jsx)(n.code,{children:"breakpoint"}),": ",(0,t.jsx)(n.code,{children:"BreakpointState"}),";\n",(0,t.jsx)(n.code,{children:"error"}),": ",(0,t.jsx)(n.code,{children:"ErrorState"}),";\n",(0,t.jsx)(n.code,{children:"liveMessage"}),": ",(0,t.jsx)(n.code,{children:"LiveMessageState"}),";\n",(0,t.jsx)(n.code,{children:"waitMessage"}),": ",(0,t.jsx)(n.code,{children:"WaitMessageState"}),";\n},\n| ",(0,t.jsx)(n.code,{children:"AnyAction"}),"\n| {\n",(0,t.jsx)(n.code,{children:"payload"}),": ",(0,t.jsx)(n.code,{children:"WaitMessageState"}),";\n",(0,t.jsx)(n.code,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"string"}),";\n}\n| {\n",(0,t.jsx)(n.code,{children:"payload"}),": ",(0,t.jsx)(n.code,{children:"Breakpoints"}),";\n",(0,t.jsx)(n.code,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"string"}),";\n}, ",(0,t.jsx)(n.code,{children:"MiddlewareArray"}),"<[",(0,t.jsx)(n.code,{children:"ListenerMiddleware"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),", ",(0,t.jsx)(n.code,{children:"ThunkDispatch"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),", ",(0,t.jsx)(n.code,{children:"unknown"}),", ",(0,t.jsx)(n.code,{children:"AnyAction"}),">, ",(0,t.jsx)(n.code,{children:"unknown"}),">, ",(0,t.jsx)(n.code,{children:"ThunkMiddleware"}),"<",(0,t.jsx)(n.code,{children:"CombinedState"}),"<{\n",(0,t.jsx)(n.code,{children:"breakpoint"}),": ",(0,t.jsx)(n.code,{children:"BreakpointState"}),";\n",(0,t.jsx)(n.code,{children:"error"}),": ",(0,t.jsx)(n.code,{children:"ErrorState"}),";\n",(0,t.jsx)(n.code,{children:"liveMessage"}),": ",(0,t.jsx)(n.code,{children:"LiveMessageState"}),";\n",(0,t.jsx)(n.code,{children:"waitMessage"}),": ",(0,t.jsx)(n.code,{children:"WaitMessageState"}),";\n}>, ",(0,t.jsx)(n.code,{children:"AnyAction"}),">, ...(SagaMiddleware<object> | Middleware<any, any, Dispatch<AnyAction>>)[]]>>"]}),"\n",(0,t.jsx)(n.p,{children:"Configured Redux store"}),"\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:"import { createAppStore, history } from '@elliemae/pui-app-sdk';\n\nconst store = createAppStore({}, history);\n"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},5676(e,n,i){i.d(n,{R:()=>s,x:()=>c});var r=i(758);const t={},d=r.createContext(t);function s(e){const n=r.useContext(d);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/7b224b5a.49839087.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[2612],{9557(e,t,n){n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"api/functions/waitForElementToBeRemoved","title":"waitForElementToBeRemoved()","description":"Type Parameters","source":"@site/docs/api/functions/waitForElementToBeRemoved.md","sourceDirName":"api/functions","slug":"/api/functions/waitForElementToBeRemoved","permalink":"/app-sdk/api/functions/waitForElementToBeRemoved","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/waitForElementToBeRemoved.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"waitFor()","permalink":"/app-sdk/api/functions/waitFor"},"next":{"title":"withAppDecorator()","permalink":"/app-sdk/api/functions/withAppDecorator"}}');var i=n(6070),r=n(5676);const s={},a="waitForElementToBeRemoved()",l={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"callback",id:"callback",level:3},{value:"options?",id:"options",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,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"waitforelementtoberemoved",children:"waitForElementToBeRemoved()"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"function waitForElementToBeRemoved<T>(callback: T | (() => T), options?: waitForOptions): Promise<void>;\n"})}),"\n",(0,i.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsx)(t.h3,{id:"t",children:"T"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"T"})}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(t.h3,{id:"callback",children:"callback"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"T"})," | (() => ",(0,i.jsx)(t.code,{children:"T"}),")"]}),"\n",(0,i.jsx)(t.h3,{id:"options",children:"options?"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"waitForOptions"})}),"\n",(0,i.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"Promise"}),"<",(0,i.jsx)(t.code,{children:"void"}),">"]})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5676(e,t,n){n.d(t,{R:()=>s,x:()=>a});var o=n(758);const i={},r=o.createContext(i);function s(e){const t=o.useContext(r);return o.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:s(e.components),o.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/7c822e85.5f82c723.js

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

package/build/docs/assets/js/7cde3459.3992ad5e.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[763],{8641(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>p});const r=JSON.parse('{"id":"api/functions/DateInput","title":"DateInput()","description":"Parameters","source":"@site/docs/api/functions/DateInput.md","sourceDirName":"api/functions","slug":"/api/functions/DateInput","permalink":"/app-sdk/api/functions/DateInput","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/DateInput.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ConnectForm()","permalink":"/app-sdk/api/functions/ConnectForm"},"next":{"title":"DatePicker()","permalink":"/app-sdk/api/functions/DatePicker"}}');var a=n(6070),s=n(5676);const i={},o="DateInput()",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:"dateinput",children:"DateInput()"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"function DateInput(__namedParameters: DateInputProps): 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:"DateInputProps"})}),"\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 u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},5676(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/7d256524.018f89e2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9304],{7832(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/functions/getAuthorizationHeader","title":"getAuthorizationHeader()","description":"Gets the current authorization header value from session storage.","source":"@site/docs/api/functions/getAuthorizationHeader.md","sourceDirName":"api/functions","slug":"/api/functions/getAuthorizationHeader","permalink":"/app-sdk/api/functions/getAuthorizationHeader","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getAuthorizationHeader.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getAuthHTTPClient()","permalink":"/app-sdk/api/functions/getAuthHTTPClient"},"next":{"title":"getHTTPClient()","permalink":"/app-sdk/api/functions/getHTTPClient"}}');var i=n(6070),a=n(5676);const o={},s="getAuthorizationHeader()",c={},d=[{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function u(e){const t={code:"code",h1:"h1",h2:"h2",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:"getauthorizationheader",children:"getAuthorizationHeader()"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"function getAuthorizationHeader(): string;\n"})}),"\n",(0,i.jsx)(t.p,{children:"Gets the current authorization header value from session storage."}),"\n",(0,i.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"string"})}),"\n",(0,i.jsx)(t.p,{children:"The authorization header string (e.g., 'Bearer token...') or empty string if not found"}),"\n",(0,i.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"const authHeader = getAuthorizationHeader();\n// 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},5676(e,t,n){n.d(t,{R:()=>o,x:()=>s});var r=n(758);const i={},a=r.createContext(i);function o(e){const t=r.useContext(a);return r.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(i):e.components||i:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/7d48b3e7.ddf209b8.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7603],{8817(e,t,s){s.r(t),s.d(t,{assets:()=>i,contentTitle:()=>p,default:()=>d,frontMatter:()=>o,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"api/variables/useAppSelector","title":"useAppSelector","description":"React hook to select data from Redux store with type safety.","source":"@site/docs/api/variables/useAppSelector.md","sourceDirName":"api/variables","slug":"/api/variables/useAppSelector","permalink":"/app-sdk/api/variables/useAppSelector","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/useAppSelector.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"updateBAEventParameters","permalink":"/app-sdk/api/variables/updateBAEventParameters"},"next":{"title":"waitMessageAction","permalink":"/app-sdk/api/variables/waitMessageAction"}}');var r=s(6070),n=s(5676);const o={},p="useAppSelector",i={},c=[{value:"Example",id:"example",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"useappselector",children:"useAppSelector"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"const useAppSelector: TypedUseSelectorHook<RootState> = useSelector;\n"})}),"\n",(0,r.jsx)(t.p,{children:"React hook to select data from Redux store with type safety.\nAutomatically typed to the app's RootState."}),"\n",(0,r.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"function UserProfile() {\n  const user = useAppSelector(state => state.user.profile);\n  const isLoading = useAppSelector(state => state.user.loading);\n\n  return <div>{user?.name}</div>;\n}\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},5676(e,t,s){s.d(t,{R:()=>o,x:()=>p});var a=s(758);const r={},n=a.createContext(r);function o(e){const t=a.useContext(n);return a.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function p(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/80392bdc.6bf9ce42.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[860],{7713(e,t,s){s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>n,toc:()=>p});const n=JSON.parse('{"id":"api/interfaces/UseStateSelectorOptions","title":"UseStateSelectorOptions\\\\<Selected\\\\>","description":"Type Parameters","source":"@site/docs/api/interfaces/UseStateSelectorOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/UseStateSelectorOptions","permalink":"/app-sdk/api/interfaces/UseStateSelectorOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/UseStateSelectorOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"GuestProps\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/interfaces/GuestProps"},"next":{"title":"AppDispatch","permalink":"/app-sdk/api/type-aliases/AppDispatch"}}');var a=s(6070),r=s(5676);const i={},l="UseStateSelectorOptions<Selected>",c={},p=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Selected",id:"selected",level:3},{value:"Properties",id:"properties",level:2},{value:"defaultValue?",id:"defaultvalue",level:3},{value:"equalityFn?",id:"equalityfn",level:3}];function o(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"usestateselectoroptionsselected",children:"UseStateSelectorOptions<Selected>"})}),"\n",(0,a.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"selected",children:"Selected"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"Selected"})," = ",(0,a.jsx)(t.code,{children:"unknown"})]}),"\n",(0,a.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(t.h3,{id:"defaultvalue",children:"defaultValue?"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"optional defaultValue?: Selected | Selected[];\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"equalityfn",children:"equalityFn?"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"optional equalityFn?: EqualityFn<Selected>;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},5676(e,t,s){s.d(t,{R:()=>i,x:()=>l});var n=s(758);const a={},r=n.createContext(a);function i(e){const t=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/805daf1e.45fbac81.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[619],{5653(e,t,a){a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/variables/MASK_TYPES","title":"MASK\\\\_TYPES","description":"","source":"@site/docs/api/variables/MASK_TYPES.md","sourceDirName":"api/variables","slug":"/api/variables/MASK_TYPES","permalink":"/app-sdk/api/variables/MASK_TYPES","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/MASK_TYPES.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"MASK\\\\_PIPES","permalink":"/app-sdk/api/variables/MASK_PIPES"},"next":{"title":"~~MicroApp~~","permalink":"/app-sdk/api/variables/MicroApp"}}');var r=a(6070),s=a(5676);const i={},o="MASK_TYPES",p={},c=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"mask_types",children:"MASK_TYPES"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"const MASK_TYPES: Record<string, any>;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},5676(e,t,a){a.d(t,{R:()=>i,x:()=>o});var n=a(758);const r={},s=n.createContext(r);function i(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(r):e.components||r:i(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/82894961.018f2afc.js

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

package/build/docs/assets/js/85dc4c9b.c59a27b3.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[311],{6987(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/renderWithRouter","title":"renderWithRouter()","description":"Parameters","source":"@site/docs/api/functions/renderWithRouter.md","sourceDirName":"api/functions","slug":"/api/functions/renderWithRouter","permalink":"/app-sdk/api/functions/renderWithRouter","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/renderWithRouter.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"renderWithRedux()","permalink":"/app-sdk/api/functions/renderWithRedux"},"next":{"title":"renderWithRouterRedux()","permalink":"/app-sdk/api/functions/renderWithRouterRedux"}}');var s=l(6070),t=l(5676);const a={},i="renderWithRouter()",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:"history",id:"history",level:3},{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:"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:"renderwithrouter",children:"renderWithRouter()"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"function renderWithRouter(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  history: History;\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  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  history: History;\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  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:"history",children:"history"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"history: History;\n"})}),"\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:"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)}},5676(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/88a4c043.e0fa8644.js

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

package/build/docs/assets/js/90579cbd.2e5eb6fd.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7390],{5098(e,t,n){n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"api/variables/logout","title":"logout","description":"Type Declaration","source":"@site/docs/api/variables/logout.md","sourceDirName":"api/variables","slug":"/api/variables/logout","permalink":"/app-sdk/api/variables/logout","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/logout.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"httpClientProps","permalink":"/app-sdk/api/variables/httpClientProps"},"next":{"title":"memoryHistory","permalink":"/app-sdk/api/variables/memoryHistory"}}');var o=n(6070),r=n(5676);const i={},s="logout",l={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"CANCEL",id:"cancel",level:3},{value:"CONFIRM",id:"confirm",level:3}];function d(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",pre:"pre",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"logout",children:"logout"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"const logout: {\n  CANCEL: string;\n  CONFIRM: string;\n};\n"})}),"\n",(0,o.jsx)(t.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,o.jsx)(t.h3,{id:"cancel",children:"CANCEL"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"CANCEL: string = 'log-out/CANCEL';\n"})}),"\n",(0,o.jsx)(t.h3,{id:"confirm",children:"CONFIRM"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"CONFIRM: string = 'log-out/CONFIRM';\n"})})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>s});var a=n(758);const o={},r=a.createContext(o);function i(e){const t=a.useContext(r);return a.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(o):e.components||o:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]);