IDefaultAlertingDialogProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of DefaultAlertingDialog().
export interface IDefaultAlertingDialogProps extends IAlertingDialogProps
Extends: IAlertingDialogProps
Remarks
Extends the shared IAlertingDialogProps with customization only the default implementation supports. Slots render only in the fully rendered dialog: not while the dialog context reports loading, and not while the stale-filters confirmation step is shown. The Destination slot additionally renders only when more than one notification channel exists — see IAlertingDialogSlots.Destination.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ReactNode | (BETA) (Optional) Content rendered as the last child of the dialog’s scrollable content area, below the form. Same rendering conditions as IDefaultAlertingDialogProps.topContent. | ||
(BETA) (Optional) Section-level overrides. Each slot receives | |||
ReactNode | (BETA) (Optional) Content rendered as the first child of the dialog’s scrollable content area, above the form. Rendered only in the fully rendered dialog: not while the dialog context reports loading, and not while the stale-filters confirmation step is shown. |
Property details
IDefaultAlertingDialogProps.bottomContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Content rendered as the last child of the dialog’s scrollable content area, below the form. Same rendering conditions as IDefaultAlertingDialogProps.topContent.
bottomContent?: ReactNode;
IDefaultAlertingDialogProps.slotspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Section-level overrides. Each slot receives { Default, defaultProps } — Default is the region’s exported render component (DefaultAlertingDialogHeader for Header, and so on) and defaultProps the return of the region’s props hook (useAlertingDialogHeaderProps()) — and may render its own content (replace) or <Default {...defaultProps} /> inside its own markup (wrap).
slots?: IAlertingDialogSlots;
Example
The dialog is reached through the Dashboard component override; define slot components at module scope (see ):
function HeaderWithBanner({ Default, defaultProps }: ISlotProps<AlertingDialogHeaderDefaultProps>) {
return (
<>
<WarningBanner>Alerts may take up to 5 minutes.</WarningBanner>
<Default {...defaultProps} />
</>
);
}
<Dashboard
AlertingDialogComponent={(props) => (
<DefaultAlertingDialog {...props} slots={{ Header: HeaderWithBanner }} />
)}
/>;
IDefaultAlertingDialogProps.topContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Content rendered as the first child of the dialog’s scrollable content area, above the form. Rendered only in the fully rendered dialog: not while the dialog context reports loading, and not while the stale-filters confirmation step is shown.
topContent?: ReactNode;