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/e0db4c79.3f743f77.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[773],{5119(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/render","title":"render()","description":"Parameters","source":"@site/docs/api/functions/render.md","sourceDirName":"api/functions","slug":"/api/functions/render","permalink":"/app-sdk/api/functions/render","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/render.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"removeStorageEvents()","permalink":"/app-sdk/api/functions/removeStorageEvents"},"next":{"title":"renderHook()","permalink":"/app-sdk/api/functions/renderHook"}}');var s=l(6070),t=l(5676);const a={},i="render()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"ui",id:"ui",level:3},{value:"options?",id:"options",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-1",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:"unmount",id:"unmount",level:3},{value:"Returns",id:"returns-52",level:4},{value:"user",id:"user",level:3}];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:"render",children:"render()"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:'function render(ui: ReactElement, options?: Omit<RenderOptions<__module, HTMLElement, HTMLElement>, "queries">): {\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 unmount: () => void;\n user: UserEvent;\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:"options",children:"options?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Omit"}),"<",(0,s.jsx)(r.code,{children:"RenderOptions"}),"<",(0,s.jsx)(r.code,{children:"__module"}),", ",(0,s.jsx)(r.code,{children:"HTMLElement"}),", ",(0,s.jsx)(r.code,{children:"HTMLElement"}),">, ",(0,s.jsx)(r.code,{children:'"queries"'}),">"]}),"\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 unmount: () => void;\n user: UserEvent;\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-1",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:"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"})}),"\n",(0,s.jsx)(r.h3,{id:"user",children:"user"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"user: UserEvent;\n"})})]})}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/e4ad89b2.5cdff7ab.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/e876cff6.afb83043.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/e917d7c9.97605710.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[942],{3539(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"api/functions/onAuthorizationFailure","title":"onAuthorizationFailure()","description":"Registers a callback to handle authorization failures (401 errors).","source":"@site/docs/api/functions/onAuthorizationFailure.md","sourceDirName":"api/functions","slug":"/api/functions/onAuthorizationFailure","permalink":"/app-sdk/api/functions/onAuthorizationFailure","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/onAuthorizationFailure.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"notifyGuestUnloadComplete()","permalink":"/app-sdk/api/functions/notifyGuestUnloadComplete"},"next":{"title":"onGuestUnloadStart()","permalink":"/app-sdk/api/functions/onGuestUnloadStart"}}');var r=t(6070),i=t(5676);const o={},s="onAuthorizationFailure()",l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"callback",id:"callback",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function u(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"onauthorizationfailure",children:"onAuthorizationFailure()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function onAuthorizationFailure(callback: FailureCallback): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Registers a callback to handle authorization failures (401 errors).\nThe callback should refresh the authentication token and return the new authorization header.\nThe SDK will automatically retry the failed request with the new token."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"callback",children:"callback"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"FailureCallback"})}),"\n",(0,r.jsx)(n.p,{children:"Async function that refreshes token and returns new authorization header"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"onAuthorizationFailure(async (error) => {\n const newToken = await refreshAuthToken();\n sessionStorage.setItem('Authorization', newToken);\n return newToken;\n});\n"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},5676(e,n,t){t.d(n,{R:()=>o,x:()=>s});var a=t(758);const r={},i=a.createContext(r);function o(e){const n=a.useContext(i);return a.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(r):e.components||r:o(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/e9f568e8.87daf2aa.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8311],{3652(e,n,t){t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});const r=JSON.parse('{"id":"api/functions/DatePicker","title":"DatePicker()","description":"Date picker field component with React Hook Form integration.","source":"@site/docs/api/functions/DatePicker.md","sourceDirName":"api/functions","slug":"/api/functions/DatePicker","permalink":"/app-sdk/api/functions/DatePicker","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/DatePicker.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"DateInput()","permalink":"/app-sdk/api/functions/DateInput"},"next":{"title":"DateRangePicker()","permalink":"/app-sdk/api/functions/DateRangePicker"}}');var i=t(6070),a=t(5676);const s={},c="DatePicker()",o={},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 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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"datepicker",children:"DatePicker()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function DatePicker(props: DatePickerProps): Element;\n"})}),"\n",(0,i.jsx)(n.p,{children:"Date picker field component with React Hook Form integration.\nWraps the Dimsum DatePicker component with form state management and validation."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"props",children:"props"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"DatePickerProps"})}),"\n",(0,i.jsx)(n.p,{children:"DatePicker component props"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Element"})}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-tsx",children:'<Form onSubmit={handleSubmit}>\n <DatePicker\n name="birthDate"\n labelText="Birth Date"\n rules={{ required: \'Birth date is required\' }}\n />\n</Form>\n'})})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5676(e,n,t){t.d(n,{R:()=>s,x:()=>c});var r=t(758);const i={},a=r.createContext(i);function s(e){const n=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/ea5986e4.275ca37f.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8946],{8909(e,n,a){a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"api/functions/loadable","title":"loadable()","description":"Creates a lazily-loaded React component for code splitting.","source":"@site/docs/api/functions/loadable.md","sourceDirName":"api/functions","slug":"/api/functions/loadable","permalink":"/app-sdk/api/functions/loadable","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/loadable.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"loadAppConfig()","permalink":"/app-sdk/api/functions/loadAppConfig"},"next":{"title":"login()","permalink":"/app-sdk/api/functions/login"}}');var l=a(6070),s=a(5676);const i={},o="loadable()",r={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"importFunc",id:"importfunc",level:3},{value:"fallback?",id:"fallback",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function c(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"loadable",children:"loadable()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"function loadable<T>(importFunc: () => Promise<{\n default: T;\n}>, fallback?: ReactNode): (props: any) => Element;\n"})}),"\n",(0,l.jsx)(n.p,{children:"Creates a lazily-loaded React component for code splitting.\nWraps the component in Suspense with a customizable fallback."}),"\n",(0,l.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h3,{id:"t",children:"T"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"T"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"ComponentType"}),"<",(0,l.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"Component type"}),"\n",(0,l.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsx)(n.h3,{id:"importfunc",children:"importFunc"}),"\n",(0,l.jsxs)(n.p,{children:["() => ",(0,l.jsx)(n.code,{children:"Promise"}),"<{\n",(0,l.jsx)(n.code,{children:"default"}),": ",(0,l.jsx)(n.code,{children:"T"}),";\n}>"]}),"\n",(0,l.jsx)(n.p,{children:"Dynamic import function that returns the component"}),"\n",(0,l.jsx)(n.h3,{id:"fallback",children:"fallback?"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ReactNode"})," = ",(0,l.jsx)(n.code,{children:"..."})]}),"\n",(0,l.jsx)(n.p,{children:"React element to show while loading (defaults to WaitMessageLauncher)"}),"\n",(0,l.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:"Lazy-loaded component"}),"\n",(0,l.jsxs)(n.p,{children:["(",(0,l.jsx)(n.code,{children:"props"}),": ",(0,l.jsx)(n.code,{children:"any"}),") => ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-typescript",children:"// Basic usage\nconst Dashboard = loadable(() => import('./Dashboard'));\n\n// Custom loading fallback\nconst Settings = loadable(\n () => import('./Settings'),\n <div>Loading settings...</div>\n);\n\n// Use in routes\n<Route path=\"/dashboard\" component={Dashboard} />\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},5676(e,n,a){a.d(n,{R:()=>i,x:()=>o});var t=a(758);const l={},s=t.createContext(l);function i(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/eb84a108.5f8525d7.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[920],{4397(e,n,r){r.r(n),r.d(n,{assets:()=>u,contentTitle:()=>s,default:()=>o,frontMatter:()=>d,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/functions/useInjectQuery","title":"useInjectQuery()","description":"React hook to dynamically inject RTK Query API slice into the Redux store.","source":"@site/docs/api/functions/useInjectQuery.md","sourceDirName":"api/functions","slug":"/api/functions/useInjectQuery","permalink":"/app-sdk/api/functions/useInjectQuery","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useInjectQuery.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useAppMiddleware()","permalink":"/app-sdk/api/functions/useAppMiddleware"},"next":{"title":"useInjectReducer()","permalink":"/app-sdk/api/functions/useInjectReducer"}}');var t=r(6070),c=r(5676);const d={},s="useInjectQuery()",u={},a=[{value:"Parameters",id:"parameters",level:2},{value:"config",id:"config",level:3},{value:"middleware",id:"middleware",level:4},{value:"reducer",id:"reducer",level:4},{value:"reducerPath",id:"reducerpath",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,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"useinjectquery",children:"useInjectQuery()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function useInjectQuery(config: {\n middleware: Middleware;\n reducer: Reducer<any, AnyAction>;\n reducerPath: string;\n}): void;\n"})}),"\n",(0,t.jsx)(n.p,{children:"React hook to dynamically inject RTK Query API slice into the Redux store.\nRegisters the reducer and middleware for the API slice at runtime."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,t.jsx)(n.p,{children:"Query injection configuration"}),"\n",(0,t.jsx)(n.h4,{id:"middleware",children:"middleware"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Middleware"})}),"\n",(0,t.jsx)(n.p,{children:"The RTK Query middleware"}),"\n",(0,t.jsx)(n.h4,{id:"reducer",children:"reducer"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Reducer"}),"<",(0,t.jsx)(n.code,{children:"any"}),", ",(0,t.jsx)(n.code,{children:"AnyAction"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"The RTK Query reducer"}),"\n",(0,t.jsx)(n.h4,{id:"reducerpath",children:"reducerPath"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"Path where the reducer will be mounted in the store"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"import { createApi } from '@reduxjs/toolkit/query/react';\nimport { useInjectQuery } from '@elliemae/pui-app-sdk';\n\nconst usersApi = createApi({\n reducerPath: 'usersApi',\n baseQuery: sdkBaseQuery(),\n endpoints: (builder) => ({...})\n});\n\nfunction MyComponent() {\n useInjectQuery({\n reducerPath: usersApi.reducerPath,\n reducer: usersApi.reducer,\n middleware: usersApi.middleware\n });\n\n return <div>...</div>;\n}\n"})})]})}function o(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},5676(e,n,r){r.d(n,{R:()=>d,x:()=>s});var i=r(758);const t={},c=i.createContext(t);function d(e){const n=i.useContext(c);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(t):e.components||t:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/ed6a4585.786e4077.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9035],{8879(e,n,t){t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>o});const a=JSON.parse('{"id":"api/variables/VisuallyHidden","title":"VisuallyHidden","description":"","source":"@site/docs/api/variables/VisuallyHidden.md","sourceDirName":"api/variables","slug":"/api/variables/VisuallyHidden","permalink":"/app-sdk/api/variables/VisuallyHidden","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/VisuallyHidden.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Themes","permalink":"/app-sdk/api/variables/Themes"},"next":{"title":"WaitMessage","permalink":"/app-sdk/api/variables/WaitMessage"}}');var i=t(6070),s=t(5676);const r={},l="VisuallyHidden",d={},o=[];function c(e){const n={code:"code",h1:"h1",header:"header",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:"visuallyhidden",children:"VisuallyHidden"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'const VisuallyHidden: ForwardRefExoticComponent<Omit<StyledComponent<"span", DefaultTheme, {\n}, never>, "ref"> & RefAttributes<HTMLSpanElement>>;\n'})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>l});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 l(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/f4180cff.909c9618.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7209],{8226(e,t,s){s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/variables/resetUserIdleTime","title":"resetUserIdleTime","description":"Resets the user idle clock without calling the auth introspection API.","source":"@site/docs/api/variables/resetUserIdleTime.md","sourceDirName":"api/variables","slug":"/api/variables/resetUserIdleTime","permalink":"/app-sdk/api/variables/resetUserIdleTime","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/resetUserIdleTime.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"removeSideEffect","permalink":"/app-sdk/api/variables/removeSideEffect"},"next":{"title":"screen","permalink":"/app-sdk/api/variables/screen"}}');var n=s(6070),i=s(5676);const a={},o="resetUserIdleTime",l={},c=[{value:"Param",id:"param",level:2}];function d(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"resetuseridletime",children:"resetUserIdleTime"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"const resetUserIdleTime: ResetUserIdleTimeFn;\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Resets the user idle clock without calling the auth introspection API.\nUsed by the HTTP request interceptor. Runs through ",(0,n.jsx)(t.code,{children:"enforceIdleThresholds()"}),"\nfirst, so it cannot dismiss the warning modal or extend after expiry."]}),"\n",(0,n.jsx)(t.h2,{id:"param",children:"Param"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.strong,{children:"resetWarningModal"})}),"\n",(0,n.jsx)(t.p,{children:"When true, notifies reset\nlisteners so the warning modal can close. Only for explicit user actions."})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},5676(e,t,s){s.d(t,{R:()=>a,x:()=>o});var r=s(758);const n={},i=r.createContext(n);function a(e){const t=r.useContext(i);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(n):e.components||n:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/f7084923.283f1cd5.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/f72a372a.0e65a0e2.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[3292],{3389(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>d,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/classes/CMicroAppGuest","title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","description":"Micro-frontend guest application class (singleton).","source":"@site/docs/api/classes/CMicroAppGuest.md","sourceDirName":"api/classes","slug":"/api/classes/CMicroAppGuest","permalink":"/app-sdk/api/classes/CMicroAppGuest","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/classes/CMicroAppGuest.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Analytics","permalink":"/app-sdk/api/classes/Analytics"},"next":{"title":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","permalink":"/app-sdk/api/classes/CMicroAppHost"}}');var r=s(6070),t=s(5676);const d={},l="CMicroAppGuest<AppObjects, AppEvents>",c={},a=[{value:"Example",id:"example",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"AppObjects",id:"appobjects",level:3},{value:"AppEvents",id:"appevents",level:3},{value:"Implements",id:"implements",level:2},{value:"Accessors",id:"accessors",level:2},{value:"uuid",id:"uuid",level:3},{value:"Get Signature",id:"get-signature",level:4},{value:"Returns",id:"returns",level:5},{value:"Implementation of",id:"implementation-of",level:4},{value:"Methods",id:"methods",level:2},{value:"addScriptingObject()",id:"addscriptingobject",level:3},{value:"Type Parameters",id:"type-parameters-1",level:4},{value:"SO",id:"so",level:5},{value:"Parameters",id:"parameters",level:4},{value:"so",id:"so-1",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"dispatchEvent()",id:"dispatchevent",level:3},{value:"Type Parameters",id:"type-parameters-2",level:4},{value:"EventId",id:"eventid",level:5},{value:"Params",id:"params-1",level:5},{value:"Options",id:"options",level:5},{value:"Parameters",id:"parameters-1",level:4},{value:"params",id:"params-2",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"getHost()",id:"gethost",level:3},{value:"Returns",id:"returns-3",level:4},{value:"getLogger()",id:"getlogger",level:3},{value:"Returns",id:"returns-4",level:4},{value:"getObject()",id:"getobject",level:3},{value:"Type Parameters",id:"type-parameters-3",level:4},{value:"ObjectId",id:"objectid",level:5},{value:"Parameters",id:"parameters-2",level:4},{value:"objectId",id:"objectid-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"getProps()",id:"getprops",level:3},{value:"Returns",id:"returns-6",level:4},{value:"<del>getRef()</del>",id:"getref",level:3},{value:"Type Parameters",id:"type-parameters-4",level:4},{value:"T",id:"t",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"init()",id:"init",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"initialize()",id:"initialize",level:3},{value:"Returns",id:"returns-9",level:4},{value:"mount()",id:"mount",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"options?",id:"options-2",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"navigate()",id:"navigate",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"url",id:"url",level:5},{value:"state?",id:"state",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"removeScriptingObject()",id:"removescriptingobject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"objectId",id:"objectid-2",level:5},{value:"guestId?",id:"guestid",level:5},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"subscribe()",id:"subscribe",level:3},{value:"Type Parameters",id:"type-parameters-5",level:4},{value:"EventId",id:"eventid-1",level:5},{value:"Parameters",id:"parameters-7",level:4},{value:"params",id:"params-3",level:5},{value:"Returns",id:"returns-13",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"unmount()",id:"unmount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"options",id:"options-3",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"unsubscribe()",id:"unsubscribe",level:3},{value:"Type Parameters",id:"type-parameters-6",level:4},{value:"EventId",id:"eventid-2",level:5},{value:"Parameters",id:"parameters-9",level:4},{value:"params",id:"params-4",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"getInstance()",id:"getinstance",level:3},{value:"Type Parameters",id:"type-parameters-7",level:4},{value:"AppObjects",id:"appobjects-1",level:5},{value:"AppEvents",id:"appevents-1",level:5},{value:"Parameters",id:"parameters-10",level:4},{value:"params?",id:"params-5",level:5},{value:"Returns",id:"returns-16",level:4},{value:"isHosted()",id:"ishosted",level:3},{value:"Returns",id:"returns-17",level:4},{value:"isInitialized()",id:"isinitialized",level:3},{value:"Returns",id:"returns-18",level:4}];function o(e){const n={a:"a",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"cmicroappguestappobjects-appevents",children:"CMicroAppGuest<AppObjects, AppEvents>"})}),"\n",(0,r.jsx)(n.p,{children:"Micro-frontend guest application class (singleton).\nManages communication between a guest micro-app and its host application.\nSupports both SSF (Shared Service Framework) and App Bridge communication methods."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const guest = new CMicroAppGuest({\n onInit: ({ history, theme, prevState }) => {\n console.log('Guest initialized');\n },\n onMount: ({ container }) => {\n // Render your React app\n ReactDOM.render(<App />, container);\n },\n onUnmount: ({ container }) => {\n // Cleanup\n ReactDOM.unmountComponentAtNode(container);\n return { savedState: 'some data' };\n }\n});\n"})}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom scripting objects"}),"\n",(0,r.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom event listeners"}),"\n",(0,r.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"IMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,r.jsx)(n.h3,{id:"uuid",children:"uuid"}),"\n",(0,r.jsx)(n.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get uuid(): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unique identifier for the microapp instance."}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.uuid\n"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"addscriptingobject",children:"addScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"addScriptingObject<SO>(so: SO, params?: AddScriptingObjectParams): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Register a scripting object for child micro-apps to use.\nAdds the object to both the App Bridge and the SSF Host so guests\nusing either transport can discover it. Always prefer this method\nover calling appBridge.addScriptingObject() directly."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so",children:"SO"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SO"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"IScriptingObject"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so-1",children:"so"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"SO"})}),"\n",(0,r.jsx)(n.p,{children:"The scripting object to be added."}),"\n",(0,r.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"AddScriptingObjectParams"})}),"\n",(0,r.jsxs)(n.p,{children:["Optional parameters (e.g. ",(0,r.jsx)(n.code,{children:"{ guestId }"})," to scope to a specific guest)."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.addScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"dispatchevent",children:"dispatchEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"dispatchEvent<EventId, Params, Options>(params: DispatchEventParam<EventId, Params, Options>): Promise<void | unknown[]>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Dispatches an event to the child microapp."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h5,{id:"params-1",children:"Params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Params"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"Options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Options"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-2",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"DispatchEventParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"Params"}),", ",(0,r.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Event parameters."}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"})," | ",(0,r.jsx)(n.code,{children:"unknown"}),"[]>"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves with the combined results of dispatched events."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.dispatchEvent\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gethost",children:"getHost()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getHost(): \n | IMicroAppHost<Partial<ScriptingObjectTypes>, Events>\n | IMicroFEHost<Partial<ScriptingObjectTypes>, Events>\n | SSFGuest<Partial<ScriptingObjectTypes>, Events>\n | undefined;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:["| ",(0,r.jsx)(n.code,{children:"IMicroAppHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"IMicroFEHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"SSFGuest"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"undefined"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getlogger",children:"getLogger()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getLogger(): MicroFrontEndLogger;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MicroFrontEndLogger"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getobject",children:"getObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getObject<ObjectId>(objectId: ObjectId): Promise<AppObjects[ObjectId] | null>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Retrieves a reference to a scripting object (or proxy) by its unique name."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid",children:"ObjectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ObjectId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-1",children:"objectId"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ObjectId"})}),"\n",(0,r.jsx)(n.p,{children:"The unique name of the scripting object."}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),"[",(0,r.jsx)(n.code,{children:"ObjectId"}),"] | ",(0,r.jsx)(n.code,{children:"null"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["A promise that resolves to the scripting object reference or ",(0,r.jsx)(n.code,{children:"null"})," if not found."]}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getprops",children:"getProps()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getProps(): GuestProps<Partial<ScriptingObjectTypes>, Events>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/app-sdk/api/interfaces/GuestProps",children:(0,r.jsx)(n.code,{children:"GuestProps"})}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getref",children:(0,r.jsx)(n.del,{children:"getRef()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getRef<T>(): T | null;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Retrieves a generic reference of type ",(0,r.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"t",children:"T"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"})," | ",(0,r.jsx)(n.code,{children:"null"})]}),"\n",(0,r.jsxs)(n.p,{children:["The reference of type ",(0,r.jsx)(n.code,{children:"T"})," or ",(0,r.jsx)(n.code,{children:"null"})," if not available."]}),"\n",(0,r.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(n.p,{children:"This method is deprecated and will be removed in future versions."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getRef\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"init",children:"init()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"init(options: InitOptions<AppObjects, AppEvents>): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Initializes the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"InitOptions"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Options for initializing the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves when initialization is complete."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.init\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"initialize(): Promise<ModuleParameters>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Guest-initiated lifecycle: discovers the host and applies module\nparameters if available. After this resolves the guest is ready to render.\nRequires selfInitialize: true in the constructor so the bridge\nskips calling init() / mount() on this guest."}),"\n",(0,r.jsx)(n.p,{children:"The module scripting object is optional \u2014 if the host did not register\none, a warning is logged and the guest proceeds with its own config."}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"ModuleParameters"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"module parameters provided by the host, or a minimal object with moduleId"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mount",children:"mount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"mount(options?: MountOptions): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Mounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-2",children:"options?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"MountOptions"})," = ",(0,r.jsx)(n.code,{children:"..."})]}),"\n",(0,r.jsx)(n.p,{children:"Options for mounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves when the microapp is successfully mounted."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.mount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"navigate",children:"navigate()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"navigate(url: To, state?: any): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigates the microapp to a specified URL with an optional state."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"url",children:"url"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"To"})}),"\n",(0,r.jsx)(n.p,{children:"The target URL to navigate to."}),"\n",(0,r.jsx)(n.h5,{id:"state",children:"state?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"any"})}),"\n",(0,r.jsx)(n.p,{children:"Optional state to pass during navigation."}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.navigate\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removescriptingobject",children:"removeScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"removeScriptingObject(objectId: Extract<keyof AppObjects, string>, guestId?: string): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"removes scripting object from child microapp use"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-2",children:"objectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Extract"}),"<keyof ",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"unique id of the scripting object"}),"\n",(0,r.jsx)(n.h5,{id:"guestid",children:"guestId?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"optional guest id when removing a guest-scoped object"}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.removeScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"subscribe",children:"subscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"subscribe<EventId>(params: SubscribeParam<EventId, AppEvents[EventId]>): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"subscribe to the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-1",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-3",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),"[",(0,r.jsx)(n.code,{children:"EventId"}),"]>"]}),"\n",(0,r.jsx)(n.p,{children:"the parameters for the subscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.subscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unmount",children:"unmount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unmount(options: MountOptions): Promise<JSONValue>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unmounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-3",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MountOptions"})}),"\n",(0,r.jsx)(n.p,{children:"Options for unmounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"JSONValue"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a JSON value upon successful unmounting."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unmount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unsubscribe",children:"unsubscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unsubscribe<EventId>(params: UnsubscribeParam<EventId>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"unsubscribe from the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-2",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-4",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"UnsubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"parameters for the unsubscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-11",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unsubscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getinstance",children:"getInstance()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static getInstance<AppObjects, AppEvents>(params?: ConstructorParams): CMicroAppGuest<AppObjects, AppEvents>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"appobjects-1",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.h5,{id:"appevents-1",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-5",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ConstructorParams"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"CMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ishosted",children:"isHosted()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isHosted(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isinitialized",children:"isInitialized()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isInitialized(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},5676(e,n,s){s.d(n,{R:()=>d,x:()=>l});var i=s(758);const r={},t=i.createContext(r);function d(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/f72c86d0.7edc82d8.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/f8fa0321.fcff0c9a.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1022],{2930(e,n,r){r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/renderHook","title":"renderHook()","description":"Allows you to render a hook within a test React component without having to","source":"@site/docs/api/functions/renderHook.md","sourceDirName":"api/functions","slug":"/api/functions/renderHook","permalink":"/app-sdk/api/functions/renderHook","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/renderHook.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"render()","permalink":"/app-sdk/api/functions/render"},"next":{"title":"renderWithHostData()","permalink":"/app-sdk/api/functions/renderWithHostData"}}');var t=r(6070),o=r(5676);const i={},d="renderHook()",l={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Result",id:"result",level:3},{value:"Props",id:"props",level:3},{value:"Q",id:"q",level:3},{value:"Container",id:"container",level:3},{value:"BaseElement",id:"baseelement",level:3},{value:"Parameters",id:"parameters",level:2},{value:"render",id:"render",level:3},{value:"options?",id:"options",level:3},{value:"Returns",id:"returns",level:2}];function a(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"renderhook",children:"renderHook()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function renderHook<Result, Props, Q, Container, BaseElement>(render: (initialProps: Props) => Result, options?: RenderHookOptions<Props, Q, Container, BaseElement>): RenderHookResult<Result, Props>;\n"})}),"\n",(0,t.jsx)(n.p,{children:"Allows you to render a hook within a test React component without having to\ncreate that component yourself."}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"result",children:"Result"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Result"})}),"\n",(0,t.jsx)(n.h3,{id:"props",children:"Props"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Props"})}),"\n",(0,t.jsx)(n.h3,{id:"q",children:"Q"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Q"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Queries"})," = ",(0,t.jsx)(n.code,{children:"__module"})]}),"\n",(0,t.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Container"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Element"})," | ",(0,t.jsx)(n.code,{children:"DocumentFragment"})," = ",(0,t.jsx)(n.code,{children:"HTMLElement"})]}),"\n",(0,t.jsx)(n.h3,{id:"baseelement",children:"BaseElement"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"BaseElement"})," ",(0,t.jsx)(n.em,{children:"extends"})," ",(0,t.jsx)(n.code,{children:"Element"})," | ",(0,t.jsx)(n.code,{children:"DocumentFragment"})," = ",(0,t.jsx)(n.code,{children:"Container"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"render",children:"render"}),"\n",(0,t.jsxs)(n.p,{children:["(",(0,t.jsx)(n.code,{children:"initialProps"}),": ",(0,t.jsx)(n.code,{children:"Props"}),") => ",(0,t.jsx)(n.code,{children:"Result"})]}),"\n",(0,t.jsx)(n.h3,{id:"options",children:"options?"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"RenderHookOptions"}),"<",(0,t.jsx)(n.code,{children:"Props"}),", ",(0,t.jsx)(n.code,{children:"Q"}),", ",(0,t.jsx)(n.code,{children:"Container"}),", ",(0,t.jsx)(n.code,{children:"BaseElement"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"RenderHookResult"}),"<",(0,t.jsx)(n.code,{children:"Result"}),", ",(0,t.jsx)(n.code,{children:"Props"}),">"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},5676(e,n,r){r.d(n,{R:()=>i,x:()=>d});var s=r(758);const t={},o=s.createContext(t);function i(e){const n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fc7c782f.2426a28b.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[3753],{3385(e,t,a){a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/variables/act","title":"act","description":"Simply calls ReactDOMTestUtils.act(cb)","source":"@site/docs/api/variables/act.md","sourceDirName":"api/variables","slug":"/api/variables/act","permalink":"/app-sdk/api/variables/act","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/act.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"WaitMessage","permalink":"/app-sdk/api/variables/WaitMessage"},"next":{"title":"ariaLive","permalink":"/app-sdk/api/variables/ariaLive"}}');var s=a(6070),n=a(5676);const c={},r="act",l={},o=[];function p(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"act",children:"act"})}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"const act: typeof reactAct extends undefined ? (callback: () => void) => void : typeof reactAct;\n"})}),"\n",(0,s.jsx)(t.p,{children:"Simply calls ReactDOMTestUtils.act(cb)\nIf that's not available (older version of react) then it\nsimply calls the given callback immediately"})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5676(e,t,a){a.d(t,{R:()=>c,x:()=>r});var i=a(758);const s={},n=i.createContext(s);function c(e){const t=i.useContext(n);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fce396bf.94e62f7d.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/fdb0d9e1.a6d2adf8.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[552],{3107(e,n,t){t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/functions/setAppConfig","title":"setAppConfig()","description":"Sets the entire application configuration.","source":"@site/docs/api/functions/setAppConfig.md","sourceDirName":"api/functions","slug":"/api/functions/setAppConfig","permalink":"/app-sdk/api/functions/setAppConfig","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/setAppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"sendMessageToHost()","permalink":"/app-sdk/api/functions/sendMessageToHost"},"next":{"title":"setAppConfigValue()","permalink":"/app-sdk/api/functions/setAppConfigValue"}}');var s=t(6070),p=t(5676);const o={},a="setAppConfig()",r={},c=[{value:"Parameters",id:"parameters",level:2},{value:"config",id:"config",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,p.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"setappconfig",children:"setAppConfig()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function setAppConfig(config: AppConfig): void;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Sets the entire application configuration.\nReplaces the current configuration with the provided config object."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/app-sdk/api/interfaces/AppConfig",children:(0,s.jsx)(n.code,{children:"AppConfig"})})}),"\n",(0,s.jsx)(n.p,{children:"The complete application configuration"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(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:"setAppConfig({\n appId: 'my-app',\n activeEnv: 'production',\n serviceEndpoints: {\n api: 'https://api.example.com',\n idp: 'https://auth.example.com'\n },\n env: {...}\n});\n"})})]})}function l(e={}){const{wrapper:n}={...(0,p.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:()=>a});var i=t(758);const s={},p=i.createContext(s);function o(e){const n=i.useContext(p);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(p.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fed4ae4f.05ba0f51.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9712],{1761(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"api/functions/subscribeToResetSession","title":"subscribeToResetSession()","description":"Registers a callback when the idle clock is reset.","source":"@site/docs/api/functions/subscribeToResetSession.md","sourceDirName":"api/functions","slug":"/api/functions/subscribeToResetSession","permalink":"/app-sdk/api/functions/subscribeToResetSession","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/subscribeToResetSession.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setSessionTimeoutInterval()","permalink":"/app-sdk/api/functions/setSessionTimeoutInterval"},"next":{"title":"subscribeToSessionExpiry()","permalink":"/app-sdk/api/functions/subscribeToSessionExpiry"}}');var i=n(6070),r=n(5676);const o={},c="subscribeToResetSession()",a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"onResetListener",id:"onresetlistener",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"subscribetoresetsession",children:"subscribeToResetSession()"})}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"function subscribeToResetSession(onResetListener: RESETLISTENER): (...args: []) => void;\n"})}),"\n",(0,i.jsx)(s.p,{children:"Registers a callback when the idle clock is reset."}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(s.h3,{id:"onresetlistener",children:"onResetListener"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"RESETLISTENER"})}),"\n",(0,i.jsx)(s.p,{children:"Receives the resetWarningModal flag."}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:"Unsubscribe function."}),"\n",(0,i.jsxs)(s.p,{children:["(...",(0,i.jsx)(s.code,{children:"args"}),": []) => ",(0,i.jsx)(s.code,{children:"void"})]})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5676(e,s,n){n.d(s,{R:()=>o,x:()=>c});var t=n(758);const i={},r=t.createContext(i);function o(e){const s=t.useContext(r);return t.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/fefe9566.06f8a04e.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/ff0bf96e.8a1953cb.js ADDED Viewed

@@ -0,0 +1 @@

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

package/build/docs/assets/js/ff6d65a9.f84ddf73.js ADDED Viewed

@@ -0,0 +1 @@

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