amis/docs/zh-CN/components/form/textarea.md
2023-05-28 22:26:48 +08:00

4.9 KiB
Executable File

title description type group menuName icon order
Textarea 多行文本输入框 0 null Textarea 多行文本输入框 57

基本使用

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "name": "textarea",
            "type": "textarea",
            "label": "多行文本"
        }
    ]
}

清空输入框

带移除图标的输入框,点击图标删除所有内容。

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "name": "textarea",
            "type": "textarea",
            "label": "多行文本",
            "clearable": true,
            "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmodtion tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
        }
    ]
}

设置resetValue,清空输入框后重置为指定值

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "name": "textarea",
            "type": "textarea",
            "label": "多行文本",
            "clearable": true,
            "resetValue": "reset"
        }
    ]
}

显示计数器

配置"showCounter": true后输入框将显示计数器,一般会配合maxLength属性以限制输入长度,如果不设置maxLength,则仅展示计数器,并不会限制用户的输入长度。

{
    "type": "form",
    "body": [
        {
            "name": "a",
            "type": "textarea",
            "label": "A",
            "showCounter": true,
            "placeholder": "请输入",
            "clearable": true
        },
        {
            "name": "b",
            "type": "textarea",
            "label": "B",
            "showCounter": true,
            "maxLength": 30,
            "placeholder": "请输入"
        }
    ]
}

属性表

当做选择器表单项使用时,除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明
minRows number 3 最小行数
maxRows number 20 最大行数
trimContents boolean true 是否去除首尾空白文本
readOnly boolean false 是否只读
showCounter boolean false 是否显示计数器
maxLength number - 限制最大字数
clearable boolean false 是否可清除
resetValue string "" 清除后设置此配置项给定的值。

事件表

当前组件会对外派发以下事件,可以通过onEvent来监听这些事件,并通过actions来配置执行的动作,在actions中可以通过${事件参数名}${event.data.[事件参数名]}来获取事件产生的数据,详细请查看事件动作

[name]表示当前组件绑定的名称,即name属性,如果没有配置name属性,则通过value取值。

事件名称 事件参数 说明
change [name]: string 组件的值 值变化时触发
focus [name]: string 组件的值 输入框获取焦点时触发
blur [name]: string 组件的值 输入框失去焦点时触发

动作表

当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称componentId: 该组件id来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}来配置具体的参数,详细请查看事件动作

动作名称 动作配置 说明
clear - 清空
reset - 将值重置为resetValue,若没有配置resetValue,则清空
focus - 获取焦点
setValue value: string 更新的值 更新数据