Input

何时使用 {#when-to-use}

• 需要用户输入表单域内容时。
• 提供组合型输入框，带搜索的输入框，还可以进行大小选择。

代码演示 {#examples}

<code src="./demo/basic.tsx">基本使用</code> <code src="./demo/size.tsx">三种大小</code> <code src="./demo/variant.tsx" version="5.13.0">形态变体</code> <code src="./demo/filled-debug.tsx" debug>面性变体 Debug</code> <code src="./demo/addon.tsx" debug>前置/后置标签</code> <code src="./demo/compact-style.tsx">紧凑模式</code> <code src="./demo/group.tsx" debug>输入框组合</code> <code src="./demo/search-input.tsx">搜索框</code> <code src="./demo/search-input-loading.tsx">搜索框 loading</code> <code src="./demo/textarea.tsx">文本域</code> <code src="./demo/autosize-textarea.tsx">适应文本高度的文本域</code> <code src="./demo/otp.tsx" version="5.16.0">一次性密码框</code> <code src="./demo/tooltip.tsx">输入时格式化展示</code> <code src="./demo/presuffix.tsx">前缀和后缀</code> <code src="./demo/password-input.tsx">密码框</code> <code src="./demo/allowClear.tsx">带移除图标</code> <code src="./demo/show-count.tsx">带字数提示</code> <code src="./demo/advance-count.tsx" version=">= 5.10.0">定制计数能力</code> <code src="./demo/status.tsx">自定义状态</code> <code src="./demo/focus.tsx">聚焦</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code> <code src="./demo/borderless-debug.tsx" debug>Style Debug</code> <code src="./demo/align.tsx" debug>文本对齐</code> <code src="./demo/textarea-resize.tsx" debug>文本域</code> <code src="./demo/debug-addon.tsx" debug>debug 前置/后置标签</code> <code src="./demo/component-token.tsx" debug>debug token</code>

API

通用属性参考：通用属性

Input

如果 Input 在 Form.Item 内，并且 Form.Item 设置了 id 属性，则 value defaultValue 和 id 属性会被自动设置。

Input 的其他属性和 React 自带的 input 一致。

CountConfig

interface CountConfig {
  // 最大字符数，不同于原生 `maxLength`，超出后标红但不会截断
  max?: number;
  // 自定义字符计数，例如标准 emoji 长度大于 1，可以自定义计数策略将其改为 1
  strategy?: (value: string) => number;
  // 同 `showCount`
  show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
  // 当字符数超出 `count.max` 时的自定义裁剪逻辑，不配置时不进行裁剪
  exceedFormatter?: (value: string, config: { max: number }) => string;
}

Input.TextArea

同 Input 属性，外加：

Input.TextArea 的其他属性和浏览器自带的 textarea 一致。

Input.Search

其余属性和 Input 一致。

Input.Password

Input.OTP

5.16.0 新增。

开发者注意事项：

当 mask 属性的类型为 string 时，我们强烈推荐接收单个字符或单个 emoji，如果传入多个字符或多个 emoji，则会在控制台抛出警告。

VisibilityToggle

Input Methods

Semantic DOM

Input {#semantic-input}

<code src="./demo/_semantic_input.tsx" simplify="true"></code>

Input.TextArea {#semantic-textarea}

<code src="./demo/_semantic_textarea.tsx" simplify="true"></code>

Input.Search {#semantic-search}

<code src="./demo/_semantic_search.tsx" simplify="true"></code>

Input.Password {#semantic-password}

<code src="./demo/_semantic_password.tsx" simplify="true"></code>

Input.OTP {#semantic-otp}

<code src="./demo/_semantic_otp.tsx" simplify="true"></code>

主题变量（Design Token）{#design-token}

<ComponentTokenTable component="Input"></ComponentTokenTable>

FAQ

为什么我动态改变 prefix/suffix/showCount 时，Input 会失去焦点？ {#faq-lose-focus}

当 Input 动态添加或者删除 prefix/suffix/showCount 时，React 会重新创建 DOM 结构而新的 input 是没有焦点的。你可以预设一个空的 <span /> 来保持 DOM 结构不变：

const suffix = condition ? <Icon type="smile" /> : <span />;

<Input suffix={suffix} />;

为何 TextArea 受控时，value 可以超过 maxLength？ {#faq-textarea-exceed-max}

受控时，组件应该按照受控内容展示。以防止在表单组件内使用时显示值和提交值不同的问题。