AlertingDialogComparisonPeriod()

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

The alerting dialog’s comparison-period field (“Compared to”: the period a change or difference condition compares against), connected to the dialog’s state and rendered as a labelled form row.

Renders DefaultAlertingDialogComparisonPeriod() inside AutomationDialogFormField() with the props of useAlertingDialogComparisonPeriodProps(); every prop passed here replaces the hook’s value for that prop wholesale. Renders nothing unless the alert prop’s condition is a change or difference (only those have a comparison period; the gate reads the prop, so an override is honoured), and nothing while useAlertingDialogContext().isLoading is true.

export declare function AlertingDialogComparisonPeriod(overrides: Partial<IAlertingDialogComparisonPeriodProps>): ReactElement;

Parameters

Returns

ReactElement