var Component=(()=>{var u=Object.create;var a=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var m=Object.getPrototypeOf,g=Object.prototype.hasOwnProperty;var b=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports),x=(t,e)=>{for(var o in e)a(t,o,{get:e[o],enumerable:!0})},s=(t,e,o,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of p(e))!g.call(t,i)&&i!==o&&a(t,i,{get:()=>e[i],enumerable:!(r=h(e,i))||r.enumerable});return t};var E=(t,e,o)=>(o=t!=null?u(m(t)):{},s(e||!t||!t.__esModule?a(o,"default",{value:t,enumerable:!0}):o,t)),f=t=>s(a({},"__esModule",{value:!0}),t);var l=b((B,c)=>{c.exports=_jsx_runtime});var w={};x(w,{default:()=>j,frontmatter:()=>I});var n=E(l()),I={id:"editable",category:"form",title:"Editable",package:"@chakra-ui/react",description:"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."};function d(t){let e=Object.assign({h2:"h2",pre:"pre",code:"code",p:"p",h3:"h3"},t.components);return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.h2,{id:"import",children:"Import"}),` `,(0,n.jsx)(e.pre,{children:(0,n.jsx)(e.code,{className:"language-js",children:`import { Editable } from '@chakra-ui/react' `})}),` `,(0,n.jsx)(e.h2,{id:"usage",children:"Usage"}),` `,(0,n.jsxs)(e.p,{children:[`The editable's text input and preview inherits all font styling from the root `,(0,n.jsx)(e.code,{children:"Editable"}),` container in order to make the edit and read view transition seamless.`]}),` `,(0,n.jsx)(e.pre,{children:(0,n.jsx)(e.code,{className:"language-jsx",children:`// Click the text to edit `})}),` `,(0,n.jsx)(e.h3,{id:"usage-with-textarea",children:"Usage with textarea"}),` `,(0,n.jsx)(e.pre,{children:(0,n.jsx)(e.code,{className:"language-jsx",children:`// Click the text to edit `})}),` `,(0,n.jsx)(e.h3,{id:"with-custom-input-and-controls",children:"With custom input and controls"}),` `,(0,n.jsx)(e.p,{children:`In some cases, you might need to use custom controls to toggle the edit and read mode. We use the render prop pattern to provide access to the internal state of the component.`}),` `,(0,n.jsxs)(e.p,{children:["You may want to customize the ",(0,n.jsx)(e.code,{children:"Editable.Input"}),` as well. This can be achieved by using a custom `,(0,n.jsx)(e.code,{children:"Input"})," component in the ",(0,n.jsx)(e.code,{children:"as"})," prop."]}),` `,(0,n.jsx)(e.pre,{children:(0,n.jsx)(e.code,{className:"language-jsx",children:`function CustomControlsExample() { /* Here's a custom control */ function EditableControls() { const { isEditing, getSubmitButtonProps, getCancelButtonProps, getEditButtonProps, } = useEditableControls() return isEditing ? ( ) : ( ) } return ( ) } `})})]})}function C(t={}){let{wrapper:e}=t.components||{};return e?(0,n.jsx)(e,Object.assign({},t,{children:(0,n.jsx)(d,t)})):d(t)}var j=C;return f(w);})(); ;return Component;

Editable

Props#

Editable Props#

Props#

Editable Props#