FrameworkChildWindows Interface
childWindows interface.
Methods
| Name | Description | |
|---|---|---|
| close(childWindowId: string, processWindowClose?: boolean): boolean | Close a specific child window. | |
| closeAll(): void | Close all child/pop-out windows. | |
| find(childWindowId: string): undefined | OpenChildWindowInfo | Returns the OpenChildWindowInfo for the related id. | |
| findId(contentWindow: "null" | Window): undefined | string | Return the childWindowId of the provided window. | |
| open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean | Open a new child window. | |
| useCreateRoot(createRootFn: CreateRoot): void | When using React18, the createRoot function must be provided in order to render Popout content with React18. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| openChildWindows Readonly | OpenChildWindowInfo[] | List of currently open child windows; |
Defined in
Last Updated: 14 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.