

<DemoTitle title="Input" desc="通过鼠标或键盘输入内容，为表单提供输入字段的基础容器。。">
#### API

| 属性名 | 描述 | 类型 | 默认值 | 
|--------|--------|--------|--------|
| shape | 形态 | 'default' \| 'round' | default 默认 | 


<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>


## antd API

通用属性参考：[通用属性](/docs/react/common-props)

### Input

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| addonAfter | 带标签的 input，设置后置标签 | ReactNode | - |  | 
| addonBefore | 带标签的 input，设置前置标签 | ReactNode | - |  | 
| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - |  | 
| classNames | 语义化结构 class | Record< | - | 5.4.0 | 
| count | 字符计数配置 |  | - | 5.10.0 | 
| defaultValue | 输入框默认内容 | string | - |  | 
| disabled | 是否禁用状态，默认为 false | boolean | false |  | 
| id | 输入框的 id | string | - |  | 
| maxLength | 最大长度 | number | - |  | 
| prefix | 带有前缀图标的 input | ReactNode | - |  | 
| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 | 
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | 
| styles | 语义化结构 style | Record< | - | 5.4.0 | 
| size | 控件大小。注：标准表单内的输入框大小限制为  | large | - |  | 
| suffix | 带有后缀图标的 input | ReactNode | - |  | 
| type | 声明 input 类型，同原生 input 标签的 type 属性，见： | string | text |  | 
| value | 输入框内容 | string | - |  | 
| variant | 形态变体 | outlined | outlined | 5.13.0 \|  | 
| onChange | 输入框内容变化时的回调 | function(e) | - |  | 
| onPressEnter | 按下回车的回调 | function(e) | - |  | 
| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 | 


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

Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。

#### CountConfig


```tsx
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 属性，外加：

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| autoSize | 自适应内容高度，可设置为 true \| false 或对象：{ minRows: 2, maxRows: 6 } | boolean \| object | false |  | 
| classNames | 语义化结构 class | Record< | - | 5.4.0 | 
| styles | 语义化结构 style | Record< | - | 5.4.0 | 


`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。

### Input.Search

| 参数 | 说明 | 类型 | 默认值 | 
|--------|--------|--------|--------|
| enterButton | 是否有确认按钮，可设为按钮文字。该属性会与  | ReactNode | false | 
| loading | 搜索 loading | boolean | false | 
| onSearch | 点击搜索图标、清除图标，或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - | 


其余属性和 Input 一致。

### Input.Password

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ?  : ) | 4.3.0 | 
| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \|  | true |  | 


### Input.OTP

`5.16.0` 新增。

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

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultValue | 默认值 | string | - |  | 
| disabled | 是否禁用 | boolean | false |  | 
| formatter | 格式化展示，留空字段会被  | (value: string) => string | - |  | 
| separator | 分隔符，在指定索引的输入框后渲染分隔符 | ReactNode \|((i: number) => ReactNode) | - | 5.24.0 | 
| mask | 自定义展示，和  | boolean \| string | false | 5.17.0 | 
| length | 输入元素数量 | number | 6 |  | 
| status | 设置校验状态 | 'error' \| 'warning' | - |  | 
| size | 输入框大小 | small | middle |  | 
| variant | 形态变体 | outlined | outlined | underlined | 
| value | 输入框内容 | string | - |  | 
| onChange | 当输入框内容全部填充时触发回调 | (value: string) => void | - |  | 
| onInput | 输入值变化时触发的回调 | (value: string[]) => void | - | 5.22.0 | 


#### VisibilityToggle

| Property | Description | Type | Default | Version | 
|--------|--------|--------|--------|--------|
| visible | 用于手动控制密码显隐 | boolean | false | 4.24 | 
| onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 | 


#### Input Methods

| 名称 | 说明 | 参数 | 版本 | 
|--------|--------|--------|--------|
| blur | 取消焦点 | - |  | 
| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 | 
