---
title: Input 输入框
description: 用于单行文本信息输入。
spline: form
isComponent: true
---
## 引入
全局引入,在 miniprogram 根目录下的`app.json`中配置,局部引入,在需要引入的页面或组件的`index.json`中配置。
```json
"usingComponents": {
"t-input": "tdesign-miniprogram/input/input"
}
```
## 代码演示
在开发者工具中预览效果
### 01 组件类型 基础输入框 {{ base }} 带字数限制输入框 {{ maxlength }} 带操作输入框 {{ suffix }} 带图标输入框 {{ prefix }} 特定类型输入框 {{ special }} ### 02 组件状态 输入框状态 {{ status }} 信息超长状态 {{ label }} ### 03 组件样式 内容位置 {{ align }} 竖排样式 {{ layout }} 非通栏样式 {{ banner }} 标签外置样式 {{ bordered }} 自定义样式文本框 {{ custom }} ## API ### Input Props 名称 | 类型 | 默认值 | 说明 | 必传 -- | -- | -- | -- | -- align | String | left | 文本内容位置,居左/居中/居右。可选项:left/center/right | N layout | String | horizontal | 标题输入框布局方式。可选项:vertical/horizontal | N borderless | Boolean | false | 是否开启无边框模式 | N clearable | Boolean / Object | false | 是否可清空,默认不启动。值为 `true` 表示使用默认清除空按钮,值为 `Object` 表示透传至 `icon` | N clear-trigger | String | always | 清空图标触发方式,仅在输入框有值时有效。可选项:always / focus | N disabled | Boolean | false | 是否禁用输入框 | N error-message | String | - | 已废弃。错误提示文本,值为空不显示(废弃属性,如果需要,请更为使用 status 和 tips) | N format | Function | - | 【开发中】指定输入框展示值的格式。TS 类型:`InputFormatType` `type InputFormatType = (value: InputValue) => number | string`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/input/type.ts) | N label | String / Slot | - | 左侧文本。 | N maxcharacter | Number | - | 用户最多可以输入的字符个数,一个中文汉字表示两个字符长度。`maxcharacter` 和 `maxlength` 二选一使用 | N maxlength | Number | -1 | 用户最多可以输入的文本长度,一个中文等于一个计数长度。默认为 -1,不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用 | N placeholder | String | undefined | 占位符 | N prefix-icon | String / Object / Slot | - | 组件前置图标。值为字符串表示图标名称,值为 `Object` 类型,表示透传至 `icon`。 | N readonly | Boolean | false | 【开发中】只读状态 | N size | String | medium | 【已废弃】输入框尺寸。可选项:small/medium。TS 类型:`'medium' \| 'small'` | N status | String | - | 输入框状态。可选项:success/warning/error | N suffix | String / Slot | - | 后置图标前的后置内容 | N suffix-icon | String / Object / Slot | - | 后置文本内容。值为字符串表示图标名称,值为 `Object` 类型,表示透传至 `icon`。 | N tips | String / Slot | - | 输入框下方提示文本,会根据不同的 `status` 呈现不同的样式 | N type | String | text | 输入框类型。可选项:text/number/idcard/digit/safe-password/password/nickname | N value | String / Number | - | 输入框的值。TS 类型:`InputValue` `type InputValue = string | number`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/input/type.ts) | N default-value | String / Number | undefined | 输入框的值。非受控属性。TS 类型:`InputValue` `type InputValue = string | number`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/input/type.ts) | N password | Boolean | false | 是否是密码类型(已废弃,请更为使用 type 指定输入框类型) | N placeholder-style | String | - | 必需。指定 placeholder 的样式 | Y placeholder-class | String | input-placeholder | 指定 placeholder 的样式类 | N cursor-spacing | Number | 0 | 指定光标与键盘的距离,取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 | N auto-focus | Boolean | false | (即将废弃,请直接使用 focus )自动聚焦,拉起键盘 | N focus | Boolean | false | 获取焦点 | N confirm-type | String | done | 设置键盘右下角按钮的文字,仅在type='text'时生效。Tips: 请确保开发者工具为打开状态。导入开发者工具后,依次执行:npm i > 构建npm包 > 勾选 "将JS编译成ES5"