EditableTextHandle
Defined in: src/components/primitives/EditableText/EditableText.types.ts:49
Imperative handle exposed through ref. Lets an external control (e.g. a
toolbar “Rename” button) drive the edit session and focus.
Properties
Section titled “Properties”cancel
Section titled “cancel”cancel: () =>
void
Defined in: src/components/primitives/EditableText/EditableText.types.ts:55
Leave edit mode, discarding the current draft.
Returns
Section titled “Returns”void
commit
Section titled “commit”commit: () =>
void
Defined in: src/components/primitives/EditableText/EditableText.types.ts:53
Leave edit mode, committing the current draft.
Returns
Section titled “Returns”void
edit: () =>
void
Defined in: src/components/primitives/EditableText/EditableText.types.ts:51
Enter edit mode programmatically (no-op when disabled or read-only).
Returns
Section titled “Returns”void
focus: () =>
void
Defined in: src/components/primitives/EditableText/EditableText.types.ts:57
Focus the edit field while editing, otherwise the display element.
Returns
Section titled “Returns”void
getElement
Section titled “getElement”getElement: () =>
HTMLElement|null
Defined in: src/components/primitives/EditableText/EditableText.types.ts:61
The root DOM element for the current state (display element or input).
Returns
Section titled “Returns”HTMLElement | null
isEditing
Section titled “isEditing”isEditing: () =>
boolean
Defined in: src/components/primitives/EditableText/EditableText.types.ts:59
Whether an edit session is currently active.
Returns
Section titled “Returns”boolean