Editable

EditableText is used for inline renaming of some text. It appears as normal UI text but transforms into a text input field when the user clicks or focuses on it.

    SourceTheme source@chakra-ui/editable

Props#

Editable Props#

colorScheme

Description

Color Schemes for Editable are not implemented in the default theme. You can extend the theme to implement them.

Type
(string & {})

defaultValue

Description

The initial value of the Editable in both edit & preview mode

Type
string

isDisabled

Description

If true, the Editable will be disabled.

Type
boolean

isPreviewFocusable

Description

If true, the read only view, has a tabIndex set to 0 so it can receive focus via the keyboard or click.

Type
boolean
Default
true

onCancel

Description

Callback invoked when user cancels input with the Esc key. It provides the last confirmed value as argument.

Type
((previousValue: string) => void)

onChange

Description

Callback invoked when user changes input.

Type
((nextValue: string) => void)

onEdit

Description

Callback invoked once the user enters edit mode.

Type
(() => void)

onSubmit

Description

Callback invoked when user confirms value with enter key or by blurring input.

Type
((nextValue: string) => void)

placeholder

Description

The placeholder text when the value is empty.

Type
string

selectAllOnFocus

Description

If true, the input's text will be highlighted on focus.

Type
boolean
Default
true

size

Description

Sizes for Editable are not implemented in the default theme. You can extend the theme to implement them.

Type
string

startWithEditView

Description

If true, the Editable will start with edit mode by default.

Type
boolean

submitOnBlur

Description

If true, it'll update the value onBlur and turn off the edit mode.

Type
boolean
Default
true

value

Description

The value of the Editable in both edit & preview mode

Type
string

variant

Description

Variants for Editable are not implemented in the default theme. You can extend the theme to implement them.

Type
string
Edit this page on GitHub

Proudly made inNigeria by Segun Adebayo

Deployed by Vercel