跳到主要内容

多行输入

WdTextarea

适用场景

用于多行内容的输入。

基础能力说明

1、绑定「文本」类型字段,表单容器绑定数据模型后,模型中的文本字段(格式选择多行文本)会自动渲染为多行输入组件,实现多行数据的录入。可配置输入值、占位文字、组件尺寸和是否横向占满(组件尺寸和是否横向占满在 PC 端生效,在移动端不生效)。

2、支持标题的个性化配置,包含标题的内容、对齐方式、是否换行(开启时,标题字数超过一行时换行展示;关闭时,标题字数超过一行时省略展示)、标题位置、宽度、和标题的提示语。

3、支持输入框的个性化配置,包含输入框下方提示、是否显示字数、是否自动获取焦点、移动端是否展示下划线/PC 端是否展示输入框。

注:

  • 多行输入组件和单行输入不同,没有前后缀文本、前后缀图标的配置;
  • 尺寸配置仅针对 PC 端生效;
  • 如果组件在表单容器中,组件尺寸,标题对齐、位置、换行、宽度默认会跟随表单容器的属性配置
  • 多行输入组件默认会显示输入内容的字数统计;
  • 多行输入组件默认高度为两行,运行态会根据输入内容自动增高,输入内容超过十行时,通过滚动条进行内容查看;

了解更多的表单组件使用场景,可查阅 表单常见场景实践指南

示例

交互式预览

组件装饰

组件大小

组件对齐方式

组件输入状态

组件样式 API 示例

#wd-page-root .wd-form-item .wd-textarea-textarea {
border-color: cyan;
color: cyan;
background-color: black;
border-width: 2px;
border-radius: 6px;
--wd-color-text-placeholder: red;
}

属性

组件接收的外部传入的属性

属性名
属性标识
类型
说明
显示标题labelVisibleboolean

默认值:true

标题对齐labelAlignstring

表单场景下默认会跟随表单容器的标题对齐配置

标题换行labelWrapboolean

如果标题内容过长关闭时只显示一行、溢出省略;开启时换行展示。表单场景下默认会跟随表单容器的标题换行配置

标题位置layoutstring

设置标题在表单组件的展示位置,表单场景下默认会跟随表单容器的标题的位置配置

标题宽度labelWidthstring

您可以输入数值 + px、%等单位,示例:200px

表单场景下默认会跟随表单容器的标题宽度配置

标题提示labelTipsstring

PC/H5端生效

配置标题的工具提示内容

是否自动增高autoHeightboolean

是否自动增高,设置auto-height时,style.height不生效;仅小程序端生效。

默认值:true

光标距键盘距离cursorSpacingnumber

指定光标与键盘的距离。取textarea距离底部的距离和cursor-spacing指定的距离的最小值作为光标与键盘的距离;仅小程序端生效。

0
下方提示extrastring

配置后提示内容常显在输入框下方

显示字数counterVisibleboolean

默认值:true

自动获取焦点focusboolean

开启后页面加载后光标自动定位到该输入框

移动端显示下划线borderedH5boolean

关闭后移动端不显示底部下划线

默认值:true

PC端显示输入边框borderedPcboolean

关闭后PC端不显示输入边框

默认值:true

最大长度maxLengthnumber

默认值:140

校验规则rulesarray

默认值:[]

状态statusstring

示例:"edit"

必填requiredboolean
必填标识requiredFlagboolean

启用后,组件若要求必填,则会显示必填星号标记

默认值:true

必填校验提示requiredMsgstring

示例:"该项为必填项"

绑定字段namestring

表单字段的Key值,用于提交数据时,匹配数据模型字段标识。表单内需保证唯一。

示例:"formTextarea"

标题内容labelstring

示例:"标题"

输入值valuestring

示例:""

占位文字placeholderstring

示例:"请输入"

PC端组件尺寸sizestring

尺寸配置仅对PC端生效,表单场景下默认会跟随表单容器的组件尺寸配置

事件

组件暴露的事件,可以监听组件的事件来触发一些外部的动作

事件名
事件code
事件出参 event.detail
适用情况
说明
值改变changeobject
  • value: string

    输入值

兼容三端

用户修改组件值时触发

聚焦focusobject
  • value: string

    输入值

兼容三端

-

失焦blurobject
  • value: string

    输入值

兼容三端

-

属性 API

通过属性 API,可以获取组件内部的状态和属性值,可以通过$w.componentId.propertyName 来访问组件内部的值,如 $w.input1.value ,详请请参考 属性 API

只读属性名
属性标识
类型
说明
绑定字段namestring

表单字段的Key值,用于提交数据时,匹配数据模型字段标识。表单内需保证唯一。

标题内容labelstring
输入值valuestring
必填requiredboolean
是否展示visibleboolean

组件是否展示

是否禁用disabledboolean

组件是否禁用

是否只读readOnlyboolean

组件是否只读

方法 API

通过方法 API,可以通过程序触发组件内部的方法,比如提交表单,显示弹窗等, 可以通过$w.componentId.methodName来调用组件方法,如 $w.form1.submit()

方法名
方法标识
参数
方法说明
设置值setValuestring

通过 $w.id1.setValue("weda") 设置组件值

设置显隐setVisibleboolean显示

通过 $w.id1.setVisible(false) 设置组件为隐藏

设置禁用setDisabledboolean禁用

通过 $w.id1.setDisabled(true) 设置组件为禁用

清空值clearValue

通过 $w.id1.clearValue() 清空组件值

设置只读setReadOnlyboolean只读

通过 $w.id1.setReadOnly(true) 设置组件为只读

触发校验handleValidate

通过 $w.id1.handleValidate() 校验组件值

清除校验clearValidate

通过 $w.id1.clearValidate() 清除组件校验

样式 API

通过样式 API,可以覆盖组件中内部元素的样式来实现自定义,例如在低代码编辑器中中通过 #wd-page-root .wd-btn 即可为所有的按钮组件编写样式,通过 :scope 可以控制单个组件样式, 详细说明请参考样式 API

名称
类名
说明和示例
根元素.wd-textarea-root组件最外层元素
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-textarea-root {
  /* 在这里编写CSS 样式 */
}
H5 端根元素.wd-h5-textarea-root可设定 H5 端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-h5-textarea-root {
  /* 在这里编写CSS 样式 */
}
PC 端根元素.wd-pc-textarea-root可设定 PC 端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-pc-textarea-root {
  /* 在这里编写CSS 样式 */
}
小程序端根元素.wd-mp-textarea-root可设定小程序端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-mp-textarea-root {
  /* 在这里编写CSS 样式 */
}
组件标题样式.wd-textarea-root .wd-form-item-wrap__label组件标题元素

:scope .wd-form-item-wrap__label {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
表单控件根节点样式.wd-textarea-root .wd-form-item-wrap__control设置表单控件根元素样式

:scope .wd-form-item-wrap__control {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
编辑态-输入框样式.wd-textarea-root .wd-form-input-wrap组件边框、边距样式

:scope .wd-form-input-wrap {
  font-size: 20px;
  color: gray;
  text-align: right;
  height: 40px;
  width: 100%;
  background-color: lightgray;
  border-width: 2px;
  border-color: gray;
  border-radius: 0px;
}
编辑态-输入框样式(获取焦点).wd-textarea-root .wd-form-input-wrap.is-focused编辑态-输入框样式(获取焦点)

:scope .wd-form-input-wrap.is-focused {
  background-color: lightgray;
  border-color: gray;
}
编辑态-占位文字样式.wd-textarea-root textarea::placeholder, .wd-textarea-root .weui-input__placeholder设置占位文字样式

    :scope textarea::placeholder, :scope .weui-input__placeholder {
      color: lightgray;
    }
    
编辑态-校验信息.wd-textarea-root .wd-g-text-error设置组件校验信息样式

:scope .wd-g-text-error {
    font-size: 20px;
    color: gray;
  }
提示文字.wd-textarea-root .wd-form-item__help-text设置组件提示文字样式

:scope .wd-form-item__help-text {
    font-size: 20px;
    color: gray;
  }
禁用态-输入框样式.wd-textarea-root .wd-form-input-wrap.is-disabled组件禁用样式

:scope .wd-form-input-wrap.is-disabled {
    font-size: 20px;
    color: gray;
    text-align: right;
    height: 40px;
    width: 200px;
    background-color: lightgray;
    border-width: 2px;
    border-color: gray;
    border-radius: 10px;
  }
只读态-表单值样式.wd-textarea-root .wd-form-item__readonly-value设置组件只读状态

:scope .wd-form-item__readonly-value {
    font-size: 20px;
    color: gray;
  }
字数.wd-textarea__count-text多行输入框字数
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope .wd-textarea__count-text {
  /* 在这里编写CSS 样式 */
}

了解样式 API

版本变化

  • 属性变化
  • 样式变化
  • widget api 变化

常见问题

为什么“光标距键盘距离”绑定变量,更改变量后在 ios 设备上无效?

小程序自身 Bug,该属性只对首次传入的值生效。