npm - @elliemae/pui-app-sdk - Versions diffs - 5.48.0 → 5.48.2 - Mend

@elliemae/pui-app-sdk 5.48.0 → 5.48.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (525) hide show

package/build/docs/assets/js/b31a5f55.e8e9d964.js ADDED Viewed

@@ -0,0 +1 @@

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

@@ -0,0 +1 @@

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

package/build/docs/assets/js/b784b5bb.1adc5f17.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/b8c1226b.873c2507.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/b93b454c.aa2eb388.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/bc717899.ca07cd54.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9245],{9420(e,t,s){s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});const a=JSON.parse('{"id":"api/variables/startSideEffect","title":"startSideEffect","description":"Starts a side effect listener.","source":"@site/docs/api/variables/startSideEffect.md","sourceDirName":"api/variables","slug":"/api/variables/startSideEffect","permalink":"/app-sdk/api/variables/startSideEffect","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/startSideEffect.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"screen","permalink":"/app-sdk/api/variables/screen"},"next":{"title":"updateBAEventParameters","permalink":"/app-sdk/api/variables/updateBAEventParameters"}}');var n=s(6070),r=s(5676);const i={},c="startSideEffect",o={},d=[{value:"Example",id:"example",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"startsideeffect",children:"startSideEffect"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"const startSideEffect: AppStartListening;\n"})}),"\n",(0,n.jsx)(t.p,{children:"Starts a side effect listener.\nUsed to listen for specific actions and execute side effects."}),"\n",(0,n.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-typescript",children:"startSideEffect({\n actionCreator: userActions.loginSuccess,\n effect: async (action, listenerApi) => {\n console.log('User logged in:', action.payload);\n }\n});\n"})})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},5676(e,t,s){s.d(t,{R:()=>i,x:()=>c});var a=s(758);const n={},r=a.createContext(n);function i(e){const t=a.useContext(r);return a.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),a.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/bf1a96cc.1588e912.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4762],{2868(e,n,r){r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/functions/authorize","title":"authorize()","description":"Handles the OAuth authorization callback after redirect from IDP.","source":"@site/docs/api/functions/authorize.md","sourceDirName":"api/functions","slug":"/api/functions/authorize","permalink":"/app-sdk/api/functions/authorize","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/authorize.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"authSaga()","permalink":"/app-sdk/api/functions/authSaga"},"next":{"title":"buildModuleParams()","permalink":"/app-sdk/api/functions/buildModuleParams"}}');var s=r(6070),t=r(5676);const c={},o="authorize()",a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"clientId",id:"clientid",level:4},{value:"code",id:"code",level:4},{value:"isConsumerUser",id:"isconsumeruser",level:4},{value:"redirectUri",id:"redirecturi",level:4},{value:"responseType",id:"responsetype",level:4},{value:"scope",id:"scope",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,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"authorize",children:"authorize()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function authorize(params: {\n clientId: string;\n code: string;\n isConsumerUser: boolean;\n redirectUri: string;\n responseType: string;\n scope: string;\n}): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Handles the OAuth authorization callback after redirect from IDP.\nExchanges authorization code for access token and initializes user session."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,s.jsx)(n.p,{children:"Authorization parameters"}),"\n",(0,s.jsx)(n.h4,{id:"clientid",children:"clientId"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth client ID"}),"\n",(0,s.jsx)(n.h4,{id:"code",children:"code"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Authorization code from IDP"}),"\n",(0,s.jsx)(n.h4,{id:"isconsumeruser",children:"isConsumerUser"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"Whether user is a consumer user"}),"\n",(0,s.jsx)(n.h4,{id:"redirecturi",children:"redirectUri"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"Redirect URI used in OAuth flow"}),"\n",(0,s.jsx)(n.h4,{id:"responsetype",children:"responseType"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth response type"}),"\n",(0,s.jsx)(n.h4,{id:"scope",children:"scope"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth scopes"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"await authorize({\n clientId: 'my-app',\n code: 'auth-code-from-url',\n redirectUri: window.location.origin,\n scope: 'openid',\n responseType: 'code',\n isConsumerUser: false\n});\n"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},5676(e,n,r){r.d(n,{R:()=>c,x:()=>o});var i=r(758);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);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(s):e.components||s:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/c10ec81d.55d7b9a5.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4636],{9519(e,n,r){r.r(n),r.d(n,{assets:()=>p,contentTitle:()=>t,default:()=>o,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/useAppMiddleware","title":"useAppMiddleware()","description":"Parameters","source":"@site/docs/api/functions/useAppMiddleware.md","sourceDirName":"api/functions","slug":"/api/functions/useAppMiddleware","permalink":"/app-sdk/api/functions/useAppMiddleware","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useAppMiddleware.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useAppDispatch()","permalink":"/app-sdk/api/functions/useAppDispatch"},"next":{"title":"useInjectQuery()","permalink":"/app-sdk/api/functions/useInjectQuery"}}');var d=r(6070),i=r(5676);const a={},t="useAppMiddleware()",p={},c=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"key",id:"key",level:4},{value:"middleware",id:"middleware",level:4},{value:"Returns",id:"returns",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"useappmiddleware",children:"useAppMiddleware()"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"function useAppMiddleware(__namedParameters: {\n key: string;\n middleware: Middleware<any, any>;\n}): void;\n"})}),"\n",(0,d.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,d.jsx)(n.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,d.jsx)(n.h4,{id:"key",children:"key"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"string"})}),"\n",(0,d.jsx)(n.h4,{id:"middleware",children:"middleware"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Middleware"}),"<",(0,d.jsx)(n.code,{children:"any"}),", ",(0,d.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,d.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})})]})}function o(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},5676(e,n,r){r.d(n,{R:()=>a,x:()=>t});var s=r(758);const d={},i=s.createContext(d);function a(e){const n=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/c254daed.662451bc.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[449],{2633(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>p});const o=JSON.parse('{"id":"api/functions/TextBox","title":"TextBox()","description":"Text input field component with React Hook Form integration.","source":"@site/docs/api/functions/TextBox.md","sourceDirName":"api/functions","slug":"/api/functions/TextBox","permalink":"/app-sdk/api/functions/TextBox","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/TextBox.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"SessionTimeout()","permalink":"/app-sdk/api/functions/SessionTimeout"},"next":{"title":"Toggle()","permalink":"/app-sdk/api/functions/Toggle"}}');var r=t(6070),i=t(5676);const s={},a="TextBox()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"props",id:"props",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"textbox",children:"TextBox()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function TextBox(props: TextBoxProps): Element;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Text input field component with React Hook Form integration.\nWraps the Dimsum TextBox component with form state management and validation."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"props",children:"props"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"TextBoxProps"})}),"\n",(0,r.jsx)(n.p,{children:"TextBox component props"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Element"})}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-tsx",children:'<Form onSubmit={handleSubmit}>\n <TextBox\n name="firstName"\n label="First Name"\n placeholder="Enter your first name"\n rules={{\n required: \'First name is required\',\n minLength: { value: 2, message: \'Minimum 2 characters\' }\n }}\n />\n</Form>\n'})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},5676(e,n,t){t.d(n,{R:()=>s,x:()=>a});var o=t(758);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/c377a04b.662ff551.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[3361],{2785(e,n,i){i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"index","title":"Getting Started","description":"Welcome to the PUI App SDK - the ICE MT UI Platform Application SDK for building React micro-frontend applications with integrated cross-cutting concerns.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/app-sdk/","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"within","permalink":"/app-sdk/api/variables/within"},"next":{"title":"Usage Guide","permalink":"/app-sdk/usage-guide"}}');var r=i(6070),s=i(5676);const o={},a="Getting Started",c={},l=[{value:"Overview",id:"overview",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"Installation",id:"installation",level:2},{value:"Required Peer Dependencies",id:"required-peer-dependencies",level:3},{value:"Quick Start",id:"quick-start",level:2},{value:"1. Create App Configuration",id:"1-create-app-configuration",level:3},{value:"2. Initialize Your Micro-App",id:"2-initialize-your-micro-app",level:3},{value:"3. Set Up Application Root",id:"3-set-up-application-root",level:3},{value:"4. Define Routes",id:"4-define-routes",level:3},{value:"Core Concepts",id:"core-concepts",level:2},{value:"API Integration",id:"api-integration",level:3},{value:"State Management",id:"state-management",level:3},{value:"Making API Calls",id:"making-api-calls",level:3},{value:"Forms",id:"forms",level:3},{value:"Micro-Frontends",id:"micro-frontends",level:3},{value:"Analytics & Scripting Objects",id:"analytics--scripting-objects",level:3},{value:"Testing",id:"testing",level:2},{value:"Project Structure",id:"project-structure",level:2},{value:"Next Steps",id:"next-steps",level:2},{value:"Resources",id:"resources",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2}];function d(e){const n={a:"a",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"getting-started",children:"Getting Started"})}),"\n",(0,r.jsxs)(n.p,{children:["Welcome to the ",(0,r.jsx)(n.strong,{children:"PUI App SDK"})," - the ICE MT UI Platform Application SDK for building React micro-frontend applications with integrated cross-cutting concerns."]}),"\n",(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"The PUI App SDK provides:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Micro-Frontend Architecture"})," - CMicroApp guest/host lifecycle, navigation links, inter-app communication"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"API Integration"})," - RTK Query with automatic caching and auth, plus legacy HTTP client with 401 retry"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"State Management"})," - Redux Toolkit with dynamic injection, listener middleware, and error middleware"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Form Management"})," - React Hook Form integration with input masks, date pickers, combos, and layout components"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Analytics & LogRocket"})," - Business analytics tracking with automatic LogRocket identification, event buffering, and throttling"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Authentication"})," - OAuth/IDP login, session management, automatic LogRocket identity lifecycle, and auth subpath helpers"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Session Management"})," - Idle timeout, expiry warnings, session renewal, and ready-made UI components"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Testing Utilities"})," - ",(0,r.jsx)(n.code,{children:"renderWithRedux"}),", ",(0,r.jsx)(n.code,{children:"renderWithRouter"}),", Testing Library re-exports, and ",(0,r.jsx)(n.code,{children:"RenderWithStateAddOns"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Environment & Utilities"})," - Environment detection, URL helpers, themes, PII redaction, and TypeScript decorators"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Node.js"}),": Version 20 or higher"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"pnpm"}),": Version 8 or higher"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"React"}),": Compatible with ",(0,r.jsx)(n.code,{children:"@elliemae/app-react-dependencies ^4.26.0"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"pnpm add @elliemae/pui-app-sdk\n"})}),"\n",(0,r.jsx)(n.h3,{id:"required-peer-dependencies",children:"Required Peer Dependencies"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"pnpm add @elliemae/app-react-dependencies \\\n @elliemae/pui-app-bridge \\\n @elliemae/pui-theme \\\n @elliemae/ssf-guest \\\n @elliemae/ssf-host\n"})}),"\n",(0,r.jsx)(n.h2,{id:"quick-start",children:"Quick Start"}),"\n",(0,r.jsx)(n.h3,{id:"1-create-app-configuration",children:"1. Create App Configuration"}),"\n",(0,r.jsxs)(n.p,{children:["Create ",(0,r.jsx)(n.code,{children:"app.config.json"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "appId": "your-app-id",\n "activeEnv": "localhost",\n "sessionTimeoutWarnInterval": "7200000",\n "sessionTimeoutInterval": "9000000",\n "serviceEndpoints": {\n "api": "https://api.example.com"\n }\n}\n'})}),"\n",(0,r.jsx)(n.h3,{id:"2-initialize-your-micro-app",children:"2. Initialize Your Micro-App"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import {\n CMicroApp,\n configureStore,\n setAppConfig,\n listenStorageEvents,\n initServiceWorker,\n} from '@elliemae/pui-app-sdk';\nimport { createRoot } from 'react-dom/client';\nimport appConfig from './app.config.json';\nimport { logger } from './utils/logger'; // Your logger instance\n\n// Setup\nsetAppConfig(appConfig);\nlistenStorageEvents();\n\nlet app = null;\nlet store = null;\nlet root = null;\n\n// Lifecycle callbacks\nconst onInit = ({ history, homeRoute }) => {\n store = configureStore({}, history);\n};\n\nconst onMount = ({ containerId }) => {\n root = createRoot(document.getElementById(containerId));\n root.render(<Application />);\n};\n\nconst onUnmount = () => {\n root?.unmount();\n return null;\n};\n\n// Create micro-app instance\napp = CMicroApp.getInstance({\n logger,\n onInit,\n onMount,\n onUnmount,\n});\n\ninitServiceWorker('/base-path');\n"})}),"\n",(0,r.jsx)(n.h3,{id:"3-set-up-application-root",children:"3. Set Up Application Root"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { AppRoot } from '@elliemae/pui-app-sdk';\n\nexport const Application = () => {\n // app and store are defined in the initialization code above\n const appProps = app.getProps();\n\n return (\n <AppRoot\n store={store}\n history={appProps.history}\n theme={appProps.theme}\n manageSession\n >\n <AppRoutes />\n </AppRoot>\n );\n};\n"})}),"\n",(0,r.jsx)(n.h3,{id:"4-define-routes",children:"4. Define Routes"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { Routes, Route } from 'react-router-dom';\nimport { Page } from '@elliemae/pui-app-sdk';\n\nexport const AppRoutes = () => (\n <Routes>\n <Route path=\"/\" element={<Layout />}>\n <Route\n index\n element={\n <Page pageTitle=\"Dashboard\">\n <Dashboard />\n </Page>\n }\n />\n </Route>\n </Routes>\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"core-concepts",children:"Core Concepts"}),"\n",(0,r.jsx)(n.h3,{id:"api-integration",children:"API Integration"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Recommended"}),": Use RTK Query for seamless API integration:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { useInjectQuery } from '@elliemae/pui-app-sdk';\nimport { resourcesApi } from './api/resources';\n\nexport const Layout = () => {\n // Inject RTK Query API\n useInjectQuery({ api: resourcesApi });\n // ...\n};\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#api-integration-with-rtk-query",children:"\u2192 Learn more about RTK Query"})}),"\n",(0,r.jsx)(n.h3,{id:"state-management",children:"State Management"}),"\n",(0,r.jsx)(n.p,{children:"For non-API state, use Redux with dynamic injection:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { useInjectReducer, useInjectSaga } from '@elliemae/pui-app-sdk';\n\nexport const Layout = () => {\n useInjectReducer({ key: 'ui', reducer });\n useInjectSaga({ key: 'workflows', saga: workflowSagas });\n // ...\n};\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#state-management",children:"\u2192 Learn more about State Management"})}),"\n",(0,r.jsx)(n.h3,{id:"making-api-calls",children:"Making API Calls"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Recommended"}),": Use RTK Query for API integration with automatic caching, request deduplication, and loading states:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { createApi } from '@reduxjs/toolkit/query/react';\nimport { sdkBaseQuery } from '@elliemae/pui-app-sdk';\n\nexport const resourcesApi = createApi({\n reducerPath: 'resourcesApi',\n baseQuery: sdkBaseQuery({ baseUrl: '/v1' }),\n endpoints: (builder) => ({\n getResources: builder.query<Resource[], void>({\n query: () => ({ url: '/resources', method: 'GET' }),\n }),\n }),\n});\n\nexport const { useGetResourcesQuery } = resourcesApi;\n\n// Use in components\nconst { data, isLoading } = useGetResourcesQuery();\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#api-integration-with-rtk-query",children:"\u2192 Learn more about RTK Query API Integration"}),(0,r.jsx)(n.br,{}),"\n",(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#http-client-legacy",children:"\u2192 Legacy HTTP Client approach"})]}),"\n",(0,r.jsx)(n.h3,{id:"forms",children:"Forms"}),"\n",(0,r.jsx)(n.p,{children:"Build validated forms with React Hook Form:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { Form as SDKForm } from '@elliemae/pui-app-sdk';\n\n<SDKForm onSubmit={handleSubmit}>\n <FormFields />\n</SDKForm>;\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#form-management",children:"\u2192 Learn more about Forms"})}),"\n",(0,r.jsx)(n.h3,{id:"micro-frontends",children:"Micro-Frontends"}),"\n",(0,r.jsx)(n.p,{children:"Embed child applications:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { GuestMicroApp, history } from '@elliemae/pui-app-sdk';\n\n<GuestMicroApp id=\"child-app\" history={history} />;\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#micro-frontends",children:"\u2192 Learn more about Micro-Frontends"})}),"\n",(0,r.jsx)(n.h3,{id:"analytics--scripting-objects",children:"Analytics & Scripting Objects"}),"\n",(0,r.jsx)(n.p,{children:"Track events and communicate between apps:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { CMicroApp } from '@elliemae/pui-app-sdk';\n\nconst app = CMicroApp.getInstance();\nconst analytics = await app.getObject('analytics');\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#analytics",children:"\u2192 Learn more about Analytics"}),(0,r.jsx)(n.br,{}),"\n",(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#scripting-objects",children:"\u2192 Learn more about Scripting Objects"})]}),"\n",(0,r.jsx)(n.h2,{id:"testing",children:"Testing"}),"\n",(0,r.jsx)(n.p,{children:"The SDK provides testing helpers for components with Redux and Router:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { renderWithRedux } from '@elliemae/pui-app-sdk';\n\nrenderWithRedux(<MyComponent />, {\n initialState: { user: { name: 'John' } },\n});\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#testing",children:"\u2192 Learn more about Testing"})}),"\n",(0,r.jsx)(n.h2,{id:"project-structure",children:"Project Structure"}),"\n",(0,r.jsx)(n.p,{children:"Recommended structure for SDK-based applications:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-plaintext",children:"my-app/\n\u251c\u2500\u2500 app/\n\u2502 \u251c\u2500\u2500 api/ # RTK Query API definitions\n\u2502 \u251c\u2500\u2500 data/ # Redux slices (for non-API state)\n\u2502 \u251c\u2500\u2500 route/ # Route definitions\n\u2502 \u251c\u2500\u2500 sideeffect/ # Redux Sagas (for complex workflows)\n\u2502 \u251c\u2500\u2500 utils/ # Utility functions\n\u2502 \u251c\u2500\u2500 view/ # UI components\n\u2502 \u251c\u2500\u2500 app.config.json # App configuration\n\u2502 \u2514\u2500\u2500 index.tsx # Entry point\n\u2514\u2500\u2500 package.json\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#project-structure",children:"\u2192 See detailed structure in Usage Guide"})}),"\n",(0,r.jsx)(n.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide",children:"Usage Guide"})})," - Detailed examples and patterns"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"./api/",children:"API Documentation"})})," - Complete API reference"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Examples"})," - Run ",(0,r.jsx)(n.code,{children:"pnpm run storybook"})," to view component examples"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Boilerplate"})," - Check ",(0,r.jsx)(n.code,{children:"pui-react-boilerplate"})," for a complete working example"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"resources",children:"Resources"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide",children:"Usage Guide"})})," - Detailed usage patterns and examples"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"./api/",children:"API Documentation"})})," - Complete API reference"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://sonarqube.intcx.net/dashboard?id=pui-app-sdk-master",children:"SonarQube"})})," - Code quality metrics"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://appsdk.pui.mortgagetech.d1.ice.com/",children:"QA Environment"})})," - Test deployment"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Boilerplate"})," - Reference implementation in ",(0,r.jsx)(n.code,{children:"pui-react-boilerplate"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,r.jsxs)(n.p,{children:["For common issues and solutions, see the ",(0,r.jsx)(n.a,{href:"/app-sdk/usage-guide#troubleshooting",children:"Usage Guide Troubleshooting section"}),"."]})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},5676(e,n,i){i.d(n,{R:()=>o,x:()=>a});var t=i(758);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/c52b5473.fdf684e6.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[706],{6344(e,t,s){s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>l,frontMatter:()=>i,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/functions/setHostAppData","title":"setHostAppData()","description":"Type Parameters","source":"@site/docs/api/functions/setHostAppData.md","sourceDirName":"api/functions","slug":"/api/functions/setHostAppData","permalink":"/app-sdk/api/functions/setHostAppData","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/setHostAppData.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setAppConfigValue()","permalink":"/app-sdk/api/functions/setAppConfigValue"},"next":{"title":"setLoginParams()","permalink":"/app-sdk/api/functions/setLoginParams"}}');var a=s(6070),r=s(5676);const i={},p="setHostAppData()",o={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"appData",id:"appdata",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const t={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",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:"sethostappdata",children:"setHostAppData()"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"function setHostAppData<T>(appData: T): void;\n"})}),"\n",(0,a.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"t",children:"T"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"T"})," ",(0,a.jsx)(t.em,{children:"extends"})," ",(0,a.jsx)(t.code,{children:"Record"}),"<",(0,a.jsx)(t.code,{children:"string"}),", ",(0,a.jsx)(t.code,{children:"any"}),">"]}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"appdata",children:"appData"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"T"})}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"void"})})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},5676(e,t,s){s.d(t,{R:()=>i,x:()=>p});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 p(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/c5e9787b.3c92531e.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8915],{9352(e,t,n){n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>r});const s=JSON.parse('{"id":"api/functions/useAppDispatch","title":"useAppDispatch()","description":"React hook to get the typed dispatch function.","source":"@site/docs/api/functions/useAppDispatch.md","sourceDirName":"api/functions","slug":"/api/functions/useAppDispatch","permalink":"/app-sdk/api/functions/useAppDispatch","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useAppDispatch.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"trackActivity()","permalink":"/app-sdk/api/functions/trackActivity"},"next":{"title":"useAppMiddleware()","permalink":"/app-sdk/api/functions/useAppMiddleware"}}');var p=n(6070),i=n(5676);const c={},a="useAppDispatch()",o={},r=[{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(t.header,{children:(0,p.jsx)(t.h1,{id:"useappdispatch",children:"useAppDispatch()"})}),"\n",(0,p.jsx)(t.pre,{children:(0,p.jsx)(t.code,{className:"language-ts",children:"function useAppDispatch(): AppDispatch;\n"})}),"\n",(0,p.jsx)(t.p,{children:"React hook to get the typed dispatch function.\nProvides type-safe dispatching of Redux actions."}),"\n",(0,p.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,p.jsx)(t.p,{children:(0,p.jsx)(t.a,{href:"/app-sdk/api/type-aliases/AppDispatch",children:(0,p.jsx)(t.code,{children:"AppDispatch"})})}),"\n",(0,p.jsx)(t.p,{children:"Typed Redux dispatch function"}),"\n",(0,p.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,p.jsx)(t.pre,{children:(0,p.jsx)(t.code,{className:"language-typescript",children:"function MyComponent() {\n const dispatch = useAppDispatch();\n\n const handleClick = () => {\n dispatch(myAction());\n };\n\n return <button onClick={handleClick}>Click me</button>;\n}\n"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,p.jsx)(t,{...e,children:(0,p.jsx)(d,{...e})}):d(e)}},5676(e,t,n){n.d(t,{R:()=>c,x:()=>a});var s=n(758);const p={},i=s.createContext(p);function c(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(p):e.components||p:c(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/c7710052.15998b99.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/c8a9fc86.33752b34.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/c90572d4.3790df3d.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9269],{9361(e,n,s){s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/functions/subscribeToSessionExpiryWarning","title":"subscribeToSessionExpiryWarning()","description":"Registers a callback when idle time crosses the warn threshold.","source":"@site/docs/api/functions/subscribeToSessionExpiryWarning.md","sourceDirName":"api/functions","slug":"/api/functions/subscribeToSessionExpiryWarning","permalink":"/app-sdk/api/functions/subscribeToSessionExpiryWarning","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/subscribeToSessionExpiryWarning.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"subscribeToSessionExpiry()","permalink":"/app-sdk/api/functions/subscribeToSessionExpiry"},"next":{"title":"trackActivity()","permalink":"/app-sdk/api/functions/trackActivity"}}');var r=s(6070),t=s(5676);const o={},c="subscribeToSessionExpiryWarning()",a={},p=[{value:"Parameters",id:"parameters",level:2},{value:"onSessionExpiryWarn",id:"onsessionexpirywarn",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"subscribetosessionexpirywarning",children:"subscribeToSessionExpiryWarning()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function subscribeToSessionExpiryWarning(onSessionExpiryWarn: WARNLISTENER): (...args: []) => void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Registers a callback when idle time crosses the warn threshold."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"onsessionexpirywarn",children:"onSessionExpiryWarn"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"WARNLISTENER"})}),"\n",(0,r.jsx)(n.p,{children:"Timestamp the warning was shown."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:"Unsubscribe function."}),"\n",(0,r.jsxs)(n.p,{children:["(...",(0,r.jsx)(n.code,{children:"args"}),": []) => ",(0,r.jsx)(n.code,{children:"void"})]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},5676(e,n,s){s.d(n,{R:()=>o,x:()=>c});var i=s(758);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.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(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/cfad4bb4.dcae3bdb.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5547],{7239(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/variables/NavigationPromptActions","title":"NavigationPromptActions","description":"Type Declaration","source":"@site/docs/api/variables/NavigationPromptActions.md","sourceDirName":"api/variables","slug":"/api/variables/NavigationPromptActions","permalink":"/app-sdk/api/variables/NavigationPromptActions","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/NavigationPromptActions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"NavigationPrompt","permalink":"/app-sdk/api/variables/NavigationPrompt"},"next":{"title":"Themes","permalink":"/app-sdk/api/variables/Themes"}}');var a=t(6070),o=t(5676);const r={},s="NavigationPromptActions",c={},p=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"CANCEL",id:"cancel",level:3},{value:"CONFIRM",id:"confirm",level:3}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",pre:"pre",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"navigationpromptactions",children:"NavigationPromptActions"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"const NavigationPromptActions: {\n CANCEL: string;\n CONFIRM: string;\n};\n"})}),"\n",(0,a.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,a.jsx)(n.h3,{id:"cancel",children:"CANCEL"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"CANCEL: string = 'navigation-prompt/CANCEL';\n"})}),"\n",(0,a.jsx)(n.h3,{id:"confirm",children:"CONFIRM"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"CONFIRM: string = 'navigation-prompt/CONFIRM';\n"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>s});var i=t(758);const a={},o=i.createContext(a);function r(e){const n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/d071c513.8d28365d.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1923],{77(e,n,r){r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>c,frontMatter:()=>t,metadata:()=>a,toc:()=>l});const a=JSON.parse('{"id":"api/variables/endSession","title":"endSession","description":"Ends the current user session and redirects to logout page.","source":"@site/docs/api/variables/endSession.md","sourceDirName":"api/variables","slug":"/api/variables/endSession","permalink":"/app-sdk/api/variables/endSession","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/endSession.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"decorators","permalink":"/app-sdk/api/variables/decorators"},"next":{"title":"error","permalink":"/app-sdk/api/variables/error"}}');var s=r(6070),i=r(5676);const t={},d="endSession",o={},l=[{value:"Param",id:"param",level:2},{value:"Param",id:"param-1",level:2},{value:"Param",id:"param-2",level:2},{value:"Param",id:"param-3",level:2},{value:"Param",id:"param-4",level:2},{value:"Param",id:"param-5",level:2},{value:"Param",id:"param-6",level:2},{value:"Param",id:"param-7",level:2},{value:"Example",id:"example",level:2}];function p(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"endsession",children:"endSession"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const endSession: EndSessionFn;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Ends the current user session and redirects to logout page.\nRevokes tokens and clears session storage."}),"\n",(0,s.jsx)(n.h2,{id:"param",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params"})}),"\n",(0,s.jsx)(n.p,{children:"Session end parameters"}),"\n",(0,s.jsx)(n.h2,{id:"param-1",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.clientId"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth client ID"}),"\n",(0,s.jsx)(n.h2,{id:"param-2",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.redirectUri"})}),"\n",(0,s.jsx)(n.p,{children:"URI to redirect after logout"}),"\n",(0,s.jsx)(n.h2,{id:"param-3",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.responseType"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth response type"}),"\n",(0,s.jsx)(n.h2,{id:"param-4",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.scope"})}),"\n",(0,s.jsx)(n.p,{children:"OAuth scopes"}),"\n",(0,s.jsx)(n.h2,{id:"param-5",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.code"})}),"\n",(0,s.jsx)(n.p,{children:"Optional error code"}),"\n",(0,s.jsx)(n.h2,{id:"param-6",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.customLogoutUrl"})}),"\n",(0,s.jsx)(n.p,{children:"Optional custom logout URL to redirect to instead of IDP"}),"\n",(0,s.jsx)(n.h2,{id:"param-7",children:"Param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"params.skipRevoke"})}),"\n",(0,s.jsx)(n.p,{children:"Skip token revocation if true"}),"\n",(0,s.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"await endSession({\n clientId: 'my-app',\n redirectUri: window.location.origin,\n scope: 'openid'\n});\n"})})]})}function c(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,r){r.d(n,{R:()=>t,x:()=>d});var a=r(758);const s={},i=a.createContext(s);function t(e){const n=a.useContext(i);return a.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(s):e.components||s:t(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/d0fd4a71.69bc17fd.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/d1d7a857.052b33c4.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6170],{582(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>o});const a=JSON.parse('{"id":"api/functions/redactPii","title":"redactPii()","description":"Redacts personally identifiable information (PII) from data objects.","source":"@site/docs/api/functions/redactPii.md","sourceDirName":"api/functions","slug":"/api/functions/redactPii","permalink":"/app-sdk/api/functions/redactPii","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/redactPii.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"onGuestUnloadStart()","permalink":"/app-sdk/api/functions/onGuestUnloadStart"},"next":{"title":"removeDoubleSlash()","permalink":"/app-sdk/api/functions/removeDoubleSlash"}}');var i=t(6070),s=t(5676);const r={},d="redactPii()",c={},o=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"data",id:"data",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,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"redactpii",children:"redactPii()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function redactPii<T>(data: T): T;\n"})}),"\n",(0,i.jsx)(n.p,{children:"Redacts personally identifiable information (PII) from data objects.\nRemoves sensitive data like credit cards, SSNs, emails, passwords, addresses, etc."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"t",children:"T"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.p,{children:"Type of the data object"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"data",children:"data"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.p,{children:"Object containing potential PII to redact"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"T"})}),"\n",(0,i.jsx)(n.p,{children:"New object with PII fields replaced with '****'"}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"const userData = {\n name: 'John Doe',\n email: 'john@example.com',\n ssn: '123-45-6789',\n address: '123 Main St'\n};\n\nconst sanitized = redactPii(userData);\n// {\n// name: 'John Doe',\n// email: '****',\n// ssn: '****',\n// address: '****'\n// }\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>d});var a=t(758);const i={},s=a.createContext(i);function r(e){const n=a.useContext(s);return a.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:r(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/d38c25bf.41b1ebd6.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9220],{1699(e,t,n){n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/functions/renderWithHostData","title":"renderWithHostData()","description":"Parameters","source":"@site/docs/api/functions/renderWithHostData.md","sourceDirName":"api/functions","slug":"/api/functions/renderWithHostData","permalink":"/app-sdk/api/functions/renderWithHostData","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/renderWithHostData.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"renderHook()","permalink":"/app-sdk/api/functions/renderHook"},"next":{"title":"renderWithRedux()","permalink":"/app-sdk/api/functions/renderWithRedux"}}');var a=n(6070),s=n(5676);const i={},o="renderWithHostData()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"data",id:"data",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"renderwithhostdata",children:"renderWithHostData()"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"function renderWithHostData(data: DataProps): () => Element;\n"})}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"data",children:"data"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"DataProps"})}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(t.p,{children:["() => ",(0,a.jsx)(t.code,{children:"Element"})]})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(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/d3d37933.43d6f6a7.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4905],{8070(e,t,a){a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/type-aliases/Await","title":"Await\\\\<T\\\\>","description":"Type Parameters","source":"@site/docs/api/type-aliases/Await.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Await","permalink":"/app-sdk/api/type-aliases/Await","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/type-aliases/Await.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"AppStore","permalink":"/app-sdk/api/type-aliases/AppStore"},"next":{"title":"EMUI\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/type-aliases/EMUI"}}');var i=a(6070),n=a(5676);const r={},p="Await<T>",o={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3}];function l(e){const t={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)(t.header,{children:(0,i.jsx)(t.h1,{id:"awaitt",children:"Await<T>"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"type Await<T> = T extends PromiseLike<infer U> ? U : T;\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"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},5676(e,t,a){a.d(t,{R:()=>r,x:()=>p});var s=a(758);const i={},n=s.createContext(i);function r(e){const t=s.useContext(n);return s.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(i):e.components||i:r(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/d71e6c8a.5d7ad151.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/d9084ecb.1023e8c6.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[252],{2639(e,t,n){n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/type-aliases/OnHostInitCallback","title":"OnHostInitCallback","description":"Parameters","source":"@site/docs/api/type-aliases/OnHostInitCallback.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/OnHostInitCallback","permalink":"/app-sdk/api/type-aliases/OnHostInitCallback","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/type-aliases/OnHostInitCallback.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ModuleOverrides","permalink":"/app-sdk/api/type-aliases/ModuleOverrides"},"next":{"title":"OnInitCallback","permalink":"/app-sdk/api/type-aliases/OnInitCallback"}}');var a=n(6070),i=n(5676);const r={},l="OnHostInitCallback",o={},p=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"Returns",id:"returns",level:2}];function c(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"onhostinitcallback",children:"OnHostInitCallback"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"type OnHostInitCallback = (options: HostOptions) => void;\n"})}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"options",children:"options"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"/app-sdk/api/type-aliases/HostOptions",children:(0,a.jsx)(t.code,{children:"HostOptions"})})}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"void"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},5676(e,t,n){n.d(t,{R:()=>r,x:()=>l});var s=n(758);const a={},i=s.createContext(a);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(a):e.components||a:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/de3ee31a.a9fa1d26.js ADDED Viewed

@@ -0,0 +1 @@

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