DefaultAlertingDialog()

Home > @gooddata/sdk-ui-dashboard > DefaultAlertingDialog

DefaultAlertingDialog() 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 alerting create/edit dialog.

This component is a pure consumer of AutomationsContext, AlertingDialogContext, and the alerting dialog state contexts: it reads org/workspace data, per-dialog state, and the alert draft's state from those contexts rather than from the dashboard store. It must therefore be rendered within an AutomationsContextProvider, an AlertingDialogContextProvider (for the create/edit flow), and an AlertingDialogStateProvider. Inside a Dashboard, the alerting connector supplies the first two providers above the AlertingDialogComponent slot, and mounts AlertingDialogStateProvider around the resolved slot component once useAlertingDialogContext().isLoading is false — 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.

Signature:

export declare function DefaultAlertingDialog(props: IAlertingDialogProps): import("react/jsx-runtime").JSX.Element;

Parameters

Parameter	Type	Description
props	IAlertingDialogProps

Returns:

import("react/jsx-runtime").JSX.Element