🔒 此组件作为 私有 API 锁定。我们目前不建议在 Gutenberg 项目之外使用此组件。

有关更详细、交互式的文档,请参阅 WordPress Storybook。

一个演示性质的 contentEditable 表单控件:一个带有标签的可编辑元素
使用包中其他表单控件共享的 chrome(BaseControl + 标签)进行渲染。

与来自 @wordpress/block-editor 的画布内 RichText 不同,此控件
旨在用于独立的表单字段(DataForms、侧边栏输入等)。
它故意仅用于演示,没有 @wordpress/rich-text
依赖项:可编辑行为(值、格式、键盘快捷键)
以及任何焦点/选择跟踪都由消费者拥有,并通过转发的 ref 和本机事件属性将它们连接起来(参见 @wordpress/dataviews 中的 richtext DataForm
控件以获取标准组装方式)。

// rich-text "assembly" 位于消费者端。
<ContentEditableControl
    label="Caption"
    ref={ mergedRef }
    onFocus={ onEditableFocus }
    onBlur={ onEditableBlur }
/>

Props

className

  • 类型:string
  • 必填:否

disabled

  • 类型:boolean
  • 必填:否
  • 默认值:false

该字段是否不可编辑。禁用的字段会暴露
aria-disabled,保留选项卡顺序,并在具有焦点时保持焦点。

hideLabelFromVision

  • 类型:boolean
  • 必填:否
  • 默认值:false

如果为 true,则标签仅对屏幕阅读器可见。

help

  • 类型:ReactNode
  • 必填:否

控件的附加说明。

仅用于控件有意义的描述或说明。包含描述的元素将通过 aria-describedby 属性以编程方式与 BaseControl 关联。

label

  • 类型:string
  • 必填:是

控件的标签文本。

placeholder

  • 类型:string
  • 必填:否

当元素没有内容时显示的占位符文本。通过
aria-placeholder 向辅助技术暴露,并在元素为空时由样式表绘制。

required

  • 类型:boolean
  • 必填:否
  • 默认值:false

该字段是否为必填项。通过
aria-required 向辅助技术暴露。