Skip to components
DEVELOPER REFERENCE · v4.0.0

EditableDialogHeader API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

EditableDialogHeader12 props1 callbacks0 methods

Props12

EditableDialogHeader props
NameTypeDescription
nameOptionalstring | undefinedOptional dialog name above the editable item title.
titleRequiredstringHeading or title text used by this component.
titleIdRequiredstringID of the dialog heading used by aria-labelledby.
descriptionOptional
ComponentChildrenInspect type
Supporting text shown with the label or heading.
inputLabelRequiredstringAccessible label for the editable dialog title input.
titleHiddenOptionalboolean | undefinedKeeps the title available to screen readers while visually hiding it.
headingClassOptionalstring | undefinedAdditional CSS classes for the heading part of the component.
kickerClassOptionalstring | undefinedAdditional CSS classes for the kicker part of the component.
titleClassOptionalstring | undefinedAdditional CSS classes for the title part of the component.
inputPropsOptional
false | (Omit<h.JSX.InputHTMLAttributes<HTMLInputElement>, "ref"> & { [attribute: `data-${string}`]: unknown; }) | undefinedInspect type
false renders a static title while retaining the same header layout.
closeLabelRequiredstringAccessible text for the close action.
closePropsOptional
Omit<h.JSX.ButtonHTMLAttributes<HTMLButtonElement>, "ref"> | undefinedInspect type
Additional button attributes for the dialog close action.

Events and callbacks1

EditableDialogHeader events and callbacks
NameTypeDescription
onCloseOptional
(() => void) | undefinedInspect type
Requests that the parent close the surface or picker.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.

Inherited HTML props and events305