此功能仍处于实验阶段。“实验性”意味着这是早期实现,可能会发生剧烈且破坏性的变更。

InputControl 组件允许用户输入和编辑文本。这是一个实验性组件,旨在(在未来)合并或替换 TextControl。

用法

import { __experimentalInputControl as InputControl } from '@wordpress/components';
import { useState } from 'react';

const Example = () => {
    const [ value, setValue ] = useState( '' );

    return (
        <InputControl
            value={ value }
            onChange={ ( nextValue ) => setValue( nextValue ?? '' ) }
        />
    );
};

属性

disabled

如果为 true,则禁用 input。

  • 类型:Boolean
  • 必需:否
  • 默认值:false

isPressEnterToChange

如果为 true,必须按下 ENTER 键才能触发 onChange。启用后,在通过 Tab 键移开时也会触发更改(onBlur)。

  • 类型:Boolean
  • 必需:否
  • 默认值:false

hideLabelFromVision

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

  • 类型:Boolean
  • 必需:否

label

如果添加了此属性,将使用 label 属性的内容生成一个标签。

  • 类型:String
  • 必需:否

labelPosition

标签的位置(top、side、bottom 或 edge)。

  • 类型:String
  • 必需:否

onChange

接收输入值的函数。

  • 类型:Function
  • 必需:是

prefix

在输入框左侧渲染元素。

  • 类型:React.ReactNode
  • 必需:否

size

调整输入框的大小。
尺寸包括:default、small

  • 类型:String
  • 必需:否
  • 默认值:default

suffix

在输入框右侧渲染元素。

  • 类型:React.ReactNode
  • 必需:否

type

要渲染的输入元素的类型。默认为 “text”。

  • 类型:String
  • 必需:否
  • 默认值:“text”

value

输入的当前值。

  • 类型:String
  • 必需:否