IAlertingDialogShellProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of AlertingDialogShell().
export interface IAlertingDialogShellProps extends Pick<IAlertingDialogProps, "onCancel" | "onDeleteSuccess" | "onDeleteError">
Extends: Pick<IAlertingDialogProps, “onCancel” | “onDeleteSuccess” | “onDeleteError”>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ReactNode | (BETA) (Optional) Rendered last inside the scrollable content area, below | ||
ReactNode | (BETA) (Optional) The body: the regions and fields, in the caller’s order — AlertingDialogFilters(), AlertingDialogFormFieldGroup() with the condition and action blocks, and so on. Not mounted while | ||
boolean | (BETA) | ||
() => void | (BETA) The dialog’s single submit — | ||
Pick<IAlertingDialogSlots, “Header” | “ActionBar”> | (BETA) (Optional) Header and action-bar overrides — the Level 1 slot contract (IAlertingDialogSlots.Header, IAlertingDialogSlots.ActionBar): each slot receives | ||
ReactNode | (BETA) (Optional) Rendered first inside the dialog’s scrollable content area, above |
Property details
IAlertingDialogShellProps.bottomContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Rendered last inside the scrollable content area, below children and the dialog’s warning and validation messages.
bottomContent?: ReactNode;
IAlertingDialogShellProps.childrenpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The body: the regions and fields, in the caller’s order — AlertingDialogFilters(), AlertingDialogFormFieldGroup() with the condition and action blocks, and so on. Not mounted while useAlertingDialogContext().isLoading is true (the shell shows its loading skeleton) or while the stale-filters confirmation step is shown.
children?: ReactNode;
IAlertingDialogShellProps.isSavingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
isSaving of the same useAlertSubmit() instance: disables submit and Delete and shows the footer’s progress indicator.
isSaving: boolean;
IAlertingDialogShellProps.onSubmitpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The dialog’s single submit — submit of the caller’s useAlertSubmit() instance. Drives the footer’s submit button and the Enter key on it. The shell does not own the submit hook, so a caller’s own Enter handler or button can share the same instance. Create the hook instance only once the dialog’s data has first loaded — the state hooks throw before then.
onSubmit: () => void;
IAlertingDialogShellProps.slotspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Header and action-bar overrides — the Level 1 slot contract (IAlertingDialogSlots.Header, IAlertingDialogSlots.ActionBar): each slot receives { Default, defaultProps }, where defaultProps are the shell’s live values (the header’s onCancel and initial-focus ref; the action bar’s onSubmit, isSaving, onDelete). Slot components need a stable reference identity — see . The body regions have no slot here: place their blocks (AlertingDialogFilters() and siblings) as children instead.
slots?: Pick<IAlertingDialogSlots, "Header" | "ActionBar">;
IAlertingDialogShellProps.topContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Rendered first inside the dialog’s scrollable content area, above children.
topContent?: ReactNode;