EditableTextBaseProps

Defined in: src/components/primitives/EditableText/EditableText.types.ts:64

Properties

activationMode?

optional activationMode?: EditableTextActivationMode

Defined in: src/components/primitives/EditableText/EditableText.types.ts:127

How a pointer starts an edit session.

Default

'single'

---

align?

optional align?: TextAlign

Defined in: src/components/primitives/EditableText/EditableText.types.ts:115

Text alignment, matching Text.

---

aria-label?

optional aria-label?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:168

Explicit accessible name. Wins over the value/placeholder-derived name and over labels.editLabel.

---

as?

optional as?: TextElement

Defined in: src/components/primitives/EditableText/EditableText.types.ts:91

HTML element rendered for the display (idle) state.

Default

'span'

---

className?

optional className?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:180

Additional CSS class name applied to the current root element.

---

color?

optional color?: TextColor

Defined in: src/components/primitives/EditableText/EditableText.types.ts:109

Text color, matching Text.

Default

'primary'

---

defaultValue?

optional defaultValue?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:73

Initial committed value (uncontrolled).

---

disabled?

optional disabled?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:134

Disable the field entirely — no editing, no hover affordance, not focusable.

Default

false

---

labels?

optional labels?: Partial<EditableTextLabels>

Defined in: src/components/primitives/EditableText/EditableText.types.ts:162

String overrides for localization. Pass a stable reference (memoize it) — it is low-frequency config.

---

lineHeight?

optional lineHeight?: TextLineHeight

Defined in: src/components/primitives/EditableText/EditableText.types.ts:112

Line height, matching Text.

---

maxLength?

optional maxLength?: number

Defined in: src/components/primitives/EditableText/EditableText.types.ts:156

Maximum number of characters accepted by the edit field.

---

mono?

optional mono?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:121

Use the monospace font family (also implied by variant="code").

---

onChange?

optional onChange?: (value) => void

Defined in: src/components/primitives/EditableText/EditableText.types.ts:79

Called with the new value when an edit is committed. Fires on commit only (Enter / blur), not on every keystroke.

Parameters

value

string

Returns

void

---

onEditEnd?

optional onEditEnd?: (reason) => void

Defined in: src/components/primitives/EditableText/EditableText.types.ts:174

Called when an edit session ends, with the reason.

Parameters

reason

EditableTextEndReason

Returns

void

---

onEditStart?

optional onEditStart?: () => void

Defined in: src/components/primitives/EditableText/EditableText.types.ts:171

Called when an edit session starts.

Returns

void

---

onKeyDown?

optional onKeyDown?: (event) => void

Defined in: src/components/primitives/EditableText/EditableText.types.ts:177

Key-down handler forwarded to the edit field (runs after built-ins).

Parameters

event

KeyboardEvent<HTMLInputElement>

Returns

void

---

placeholder?

optional placeholder?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:85

Placeholder shown when the value is empty, both in the display and the edit field. Rendered in the muted placeholder color.

---

readOnly?

optional readOnly?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:140

Render the value but do not allow editing. Still selectable/focusable.

Default

false

---

ref?

optional ref?: Ref<EditableTextHandle>

Defined in: src/components/primitives/EditableText/EditableText.types.ts:189

Imperative handle — see EditableTextHandle.

---

selectOnEdit?

optional selectOnEdit?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:146

Select the whole value when an edit session starts.

Default

true

---

size?

optional size?: TextSize

Defined in: src/components/primitives/EditableText/EditableText.types.ts:100

Text size, matching Text. Overrides the variant size.

---

style?

optional style?: CSSProperties

Defined in: src/components/primitives/EditableText/EditableText.types.ts:183

Inline styles applied to the current root element.

---

submitOnBlur?

optional submitOnBlur?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:153

Commit the draft when the edit field loses focus. When false, blurring discards the draft instead.

Default

true

---

testId?

optional testId?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:186

Test identifier for automated testing.

---

truncate?

optional truncate?: boolean

Defined in: src/components/primitives/EditableText/EditableText.types.ts:118

Truncate the display text with an ellipsis on overflow.

---

value?

optional value?: string

Defined in: src/components/primitives/EditableText/EditableText.types.ts:68

The committed text value (controlled).

---

variant?

optional variant?: TextVariant

Defined in: src/components/primitives/EditableText/EditableText.types.ts:97

Semantic typography variant, matching Text.

Default

'body'

---

weight?

optional weight?: TextWeight

Defined in: src/components/primitives/EditableText/EditableText.types.ts:103

Text weight, matching Text. Overrides the variant weight.