defaultValue
Description
The initial value of the Editable in both edit & preview mode.
Type
stringEditable
Editable is a component used to obtain inline editable text input.
Props
EditableInputProps
EditablePreviewProps
EditableProps
disabled
Description
If true, the form control will be disabled.
Type
booleanDefault
falseerrorBorderColor
Description
The border color when the input is invalid.
Type
"border" | "link" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 319 more ... | [...]focusBorderColor
Description
The border color when the input is focused.
Type
"border" | "link" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 319 more ... | [...]invalid
Description
If true, the form control will be invalid.
Type
booleanDefault
falseisDisabled
DeprecatedDescription
If true, the form control will be disabled.
Deprecated
Use disabled instead.
Type
booleanDefault
falseisInvalid
DeprecatedDescription
If true, the form control will be invalid.
Deprecated
Use invalid instead.
Type
booleanDefault
falseisPreviewFocusable
DeprecatedDescription
If true, the read only view, has a tabIndex set to 0
so it can receive focus via the keyboard or click.
Deprecated
Use previewFocusable instead.
Type
booleanDefault
trueisReadOnly
DeprecatedDescription
If true, the form control will be readonly.
Deprecated
Use readOnly instead.
Type
booleanDefault
falseisRequired
DeprecatedDescription
If true, the form control will be required.
Deprecated
Use required instead.
Type
booleanDefault
falseonCancel
Description
Callback invoked when user cancels input with the Esc key.
It provides the last confirmed value as argument.
Type
(preValue: string) => voidonChange
Description
A callback invoked when user changes input.
Type
(value: string) => voidonEdit
Description
A callback invoked once the user enters edit mode.
Type
() => voidonSubmit
Description
A callback invoked when user confirms value with enter key or by blurring input.
Type
(value: string) => voidplaceholder
Description
The placeholder text when the value is empty.
Type
stringpreviewFocusable
Description
If true, the read only view, has a tabIndex set to 0
so it can receive focus via the keyboard or click.
Type
booleanDefault
truereadOnly
Description
If true, the form control will be readonly.
Type
booleanDefault
falserequired
Description
If true, the form control will be required.
Type
booleanDefault
falseselectAllOnFocus
Description
If true, the input's text will be highlighted on focus.
Type
booleanDefault
truestartWithEditView
Description
If true, the Editable will start with edit mode by default.
Type
booleansubmitOnBlur
Description
If true, it'll update the value onBlur and turn off the edit mode.
Type
booleanDefault
truevalue
Description
The value of the Editable in both edit & preview mode.
Type
stringEditableTextareaProps
UseEditableProps
defaultValue
Description
The initial value of the Editable in both edit & preview mode.
Type
stringdisabled
Description
If true, the form control will be disabled.
Type
booleanDefault
falseinvalid
Description
If true, the form control will be invalid.
Type
booleanDefault
falseisDisabled
DeprecatedDescription
If true, the form control will be disabled.
Deprecated
Use disabled instead.
Type
booleanDefault
falseisInvalid
DeprecatedDescription
If true, the form control will be invalid.
Deprecated
Use invalid instead.
Type
booleanDefault
falseisPreviewFocusable
DeprecatedDescription
If true, the read only view, has a tabIndex set to 0
so it can receive focus via the keyboard or click.
Deprecated
Use previewFocusable instead.
Type
booleanDefault
trueisReadOnly
DeprecatedDescription
If true, the form control will be readonly.
Deprecated
Use readOnly instead.
Type
booleanDefault
falseisRequired
DeprecatedDescription
If true, the form control will be required.
Deprecated
Use required instead.
Type
booleanDefault
falseonCancel
Description
Callback invoked when user cancels input with the Esc key.
It provides the last confirmed value as argument.
Type
(preValue: string) => voidonChange
Description
A callback invoked when user changes input.
Type
(value: string) => voidonEdit
Description
A callback invoked once the user enters edit mode.
Type
() => voidonSubmit
Description
A callback invoked when user confirms value with enter key or by blurring input.
Type
(value: string) => voidplaceholder
Description
The placeholder text when the value is empty.
Type
stringpreviewFocusable
Description
If true, the read only view, has a tabIndex set to 0
so it can receive focus via the keyboard or click.
Type
booleanDefault
truereadOnly
Description
If true, the form control will be readonly.
Type
booleanDefault
falserequired
Description
If true, the form control will be required.
Type
booleanDefault
falseselectAllOnFocus
Description
If true, the input's text will be highlighted on focus.
Type
booleanDefault
truestartWithEditView
Description
If true, the Editable will start with edit mode by default.
Type
booleansubmitOnBlur
Description
If true, it'll update the value onBlur and turn off the edit mode.
Type
booleanDefault
truevalue
Description
The value of the Editable in both edit & preview mode.
Type
stringEdit this page on GitHub