OverlayProps
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface OverlayProps {
readonly id: string;
readonly open: boolean;
readonly dismissOnEscape?: boolean;
readonly onDismiss?: () => void | Promise<void>;
readonly children?: ReactNode;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
open | boolean | Yes | The open member uses the boolean contract. | — |
dismissOnEscape | boolean | undefined | No | The dismissOnEscape member uses the boolean | undefined contract. | — |
onDismiss | (() => void | Promise<void>) | undefined | No | The onDismiss member uses the (() => void | Promise<void>) | undefined contract. | — |
children | ReactNode | No | The children member uses the ReactNode contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
No package-local related types.
Source
View the secondary source reference