Skip to main content

single-line input

WdInput

Applicable Scenarios​

For single-line content input.

Basic Capabilities Description​

  1. Bind text-type fields. After the form container is bound to the data model, text fields in the model are automatically rendered as single-line input components, enabling single-line data entry. Configurable input values, placeholder text, component size, and whether to fill horizontally (component size and whether to fill horizontally take effect on PC but not on mobile).

  2. Supports personalized configuration of titles, including title content, alignment, whether to wrap (when enabled, wraps to the next line if title text exceeds one line; when disabled, truncates with ellipsis if title text exceeds one line), title position, width, and title tooltip.

  1. Supports personalized configuration of input fields, including whether to display a clear button, prefix/suffix text, prefix/suffix icons, hint text below, whether to display as password, input keyboard type, whether to show character count, whether to auto-focus, and whether to display an underline on mobile / whether to display the input box on PC.

Note:

  • Prefix/suffix text in the form will be submitted to the data model along with the input content.
  • Size configuration applies only to the PC end.
  • If the component is within a form container, its size, title alignment, position, line wrapping, and width will inherit the form container's property configuration by default.
  1. Validation rule configuration supports required fields, maximum length, custom validation rules, and validation prompts. Component-supported validation rules include: ID card, bank card, email, numbers, Chinese characters, URL, license plate, Chinese name, English name, username, address, date, digital verification code (4-8 digits), other verification codes (Chinese/English characters with 4+ characters), code, Hong Kong and Macau Travel Permit, Taiwan (China) Travel Permit, passport, amount, mobile number, landline number.

The regular expression validation rules for mobile numbers and landline numbers comply with general telephone protocols.

^(\+\d{1,4}[\s-]?)?(\(?\d{1,4}\)?[\s-]?)?(\d{1,4}[\s-]?)?(\d{1,4})?\d{1,9}(\s?(x|ext)\s?\d{1,6})?$

To validate phone numbers from specific carriers, you can choose the custom rule to configure a regular expression for validation. Example: Chinese mainland mobile number

^1[3-9]\d{9}$

To learn more about usage scenarios for form components, refer to the Form Common Scenarios Practice Guide.

Example​

Interactive Preview​

Component Decoration​

Component Size​

Component Alignment​

Component Password Input​

Component Input State​

Style API Example​

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

Properties​

External properties received by the component

Property Name
Property Identifier
Type
Description
显示标题labelVisibleboolean

Default value: true

标题对齐labelAlignstring

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

标题换行labelWrapboolean

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

标题位置layoutstring

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

标题宽度labelWidthstring

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

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

标题提示labelTipsstring

PC/H5端生效

配置标题的工具提示内容

小程序端获取微信昵称isNickNameTypeboolean

仅小程序端生效

光标距键盘距离cursorSpacingnumber

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

0
显示清空按钮clearableboolean

开启后提供快捷清空按钮

Default value: true

前缀文字beforestring

表单输入框显示前缀文字，表单提交场景下前缀文字会作为表单内容一起提交到数据模型中

后缀文字afterstring

表单输入框显示后缀文字，表单提交场景下后缀文字会作为表单内容一起提交到数据模型中

组件值包含前后缀文字isUnionValueboolean

获取组件值时，该值是否包含前缀和后缀文字内容

Default value: true

前缀图标类型prefixTypestring

选择图标的类型

Example: ""

前缀图标prefixIconstring

表单输入框中展示前图标

Example: "success"

前缀图标prefixSrcstring

设置自定义图标地址

后缀图标类型suffixTypestring

选择图标的类型

Example: ""

后缀图标suffixIconstring

表单输入框中展示后图标

Example: "success"

后缀图标suffixSrcstring

设置自定义图标地址

下方提示extrastring

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

展示为密码passwordboolean

输入内容以密码的形式展示

输入键盘类型typestring

控制移动端输入键盘的展示形式

Default value: "text"

按输入键盘类型转换输入值isConvertboolean

控制是否按输入键盘类型对输入值进行自动转换

Default value: true

显示字数counterVisibleboolean
自动获取焦点focusboolean

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

移动端显示下划线borderedH5boolean

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

Default value: true

PC端显示输入边框borderedPcboolean

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

Default value: true

最大长度maxLengthnumber

Default value: 140

校验规则rulesarray

Default value: []

状态statusstring

Example: "edit"

必填requiredboolean
必填标识requiredFlagboolean

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

Default value: true

必填校验提示requiredMsgstring

Example: "该项为必填项"

绑定字段namestring

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

标题内容labelstring

Example: "标题"

输入值inputValuestring

Example: ""

占位文字placeholderstring

Example: "请输入"

PC端组件尺寸sizestring

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

模板templatestring

输入框样式的预设模版

Example: "inputBox"

Events​

Events exposed by the component. You can listen to component events to trigger external actions

Event Name
Event Code
Event Output Parameters event.detail
Applicable Scenarios
Description
值改变changeobject
  • value: string

    输入值
Compatible with all platforms

用户修改组件值时触发

聚焦focusobject
  • value: string

    输入值
Compatible with all platforms

-

失焦blurobject
  • value: string

    输入值
Compatible with all platforms

-

确认confirmobject
  • value: string

    输入值
Compatible with all platforms

web端键盘输入enter时触发

清除内容clearobject
  • originValue: string

    输入被清除前的值
Compatible with all platforms

-

输入框周围文字/图标点击inputAdornmentClickobject
  • type: string

    [ 'beforeText' | 'afterText' | 'prefix' | 'suffix']分别表示前缀文字，后缀文字，前缀图标，后缀图标
Compatible with all platforms

点击的元素类型，[ 'beforeText' | 'afterText' | 'prefix' | 'suffix']

Property API​

Through the Property API, you can access the internal state and property values of components. You can access internal values using$w.componentId.propertyName, such as $w.input1.value. For details, please refer to Property API

Read-only Property Name
Property Identifier
Type
Description
绑定字段namestring

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

标题内容labelstring
输入值valuestring
前缀文字beforestring

表单输入框显示前缀文字，表单提交场景下前缀文字会作为表单内容一起提交到数据模型中

后缀文字afterstring

表单输入框显示后缀文字，表单提交场景下后缀文字会作为表单内容一起提交到数据模型中

必填requiredboolean
是否展示visibleboolean

组件是否展示

是否禁用disabledboolean

组件是否禁用

是否只读readOnlyboolean

组件是否只读

Method API​

Through the Method API, you can programmatically trigger internal methods of components, such as submitting forms, displaying popups, etc. You can call component methods using $w.componentId.methodName, such as $w.form1.submit()

Method Name
Method Identifier
Parameters
Method Description
设置值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() 清除组件校验

Style API​

Through the Style API, you can override the styles of internal elements in components to achieve customization. For example, in the low-code editor, you can write styles for all button components using #wd-page-root .wd-btn, and control individual component styles with :scope. For detailed instructions, please refer toStyle API

Name
Class Name
Description and Examples
根元素.wd-input-root组件最外层元素
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-input-root {
  /* Write CSS styles here */
}
H5 端根元素.wd-h5-input-root可设定 H5 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-h5-input-root {
  /* Write CSS styles here */
}
PC 端根元素.wd-pc-input-root可设定 PC 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-pc-input-root {
  /* Write CSS styles here */
}
小程序端根元素.wd-mp-input-root可设定小程序端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-mp-input-root {
  /* Write CSS styles here */
}
组件标题样式.wd-input-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-input-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-input-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-input-root .wd-form-input-wrap.is-focused编辑态-输入框样式（获取焦点）

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

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

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

:scope .wd-form-item__help-text {
    font-size: 20px;
    color: gray;
  }
禁用态-输入框样式.wd-input-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-input-root .wd-form-item__readonly-value设置组件只读状态

:scope .wd-form-item__readonly-value {
    font-size: 20px;
    color: gray;
  }
前缀文字样式.wd-input-root .wd-form-input-group__addon-left设置组件前缀文字样式

:scope .wd-form-input-group__addon-left {
    font-size: 20px;
    color: gray;
    height: 40px;
    background-color: lightgray;
  }
/* 仅PC端生效 */
:scope.wd-pc-input-root .wd-form-input-group__addon-left {
    border-width: 2px;
    border-color: gray;
    border-radius: 10px 0 0 10px;
}
后缀文字样式.wd-input-root .wd-form-input-group__addon-right设置组件后缀文字样式

:scope .wd-form-input-group__addon-right {
    font-size: 20px;
    color: gray;
    height: 40px;
    background-color: lightgray;
  }
/* 仅PC端生效 */
:scope.wd-pc-input-root .wd-form-input-group__addon-right {
    border-width: 2px;
    border-color: gray;
    border-radius: 10px 0 0 10px;
}

Learn about Style API

Version Changes​

  • Property changes
  • Style changes
  • widget api changes