DefaultScheduledEmailDialog()
Home > @gooddata/sdk-ui-dashboard > DefaultScheduledEmailDialog
DefaultScheduledEmailDialog() function
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Default implementation of the scheduled export create/edit dialog.
This component is a pure consumer of AutomationsContext, ScheduledEmailDialogContext, and the scheduled export dialog state contexts: it reads org/workspace data, per-dialog state, and the export draft's state from those contexts rather than from the dashboard store. It must therefore be rendered within an AutomationsContextProvider, a ScheduledEmailDialogContextProvider (for the create/edit flow), and a ScheduledEmailDialogStateProvider, whose state model establishes itself once useScheduledEmailDialogContext().isLoading is false. Inside a Dashboard, the scheduled export connector supplies the first two providers above the ScheduledEmailDialogComponent slot and mounts ScheduledEmailDialogStateProvider around the resolved slot component — so the default component, and any wholesale slot replacement, inherit all three contexts automatically and require no extra wiring.
The providers are intentionally hoisted above the slot rather than built inside this component: that is what lets a wholesale replacement receive the same contexts. Rendering this component outside those providers throws at runtime.
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 Filters slot additionally renders only while the Filters tab is selected — see IScheduledEmailDialogSlots.Filters.
Signature:
export declare function DefaultScheduledEmailDialog(props: IDefaultScheduledEmailDialogProps): import("react/jsx-runtime").JSX.Element;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
props |
Returns:
import("react/jsx-runtime").JSX.Element