表单,将组件内的用户输入的<switch> <input> <checkbox> <slider> <radio> <picker> 提交。
当点击 <form> 表单中 formType 为 submit 的 <button> 组件时,会将表单组件中的 value 值进行提交,需要在表单组件中加上 name 来作为 key。
属性说明
| 属性名 | 类型 | 说明 | 平台差异说明 |
|---|---|---|---|
| report-submit | Boolean | 是否返回 formId 用于发送模板消息 | 微信小程序、支付宝小程序 |
| report-submit-timeout | number | 等待一段时间(毫秒数)以确认 formId 是否生效。如果未指定这个参数,formId 有很小的概率是无效的(如遇到网络失败的情况)。指定这个参数将可以检测 formId 是否有效,以这个参数的时间作为这项检测的超时时间。如果失败,将返回 requestFormId:fail 开头的 formId | 微信小程序2.6.2 |
| @submit | EventHandle | 携带 form 中的数据触发 submit 事件,event.detail = {value : {‘name’: ‘value’} , formId: ‘’},report-submit 为 true 时才会返回 formId | |
| @reset | EventHandle | 表单重置时会触发 reset 事件 |
示例
查看演示
以下示例代码,来自于hello uni-app项目,推荐使用HBuilderX,新建uni-app项目,选择hello uni-app模板,可直接体验完整示例。
<!-- 本示例未包含完整css,获取外链css请参考上文,在hello uni-app项目中查看 --><template><view><view><form @submit="formSubmit" @reset="formReset"><view class="uni-form-item uni-column"><view class="title">switch</view><view><switch name="switch" /></view></view><view class="uni-form-item uni-column"><view class="title">radio</view><radio-group name="radio"><label><radio value="radio1" /><text>选项一</text></label><label><radio value="radio2" /><text>选项二</text></label></radio-group></view><view class="uni-form-item uni-column"><view class="title">checkbox</view><checkbox-group name="checkbox"><label><checkbox value="checkbox1" /><text>选项一</text></label><label><checkbox value="checkbox2" /><text>选项二</text></label></checkbox-group></view><view class="uni-form-item uni-column"><view class="title">slider</view><slider value="50" name="slider" show-value></slider></view><view class="uni-form-item uni-column"><view class="title">input</view><input class="uni-input" name="input" placeholder="这是一个输入框" /></view><view class="uni-btn-v"><button form-type="submit">Submit</button><button type="default" form-type="reset">Reset</button></view></form></view></view></template><script>export default {data() {return {}},methods: {formSubmit: function(e) {console.log('form发生了submit事件,携带数据为:' + JSON.stringify(e.detail.value))var formdata = e.detail.valueuni.showModal({content: '表单数据内容:' + JSON.stringify(formdata),showCancel: false});},formReset: function(e) {console.log('清空数据')}}}</script><style>.uni-form-item .title {padding: 20rpx 0;}</style>
Tips
- 为方便做表单验证,uni ui提供了**
<uni-forms>**组件,参考:https://ext.dcloud.net.cn/plugin?id=2773 - 如果使用uniCloud,其数据库提供了
DB Schema,在schema中配置字段的格式,前端表单校验和服务器入参校验将可以复用该规则,无需在两端重复开发。详见 - 有很多表单自助生成辅助工具
对于 form 组件,目前可以自动识别下列内置 behaviors:
uni://form-field
目前仅支持 微信小程序、QQ小程序、百度小程序、h5。
uni://form-field
使自定义组件有类似于表单控件的行为。
form 组件可以识别这些自定义组件,
并在 submit 事件中返回组件的字段名及其对应字段值。
这将为它添加以下两个属性。
| 属性名 | 类型 | 描述 |
|---|---|---|
| name | String | 在表单中的字段名 |
| value | 任意 | 在表单中的字段值 |
示例如下:
<!-- /pages/index/index.vue --><template><view class="content"><form @submit="onSubmit"><comp-input name="test" v-model="testValue"></comp-input><button form-type="submit">Submit</button></form></view></template><script>export default {data() {return {testValue: 'Hello'}},methods: {onSubmit(e) {console.log(e)}}}</script><style></style>
<!-- /components/compInput/compInput.vue --><template><view><input name="test" style="border: solid 1px #999999;height: 80px;" type="text" @input="onInput" :value="value" /></view></template><script>export default {name: 'compInput',behaviors: ['uni://form-field'],methods: {onInput(e) {this.$emit('input', e.detail.value)}}}</script><style></style>
