Yao 2d23fbf888
[improvement] Doc: 增加 Field 组件文档 (#73)
* add field readme

* update readme

* 补充说明

* pr 模板增加 improvement 类型
2017-12-07 23:52:58 +08:00

2.0 KiB
Raw Blame History

Field 输入框

使用指南

在 app.wxss 中引入组件库所有样式

@import "path/to/zanui-weapp/dist/index.wxss";

在需要使用的页面里引入组件库模板和脚本

<import src="path/to/zanui-weapp/dist/field/index.wxml" />

<!-- 直接使用 zan-field 模板,并且直接传入设置值 -->
<template is="zan-field" data="{{ value }}"></template>
const Field = require('path/to/zanui-weapp/dist/field/index');

// 在 Page 中混入 Field 里面声明的方法
Page(Object.assign({}, Field, {
  // ...
}));

代码演示

field 支持多种展示方式,在 data 中传入对应的设置即可。

<template is="zan-field" data="{{ title: '收货人', type: 'input', placeholder: '名字', value }}"></template>

当 field 触发输入事件时,可以在页面中注册 handleZanFieldChange 方法来监听

Page(Object.assign({}, Field, {
  handleZanFieldChange({ componentId, detail }) {
    /*
     * componentId 即为在模板中传入的 componentId
     * 用于在一个页面上使用多个 tab 时,进行区分
     * detail 即输入框中的内容
     */
    /*
     * 处理函数可以直接 return 一个字符串,将替换输入框的内容。
     */
  }
}));

Field 支持传入参数如下

参数 说明 类型 默认值 必须
title 输入框左侧标题,若传入为空,则不显示标题 String -
value 输入框的内容 String -
type 输入框的类型,可选值为 input, textarea String input
inputType 输入框为 input 情况下输入框的类型例如number, text, password String text
placeholder 输入框为空时占位符 String
mode 输入框展示样式,可选值为 wrapped, normal String normal
right 输入框内容是否居右显示 Boolean false
error 是否显示为输入框错误情况下的样式 Boolean false