Skip to main content
Supported Regions:上海

Single-line input

WdInput

Applicable Scenarios​

For single-line content input.

Basic Capabilities Description​

  1. Bind a "Text" type field. After the form container is bound to the data model, text fields in the model will be automatically rendered as single-line input components, enabling single-line data entry. Configurable options include input value, placeholder text, component size, and whether to horizontally fill the space (component size and whether to horizontally fill the space are effective on PC but not on mobile).

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

Image 1f8c441408179cfb9ab45a9ad2ad3e72
  1. Supports personalized configuration for input fields, including whether to display a clear button, prefix/suffix text, prefix/suffix icons, hint text below, whether to display as password, keyboard type, whether to show character count, whether to automatically gain focus, whether to display underlines on mobile, and whether to display input boxes on PC.
Image 259415191563f6859eacabfa09f61a69

Note:

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

Mobile numbers and landline phones comply with universal phone protocols for regular expression validation rules.

^(\+\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 carrier-specific numbers, you can select custom rules to configure regular expressions for validation. For example: Chinese mainland mobile numbers

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

To learn more about form component usage scenarios, refer to the Form Common Scenario Practice Guide

Example​

Interactive Preview​

Component Styling​

Component Size​

Component Alignment​

Component Password Input​

Component Input Status​

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
Display HeadlineslabelVisibleboolean

Default value: true

Title alignmentlabelAlignstring

In the scenario, the form by default follows the title alignment configuration of the form container.

Line break in headinglabelWrapboolean

If the title content is too long when closed, show one line with overflow omitted; when enabled, show with line breaks. In form scenarios, it follows the form container's title line break configuration by default.

Title positionlayoutstring

Set title display position in form component. In the scenario, it follows the title position configuration of the form container by default.

Title widthlabelWidthstring

You can enter a value with units such as px or %, for example: 200px.

In the scenario, the form follows the title width configuration of the form container by default.

Heading NotelabelTipsstring

Take effect on PC/H5

Configure tooltip content for the heading

WeChat Mini Program nickname retrievalisNickNameTypeboolean

Take effect only in Mini Program

Distance between cursor and keyboardcursorSpacingnumber

Specify the distance between the cursor and the keyboard. Use the smaller of the distance from the textarea to the bottom and the distance specified by cursor-spacing as the distance between the cursor and the keyboard; takes effect only in the mini program.

0
Display clear buttonclearableboolean

Enabled, quick clear button is provided by

Default value: true

Prefix textbeforestring

The input box in the form displays the prefix text. In the form submission scenario, the prefix text is submitted as part of the form content to the data model.

suffix textafterstring

The input box in the form displays suffix text. In the scenario of form submission, the suffix text is submitted as form content to the data model together.

Component value contains prefix and suffix textisUnionValueboolean

Get component value, whether the value contains prefix and suffix text

Default value: true

Prefix icon typeprefixTypestring

Select icon type

Example: ""

Prefix iconprefixIconstring

Show icon before the form input box

Example: "success"

Prefix iconprefixSrcstring

Set custom icon address

suffix icon typesuffixTypestring

Select icon type

Example: ""

suffix iconsuffixIconstring

Show icon in the form input box

Example: "success"

suffix iconsuffixSrcstring

Set custom icon address

Prompt.extrastring

The prompt content is displayed below the input box after configuration.

Show Passwordpasswordboolean

Show input in the form of a password

input keyboard typetypestring

Control the display form of the mobile terminal input keyboard

Default value: "text"

Switch input value by input keyboardisConvertboolean

Control whether to automatically convert input values based on the input keyboard type

Default value: true

Character countcounterVisibleboolean
automatically obtain focusfocusboolean

After enabled, the cursor automatically positions to the input box when page loading completes.

Display underscore on mobile terminalborderedH5boolean

After closing, the mobile terminal does not show the bottom underline

Default value: true

Display input border on PCborderedPcboolean

After closing, do not display input border on PC

Default value: true

Maximum lengthmaxLengthnumber

Default value: 140

Verification rulerulesarray

Default value: []

Status.statusstring

Example: "edit"

Requiredrequiredboolean
Required identifierrequiredFlagboolean

Enabled, the component will display a required asterisk tag if mandatory.

Default value: true

Required validation noterequiredMsgstring

Example: "该项为必填项"

Bound fieldnamestring

The Key value of a form field is used to match the field identifier of the data model when submitting data. It must be unique within the form.

Title content.labelstring

Example: "标题"

input valueinputValuestring

Example: ""

Placeholder textplaceholderstring

Example: "请输入"

PC component dimensionsizestring

Size configuration is only applicable to PC and takes effect by default in form container scenarios.

Templatetemplatestring

Preset template for input box style

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
value changechangeobject
  • value: string

    输入值
Compatible with all platforms

Trigger when a user modifies a component value

focusfocusobject
  • value: string

    输入值
Compatible with all platforms

-

Out of focusblurobject
  • value: string

    输入值
Compatible with all platforms

-

confirmconfirmobject
  • value: string

    输入值
Compatible with all platforms

Trigger on keyboard input of enter in web

Purge contentclearobject
  • originValue: string

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

-

Text/icon click around the input boxinputAdornmentClickobject
  • type: string

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

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

Properties 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
Bound fieldnamestring

The Key value of a form field is used to match the field identifier of the data model when submitting data. It must be unique within the form.

Title content.labelstring
input valuevaluestring
Prefix textbeforestring

The input box in the form displays the prefix text. In the form submission scenario, the prefix text is submitted as part of the form content to the data model.

suffix textafterstring

The input box in the form displays suffix text. In the scenario of form submission, the suffix text is submitted as form content to the data model together.

Requiredrequiredboolean
Indicates whether to displayvisibleboolean

Whether to display the component

Whether to disabledisabledboolean

Component Disabled

Specify whether it is read-only or not.readOnlyboolean

Whether the component is read-only

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
set valuesetValuestring值

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

Show/Hide SettingssetVisibleboolean显示

Set the component to hidden via $w.id1.setVisible(false)

Set DisabledsetDisabledboolean禁用

Set the component to disabled with $w.id1.setDisabled(true)

Clear valueclearValue

Clear the component value with $w.id1.clearValue()

Set as read-onlysetReadOnlyboolean只读

Set the component to read-only via $w.id1.setReadOnly(true)

Trigger validationhandleValidate

Validate the component value via $w.id1.handleValidate()

Clear verificationclearValidate

Clear component validation via $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
root element.wd-input-rootOutermost component element
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-input-root {
  /* Write CSS styles here */
}
H5 root element.wd-h5-input-rootSettable root element style for the H5 side
/* :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-side root element.wd-pc-input-rootSettable root element style for the PC side
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-pc-input-root {
  /* Write CSS styles here */
}
Mini program root element.wd-mp-input-rootSettable root element style for mini program
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-mp-input-root {
  /* Write CSS styles here */
}
Component title style.wd-input-root .wd-form-item-wrap__labelComponent title element

:scope .wd-form-item-wrap__label {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
form control root node style.wd-input-root .wd-form-item-wrap__controlSet form control root element style

:scope .wd-form-item-wrap__control {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
Input box style - editing status.wd-input-root .wd-form-input-wrapComponent border, margin style, background color, font size, font color

: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;
}
Editing status - Input box style (gain focus).wd-input-root .wd-form-input-wrap.is-focusedEditing status - Input box style (gain focus)

:scope .wd-form-input-wrap.is-focused {
  background-color: lightgray;
  border-color: gray;
}
Editing status - Placeholder text style.wd-input-root input::placeholder, .wd-input-root .weui-input__placeholderSet placeholder text style

:scope input::placeholder, :scope .weui-input__placeholder {
  color: lightgray;
}
Editing status - Verification information.wd-input-root .wd-g-text-errorSet component verification information style

:scope .wd-g-text-error {
    font-size: 20px;
    color: gray;
  }
prompt text.wd-input-root .wd-form-item__help-textSet the text style of the component prompt

:scope .wd-form-item__help-text {
    font-size: 20px;
    color: gray;
  }
Disabled state - Input box style.wd-input-root .wd-form-input-wrap.is-disabledComponent disabled style

: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;
  }
read-only status - form value style.wd-input-root .wd-form-item__readonly-valueSet component read-only status

:scope .wd-form-item__readonly-value {
    font-size: 20px;
    color: gray;
  }
Prefix text style.wd-input-root .wd-form-input-group__addon-leftSet component prefix text style

: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;
}
Suffix text style.wd-input-root .wd-form-input-group__addon-rightSet component suffix text style

: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