Reka UI logoReka
backdrop
PropDefaultType
activationMode
'focus'
'dblclick' | 'focus' | 'none'

The activation event of the editable field

as
'div'
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

autoResize
false
boolean

Whether the editable field should auto resize

defaultValue
string

The default value of the editable field

dir
'ltr' | 'rtl'

The reading direction of the calendar when applicable.
If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.

disabled
false
boolean

Whether the editable field is disabled

id
string

The id of the field

maxLength
number

The maximum number of characters allowed

modelValue
string | null

The value of the editable field

name
string

The name of the field. Submitted with its owning form as part of a name/value pair.

placeholder
'Enter text...'
string | { edit: string; preview: string; }

The placeholder for the editable field

readonly
boolean

Whether the editable field is read-only

required
false
boolean

When true, indicates that the user must set the value before the owning form can be submitted.

selectOnFocus
false
boolean

Whether to select the text in the input when it is focused.

startWithEditMode
boolean

Whether to start with the edit mode active

submitMode
'blur'
'blur' | 'none' | 'enter' | 'both'

The submit event of the editable field

EmitPayload
submit
[value: string | null]

Event handler called when a value is submitted

update:modelValue
[value: string]

Event handler called whenever the model value changes

update:state
[state: 'cancel' | 'submit' | 'edit']

Event handler called when the editable field changes state

Slots (default)Payload
isEditing
boolean

Whether the editable field is in edit mode

modelValue
string | null | undefined

The value of the editable field

isEmpty
boolean

Whether the editable field is empty

submit
(): void

Function to submit the value of the editable

cancel
(): void

Function to cancel the value of the editable

edit
(): void

Function to set the editable in edit mode

MethodsType
submit
() => void

Function to submit the value of the editable

cancel
() => void

Function to cancel the value of the editable

edit
() => void

Function to set the editable in edit mode