130 lines
7.4 KiB
Markdown
130 lines
7.4 KiB
Markdown
---
|
||
title: Input 输入框
|
||
description: 用于单行文本信息输入。
|
||
spline: form
|
||
isComponent: true
|
||
---
|
||
|
||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-97%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-88%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-97%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-92%25-blue" /></span>
|
||
## 引入
|
||
|
||
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"t-input": "tdesign-miniprogram/input/input"
|
||
}
|
||
```
|
||
### 主题定制
|
||
CSS 变量名|说明
|
||
--|--
|
||
--td-input-bg-color | 输入框背景颜色
|
||
--td-input-text-color | 输入框文本颜色
|
||
--td-input-placeholder-text-color | 输入框placeholder占位符颜色
|
||
--td-input-error-text-color | 输入错误时文本颜色
|
||
--td-input-disabled-text-color | 禁用输入框颜色
|
||
--td-input-border-color | 输入框边框颜色
|
||
--td-input-error-msg-color | 错误提示文本颜色
|
||
--td-input-icon-color | 图标颜色
|
||
--td-input-suffix-text-color | 后置文本内容颜色
|
||
|
||
## 代码演示
|
||
|
||
## 类型
|
||
### 基础文本框
|
||
|
||
<img src="https://tdesign.gtimg.com/miniprogram/readme/input-1.png" width="375px" height="50%">
|
||
|
||
{{ base }}
|
||
|
||
### 必填、选填文本框
|
||
|
||
{{ require }}
|
||
|
||
### 带提示信息文本框
|
||
|
||
{{ suffix }}
|
||
|
||
## 状态
|
||
### 文本框状态
|
||
|
||
{{ status }}
|
||
|
||
## 特殊类型
|
||
### 特殊文本类型
|
||
|
||
{{ special }}
|
||
|
||
## 规格
|
||
### 文本框尺寸规格
|
||
|
||
{{ size }}
|
||
|
||
## 内容位置
|
||
### 文本框内容位置
|
||
|
||
{{ align }}
|
||
|
||
## 字数限制
|
||
### 文本框字数限制
|
||
|
||
{{ maxlength }}
|
||
|
||
## API
|
||
### Input Props
|
||
|
||
名称 | 类型 | 默认值 | 说明 | 必传
|
||
-- | -- | -- | -- | --
|
||
align | String | left | 文本内容位置，居左/居中/居右。可选项：left/center/right | N
|
||
borderless | Boolean | true | 是否开启无边框模式 | N
|
||
clearable | Boolean | false | 是否可清空 | N
|
||
disabled | Boolean | false | 是否禁用输入框 | N
|
||
error-message | String | - | 错误提示文本，值为空不显示（废弃属性，如果需要，请更为使用 status 和 tips） | N
|
||
external-classes | Array | - | 组件类名，用于设置组件外层元素、输入框、占位符、错误信息等元素类名。`['t-class','t-class-icon', 't-class-label', 't-class-input', 't-class-clearable', 't-class-suffix', 't-class-suffix-icon', 't-class-error-msg']` | 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 | - | 用户最多可以输入的文本长度，一个中文等于一个计数长度。值小于等于 0 的时候，则表示不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用 | N
|
||
placeholder | String | undefined | 占位符 | N
|
||
prefix-icon | String / Slot | - | 组件前置图标，值为字符串则表示图标名称 | N
|
||
readonly | Boolean | false | 【开发中】只读状态 | N
|
||
size | String | small | 输入框尺寸。可选项：small/medium。TS 类型：`'medium' | 'small'` | N
|
||
status | String | - | 【开发中】输入框状态。可选项：success/warning/error | N
|
||
suffix | String / Slot | - | 后置图标前的后置内容 | N
|
||
suffix-icon | String / Slot | - | 后置文本内容，值为字符串则表示图标名称 | N
|
||
tips | String / Slot | - | 【开发中】输入框下方提示文本，会根据不同的 `status` 呈现不同的样式 | N
|
||
type | String | text | 输入框类型。可选项：text/number/idcard/digit/safe-password/password | 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'时生效。<br />具体释义：<br />`send` 右下角按钮为“发送”；<br />`search` 右下角按钮为“搜索”；<br />`next` 右下角按钮为“下一个”；<br />`go` 右下角按钮为“前往”；<br />`done` 右下角按钮为“完成”。<br />[小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/component/input.html)。可选项：send/search/next/go/done | N
|
||
always-embed | Boolean | false | 强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) | N
|
||
confirm-hold | Boolean | false | 点击键盘右下角按钮时是否保持键盘不收起 | N
|
||
cursor | Number | - | 必需。指定focus时的光标位置 | Y
|
||
selection-start | Number | -1 | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 | N
|
||
selection-end | Number | -1 | 光标结束位置，自动聚集时有效，需与selection-start搭配使用 | N
|
||
adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N
|
||
hold-keyboard | Boolean | false | focus时，点击页面的时候不收起键盘 | N
|
||
safe-password-cert-path | String | - | 安全键盘加密公钥的路径，只支持包内路径 | N
|
||
safe-password-length | Number | - | 安全键盘输入密码长度 | N
|
||
safe-password-time-stamp | Number | - | 安全键盘加密时间戳 | N
|
||
safe-password-nonce | String | - | 安全键盘加密盐值 | N
|
||
safe-password-salt | String | - | 安全键盘计算hash盐值，若指定custom-hash 则无效 | N
|
||
safe-password-custom-hash | String | - | 安全键盘计算hash的算法表达式，如 `md5(sha1('foo' + sha256(sm3(password + 'bar'))))` | N
|
||
|
||
### Input Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
blur | `(value: InputValue)` | 失去焦点时触发
|
||
change | `(value: InputValue, cursor: number, keyCode: number)` | 输入框值发生变化时触发；cursor 为光标位置；keyCode 为键值
|
||
clear | - | 清空按钮点击时触发
|
||
enter | `(value: InputValue)` | 回车键按下时触发
|
||
focus | `(value: InputValue)` | 获得焦点时触发
|
||
keyboardheightchange | `(height: number, duration: number)` | 键盘高度发生变化的时候触发此事件
|