form

基础库 1.0.0 开始支持,低版本需做兼容处理

表单。将组件内的用户输入的switch input checkbox slider radio picker 提交。

当点击 form 表单中 form-type 为 submit 的 button 组件时,会将表单组件中的 value 值进行提交,需要在表单组件中加上 name 来作为 key。

属性类型默认值必填说明最低版本
report-submitbooleanfalse是否返回 formId 用于发送模板消息1.0.0
report-submit-timeoutnumber0等待一段时间(毫秒数)以确认 formId 是否生效。如果未指定这个参数,formId 有很小的概率是无效的(如遇到网络失败的情况)。指定这个参数将可以检测 formId 是否有效,以这个参数的时间作为这项检测的超时时间。如果失败,将返回 requestFormId:fail 开头的 formId2.6.2
bindsubmiteventhandle携带 form 中的数据触发 submit 事件,event.detail = {value : {‘name’: ‘value’} , formId: ‘’}1.0.0
bindreseteventhandle表单重置时会触发 reset 事件1.0.0

示例代码

// 在开发者工具中预览效果

使用内置 behaviors

对于 form 组件,目前可以自动识别下列内置 behaviors:

wx://form-field

wx://form-field-group

wx://form-field-button

wx://form-field

使自定义组件有类似于表单控件的行为。 form 组件可以识别这些自定义组件,并在 submit 事件中返回组件的字段名及其对应字段值。这将为它添加以下两个属性。

属性名类型描述最低版本
nameString在表单中的字段名1.6.7
value任意在表单中的字段值1.6.7

代码示例: 在开发者工具中预览效果

  1. // custom-form-field.js
  2. Component({
  3. behaviors: ['wx://form-field'],
  4. data: {
  5. value: ''
  6. },
  7. methods: {
  8. onChange: function (e) {
  9. this.setData({
  10. value: e.detail.value,
  11. })
  12. }
  13. }
  14. })

wx://form-field-group

从基础库版本 2.10.2 开始提供支持。

代码示例: 在开发者工具中预览效果

使 form 组件可以识别到这个自定义组件内部的所有表单控件。 例如,页面的结构如下:

  1. <form bindsubmit="submit">
  2. <custom-comp></custom-comp>
  3. <button form-type="submit">submit</button>
  4. </form>

组件 custom-comp 自身结构如下:

  1. <input name="name" />
  2. <switch name="student" />

如果组件 custom-comp 配置有:

  1. Component({
  2. behaviors: ['wx://form-field-group']
  3. })

此时,表单的 submit 事件的 value 中将包含 namestudent 两个字段。

wx://form-field-button

从基础库版本 2.10.3 开始提供支持。

代码示例: 在开发者工具中预览效果

使 form 组件可以识别到这个自定义组件内部的 button , 如果自定义组件内部有设置了 form-type 的 button ,它将被组件外的 form 接受。 例如,页面的结构如下:

  1. <form bindsubmit="submit">
  2. <input name="name" placeholder="请输入名字"></input>
  3. <custom-comp></custom-comp>
  4. </form>

组件 custom-comp 自身结构如下:

  1. <button form-type="submit">submit</button>

如果组件 custom-comp 配置有:

  1. Component({
  2. behaviors: ['wx://form-field-button']
  3. })

此时点击组件内的 button ,将触发 form 的 submit 事件。