133 lines
5.6 KiB
Markdown
133 lines
5.6 KiB
Markdown
|
---
|
|||
|
|
title: Textarea 多行文本框
|
|||
|
|
description: 用于多行文本信息输入。
|
|||
|
|
spline: form
|
|||
|
|
isComponent: true
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
## 引入
|
|||
|
|
|
|||
|
|
可在 `main.ts` 或在需要使用的页面或组件中引入。
|
|||
|
|
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
import TTextarea from '@tdesign/uniapp/textarea/textarea.vue';
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 组件类型
|
|||
|
|
|
|||
|
|
基础多行文本框
|
|||
|
|
|
|||
|
|
{{ base }}
|
|||
|
|
|
|||
|
|
带标题多行文本框
|
|||
|
|
|
|||
|
|
{{ label }}
|
|||
|
|
|
|||
|
|
自动增高多行文本框
|
|||
|
|
|
|||
|
|
{{ autosize }}
|
|||
|
|
|
|||
|
|
设置最大字符个数
|
|||
|
|
|
|||
|
|
{{ maxlength }}
|
|||
|
|
|
|||
|
|
设置最大字符个数，一个汉字表示两个字符
|
|||
|
|
|
|||
|
|
{{ maxcharacter }}
|
|||
|
|
|
|||
|
|
### 组件状态
|
|||
|
|
|
|||
|
|
禁用多行文本框
|
|||
|
|
|
|||
|
|
{{ disabled }}
|
|||
|
|
|
|||
|
|
### 自定义组件样式
|
|||
|
|
|
|||
|
|
标签外置输入框
|
|||
|
|
|
|||
|
|
{{ custom }}
|
|||
|
|
|
|||
|
|
## 提示
|
|||
|
|
|
|||
|
|
- 如果需要在页面中调整 `textarea` 中 `placeholder` 样式，请使用名称为`t-textarea__placeholder`的Class选择器，直接覆盖组件内部样式（注意权重）。
|
|||
|
|
|
|||
|
|
## API
|
|||
|
|
|
|||
|
|
### Textarea Props
|
|||
|
|
|
|||
|
|
名称 | 类型 | 默认值 | 描述 | 必传
|
|||
|
|
-- | -- | -- | -- | --
|
|||
|
|
custom-style | Object | - | 自定义样式 | N
|
|||
|
|
adjust-position | Boolean | true | 键盘弹起时，是否自动上推页面 | N
|
|||
|
|
allow-input-over-max | Boolean | false | 超出 `maxlength` 或 `maxcharacter` 之后是否还允许输入 | N
|
|||
|
|
autofocus | Boolean | false | 自动聚焦，拉起键盘 | N
|
|||
|
|
autosize | Boolean / Object | false | 是否自动增高，值为 true 时，style.height 不生效。支持传入对象，如 { maxHeight: 120, minHeight: 20 }。TS 类型：`boolean \| { maxHeight?: number, minHeight?: number }` | N
|
|||
|
|
bordered | Boolean | false | 是否显示外边框 | N
|
|||
|
|
confirm-hold | Boolean | false | 点击键盘右下角按钮时是否保持键盘不收起点 | N
|
|||
|
|
confirm-type | String | return | 设置键盘右下角按钮的文字，仅在 type='text'时生效。可选项：return/send/search/next/go/done。TS 类型：`'return' \| 'send' \| 'search' \| 'next' \| 'go' \| 'done'` | N
|
|||
|
|
cursor | Number | -1 | 指定 focus 时的光标位置 | N
|
|||
|
|
cursor-color | String | #0052d9 | 【试验性】光标颜色，仅在 Skyline 下有效 | N
|
|||
|
|
cursor-spacing | Number | 0 | 指定光标与键盘的距离。取textarea距离底部的距离和cursor-spacing指定的距离的最小值作为光标与键盘的距离 | N
|
|||
|
|
disable-default-padding | Boolean | false | 是否去掉 iOS 下的默认内边距 | N
|
|||
|
|
disabled | Boolean | undefined | 是否禁用文本框 | N
|
|||
|
|
fixed | Boolean | false | 如果 textarea 是在一个 `position:fixed` 的区域，需要显式指定属性 fixed 为 true | N
|
|||
|
|
focus | Boolean | false | 自动聚焦 | N
|
|||
|
|
hold-keyboard | Boolean | false | focus时，点击页面的时候不收起键盘 | N
|
|||
|
|
indicator | Boolean | false | 显示文本计数器，如 0/140。当 `maxlength < 0 && maxcharacter < 0` 成立时， indicator无效 | N
|
|||
|
|
label | String | - | 左侧文本 | N
|
|||
|
|
maxcharacter | Number | - | 用户最多可以输入的字符个数，一个中文汉字表示两个字符长度 | N
|
|||
|
|
maxlength | Number | -1 | 用户最多可以输入的字符个数，值为 -1 的时候不限制最大长度 | N
|
|||
|
|
placeholder | String | undefined | 占位符 | N
|
|||
|
|
placeholder-class | String | textarea-placeholder | 指定 placeholder 的样式类，目前仅支持color,font-size和font-weight | N
|
|||
|
|
placeholder-style | String | - | 指定 placeholder 的样式，目前仅支持 color ,font-size和font-weight | N
|
|||
|
|
readonly | Boolean | undefined | 只读状态 | N
|
|||
|
|
selection-end | Number | -1 | 光标结束位置，自动聚集时有效，需与 selection-start 搭配使用 | N
|
|||
|
|
selection-start | Number | -1 | 光标起始位置，自动聚集时有效，需与 selection-end 搭配使用 | N
|
|||
|
|
show-confirm-bar | Boolean | true | 是否显示键盘上方带有”完成“按钮那一栏 | N
|
|||
|
|
value | String / Number | - | 文本框值。支持语法糖 `v-model:value`。TS 类型：`TextareaValue` `type TextareaValue = string \| number`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/textarea/type.ts) | N
|
|||
|
|
default-value | String / Number | - | 文本框值。非受控属性。TS 类型：`TextareaValue` `type TextareaValue = string \| number`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/textarea/type.ts) | N
|
|||
|
|
|
|||
|
|
### Textarea Events
|
|||
|
|
|
|||
|
|
名称 | 参数 | 描述
|
|||
|
|
-- | -- | --
|
|||
|
|
blur | `(context: { value: TextareaValue, cursor: number })` | 失去焦点时触发
|
|||
|
|
change | `(context: { value: TextareaValue, cursor: number })` | 输入内容变化时触发
|
|||
|
|
enter | `(context: { value: TextareaValue })` | 点击完成时触发
|
|||
|
|
focus | `(context: { value: TextareaValue })` | 获得焦点时触发
|
|||
|
|
keyboardheightchange | `(context: { height: number, duration: number })` | 键盘高度发生变化的时候触发此事件
|
|||
|
|
line-change | `(context: { value: TextareaValue })` | 行高发生变化时触发
|
|||
|
|
|
|||
|
|
### Textarea Slots
|
|||
|
|
|
|||
|
|
名称 | 描述
|
|||
|
|
-- | --
|
|||
|
|
label | 自定义 `label` 显示内容
|
|||
|
|
|
|||
|
|
### Textarea External Classes
|
|||
|
|
|
|||
|
|
类名 | 描述
|
|||
|
|
-- | --
|
|||
|
|
t-class | 根节点样式类
|
|||
|
|
t-class-indicator | 计数器样式类
|
|||
|
|
t-class-label | 左侧文本样式类
|
|||
|
|
t-class-textarea | 多行文本框样式类
|
|||
|
|
|
|||
|
|
### CSS Variables
|
|||
|
|
|
|||
|
|
组件提供了下列 CSS 变量，可用于自定义样式。
|
|||
|
|
名称 | 默认值 | 描述
|
|||
|
|
-- | -- | --
|
|||
|
|
--td-textarea-background-color | @bg-color-container | -
|
|||
|
|
--td-textarea-border-color | @component-border | -
|
|||
|
|
--td-textarea-border-radius | @radius-default | -
|
|||
|
|
--td-textarea-disabled-text-color | @text-color-disabled | -
|
|||
|
|
--td-textarea-indicator-text-color | @text-color-placeholder | -
|
|||
|
|
--td-textarea-label-color | @text-color-primary | -
|
|||
|
|
--td-textarea-padding | 32rpx | -
|
|||
|
|
--td-textarea-placeholder-color | @text-color-placeholder | -
|
|||
|
|
--td-textarea-text-color | @text-color-primary | -
|