IAutomationDialogHeaderProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Members shared by both automation dialogs’ header regions.
export interface IAutomationDialogHeaderProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) (Optional) Whether the secondary title row is shown. | ||
(value: string) => void | (BETA) Called on every title change with the new value. The dialog validates the title itself. | ||
string | (BETA) Placeholder shown while the title is empty. | ||
string | (BETA) (Optional) Secondary title text (e.g. the widget name). | ||
ReactNode | (BETA) (Optional) Icon rendered before the secondary title. Rendered only while | ||
string | (BETA) Current automation title. |
Property details
IAutomationDialogHeaderProps.isSecondaryTitleVisiblepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the secondary title row is shown.
isSecondaryTitleVisible?: boolean;
IAutomationDialogHeaderProps.onChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called on every title change with the new value. The dialog validates the title itself.
onChange: (value: string) => void;
IAutomationDialogHeaderProps.placeholderpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Placeholder shown while the title is empty.
placeholder: string;
IAutomationDialogHeaderProps.secondaryTitlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Secondary title text (e.g. the widget name).
secondaryTitle?: string;
IAutomationDialogHeaderProps.secondaryTitleIconpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Icon rendered before the secondary title.
Rendered only while isSecondaryTitleVisible is true.
secondaryTitleIcon?: ReactNode;
IAutomationDialogHeaderProps.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Current automation title.
title: string;