Editable Description

Editable descriptions allow users to edit the description of some resource in the same place as it's displayed.

#

#

#

#

#

  • As a quick way to edit the description of some resource, without redirecting to a dedicated settings page.

#

Inherits margin props.

NameDefaultDescription
isDisabledfalseboolean

Determines if description is editable.

value

string

Description text.

placeholder"Add a description…"string

Placeholder text.

width"lg""sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "auto" | "100%"

Width of the entire component in editable state.

onCancel

(value: string) => void

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

onChange

(value: string) => void

Callback invoked when user confirms value.

On this page

  • Example
  • Usage
  • Basic
  • Guidelines
  • When to use
  • Props