IScheduledEmailDialogShellProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Props of ScheduledEmailDialogShell().
export interface IScheduledEmailDialogShellProps extends Pick<IScheduledEmailDialogProps, "onCancel" | "onBack" | "onDeleteSuccess" | "onDeleteError">
Extends: Pick<IScheduledEmailDialogProps, “onCancel” | “onBack” | “onDeleteSuccess” | “onDeleteError”>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ReactNode | (BETA) (Optional) Rendered last inside the scrollable content area, below the selected tab’s content. | ||
ReactNode | (BETA) (Optional) The General tab’s content: the regions and fields, in the caller’s order. Rendered only while the General tab is selected; not mounted while | ||
ReactNode | (BETA) (Optional) The Filters tab’s content. Defaults to the dialog’s filters region (DefaultScheduledEmailDialogFilters() with useScheduledEmailDialogFiltersProps(), or the | ||
boolean | (BETA) | ||
() => void | (BETA) The dialog’s single save — | ||
string | (BETA) (Optional) | ||
Pick<IScheduledEmailDialogSlots, “Header” | “ActionBar” | “Filters”> | (BETA) (Optional) Header, action-bar and Filters-tab overrides — the Level 1 slot contract (IScheduledEmailDialogSlots.Header, IScheduledEmailDialogSlots.ActionBar, IScheduledEmailDialogSlots.Filters): each slot receives | ||
ReactNode | (BETA) (Optional) Rendered first inside the dialog’s scrollable content area, above the selected tab’s content. |
Property details
IScheduledEmailDialogShellProps.bottomContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Rendered last inside the scrollable content area, below the selected tab’s content.
bottomContent?: ReactNode;
IScheduledEmailDialogShellProps.childrenpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The General tab’s content: the regions and fields, in the caller’s order. Rendered only while the General tab is selected; not mounted while useScheduledEmailDialogContext().isLoading is true (the shell shows its loading skeleton — on scheduled email the ordinary path while a widget export’s filters load) or while the stale-filters confirmation step is shown.
children?: ReactNode;
IScheduledEmailDialogShellProps.filtersTabContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The Filters tab’s content. Defaults to the dialog’s filters region (DefaultScheduledEmailDialogFilters() with useScheduledEmailDialogFiltersProps(), or the Filters slot). Rendered only while the Filters tab is selected. An explicit null counts as provided and renders an empty Filters tab.
filtersTabContent?: ReactNode;
IScheduledEmailDialogShellProps.isSavingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
isSavingScheduledEmail of the same instance: disables submit and Delete and shows the footer’s progress indicator.
isSaving: boolean;
IScheduledEmailDialogShellProps.onSubmitpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The dialog’s single save — handleSaveScheduledEmail of the caller’s useSaveScheduledEmailToBackend() instance. Drives the footer’s submit button, the Enter key on it, and the header’s Enter-to-submit. The shell does not own the save hook, so the caller’s own Enter handlers — useScheduledEmailSubmitOnEnter() — 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;
IScheduledEmailDialogShellProps.savingErrorMessagepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
savingErrorMessage of the same instance; shown as the body’s error message, ahead of the form’s validation message.
savingErrorMessage?: string;
IScheduledEmailDialogShellProps.slotspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Header, action-bar and Filters-tab overrides — the Level 1 slot contract (IScheduledEmailDialogSlots.Header, IScheduledEmailDialogSlots.ActionBar, IScheduledEmailDialogSlots.Filters): each slot receives { Default, defaultProps } with the shell’s live values. Slot components need a stable reference identity — see . Filters is ignored when filtersTabContent is passed. The General-tab regions have no slot here: place their blocks (ScheduledEmailDialogDestination() and siblings) as children instead.
slots?: Pick<IScheduledEmailDialogSlots, "Header" | "ActionBar" | "Filters">;
IScheduledEmailDialogShellProps.topContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Rendered first inside the dialog’s scrollable content area, above the selected tab’s content.
topContent?: ReactNode;