feat: update docs.

phonycode · Apr 17, 2019 · d31e5cc · d31e5cc
1 parent fa35008
commit d31e5cc
Show file tree

Hide file tree

Showing 11 changed files with 258 additions and 304 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -19,7 +19,11 @@ module.exports = {
       {
         title: '开发指南',
         collapsable: false,
-        children: [['/quickstart', '快速上手'], ['/CHANGELOG', '更新日志']],
+        children: [
+          ['/quickstart', '快速上手'], 
+          ['/CHANGELOG', '更新日志'],
+          ['/support', '框架支持情况？'],
+        ],
       },
       {
         title: '基础组件',

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,3 +1,38 @@
+## v 2.1.3
+##### 2019-04-10 16:21:00
+
+#### 修复
+
+- 修复了 w-address-picker 没有初始化校验问题
+
+- 修复了 w-date-picker 修复了取值问题.
+
+#### 支持
+
+- w-validate 支持了初始化校验功能，可指定表单组件初始化时是否需要校验，firstValidate默认false
+
+- w-cell-picker 支持了shouldValueUpdate属性，指定该方法来处理何时需要更新值。类似React的shouldComponentUpdated().
+
+
+## v 2.1.3
+##### 2019-03-14 10:12:09
+
+#### 修复
+
+- 修复了 w-swiper-out 修复了当鼠标Y轴移出超过swiper-out组件区域时也自动展开问题。
+
+- 修复了 w-cell-picker 修复了defaultValue和options值不同步问题并处理优化了w-date-picker的处理。
+
+- 修复了 w-card 修复了当slot content的内容高度小于骨架屏的常量高度时，无法显示问题。
+
+- 修复了 w-activity-indicator 带文本时样式位置不对[#]()
+
+#### 重构
+
+- 重构了 w-date-picker 从2.1.3版本开始 w-date-picker 将不使用mode模式来控制时间格式。新版本用户可通过format属性来任意定义时间模板格式。例如： YYYY-MM-DD HH:mm:ss
+
+
+
 ## v 2.1.2
 ##### 2019-02-25 09:33:00
 

diff --git a/docs/component_mds/card.md b/docs/component_mds/card.md
@@ -137,7 +137,11 @@ handleChange(e) {
 #### Slot 插槽
 
 | 名称 | 说明 |
-| ---- | ---- |
+| content | 内容区信息 |
+| footer | 底部标题 |
+| footer-extra | 底部副标题 |
+| title | 头部标题 |
+| extra | 头部副标题 |
 
 
 #### Class 自定义类名

diff --git a/docs/component_mds/cell-picker.md b/docs/component_mds/cell-picker.md
@@ -10,18 +10,16 @@
 }
 ```
 
+### 视频演示
+
+<video style="margin: 20px 0;" height="450px" autoplay="true" loop="true" controls x5-playsinline="true" playsinline="true" webkit-playsinline="true" src="../../resource/cell-picker.mp4"
+/>
+
+
 ### 代码演示
 
 ```html
-w-cell-group>
 <w-cell-group>
-	<w-cell-picker
-	 label="多选联动模式"
-	 options="{{ options1 }}"
-	 title="请选择地区"
-	 defaultValue="{{[1,1,5]}}"
-   bind:onSelect="handleSelect"
-	/>
   <w-cell-picker
 	 label="单选模式"
 	 title="请选择性别"
@@ -48,219 +46,6 @@ w-cell-group>
 
 ```javascript
 data: {
-  options1: [
-    [{
-        key: '北京市',
-        value: '110000',
-      },
-      {
-        key: '广东省',
-        value: '440000',
-      },
-    ],
-    [{
-        key: '市辖区',
-        value: '110100',
-        parent: '110000',
-      },
-      {
-        key: '广州市',
-        value: '440100',
-        parent: '440000',
-      },
-      {
-        key: '韶关市',
-        value: '440200',
-        parent: '440000',
-      },
-    ],
-    [{
-        key: '东城区',
-        value: '110101',
-        parent: '110100',
-      },
-      {
-        key: '西城区',
-        value: '110102',
-        parent: '110100',
-      },
-      {
-        key: '朝阳区',
-        value: '110105',
-        parent: '110100',
-      },
-      {
-        key: '丰台区',
-        value: '110106',
-        parent: '110100',
-      },
-      {
-        key: '石景山区',
-        value: '110107',
-        parent: '110100',
-      },
-      {
-        key: '海淀区',
-        value: '110108',
-        parent: '110100',
-      },
-      {
-        key: '门头沟区',
-        value: '110109',
-        parent: '110100',
-      },
-      {
-        key: '房山区',
-        value: '110111',
-        parent: '110100',
-      },
-      {
-        key: '通州区',
-        value: '110112',
-        parent: '110100',
-      },
-      {
-        key: '顺义区',
-        value: '110113',
-        parent: '110100',
-      },
-      {
-        key: '昌平区',
-        value: '110114',
-        parent: '110100',
-      },
-      {
-        key: '大兴区',
-        value: '110115',
-        parent: '110100',
-      },
-      {
-        key: '怀柔区',
-        value: '110116',
-        parent: '110100',
-      },
-      {
-        key: '平谷区',
-        value: '110117',
-        parent: '110100',
-      },
-      {
-        key: '密云区',
-        value: '110118',
-        parent: '110100',
-      },
-      {
-        key: '延庆区',
-        value: '110119',
-        parent: '110100',
-      },
-      {
-        key: '荔湾区',
-        value: '440103',
-        parent: '440100',
-      },
-      {
-        key: '越秀区',
-        value: '440104',
-        parent: '440100',
-      },
-      {
-        key: '海珠区',
-        value: '440105',
-        parent: '440100',
-      },
-      {
-        key: '天河区',
-        value: '440106',
-        parent: '440100',
-      },
-      {
-        key: '白云区',
-        value: '440111',
-        parent: '440100',
-      },
-      {
-        key: '黄埔区',
-        value: '440112',
-        parent: '440100',
-      },
-      {
-        key: '番禺区',
-        value: '440113',
-        parent: '440100',
-      },
-      {
-        key: '花都区',
-        value: '440114',
-        parent: '440100',
-      },
-      {
-        key: '南沙区',
-        value: '440115',
-        parent: '440100',
-      },
-      {
-        key: '从化区',
-        value: '440117',
-        parent: '440100',
-      },
-      {
-        key: '增城区',
-        value: '440118',
-        parent: '440100',
-      },
-      {
-        key: '武江区',
-        value: '440203',
-        parent: '440200',
-      },
-      {
-        key: '浈江区',
-        value: '440204',
-        parent: '440200',
-      },
-      {
-        key: '曲江区',
-        value: '440205',
-        parent: '440200',
-      },
-      {
-        key: '始兴县',
-        value: '440222',
-        parent: '440200',
-      },
-      {
-        key: '仁化县',
-        value: '440224',
-        parent: '440200',
-      },
-      {
-        key: '翁源县',
-        value: '440229',
-        parent: '440200',
-      },
-      {
-        key: '乳源瑶族自治县',
-        value: '440232',
-        parent: '440200',
-      },
-      {
-        key: '新丰县',
-        value: '440233',
-        parent: '440200',
-      },
-      {
-        key: '乐昌市',
-        value: '440281',
-        parent: '440200',
-      },
-      {
-        key: '南雄市',
-        value: '440282',
-        parent: '440200',
-      },
-    ],
-  ],
   options2: ['男', '女'],
   options4: [{ key: '30天', value: 30 },{ key: '60天', value: 60 },{ key: '90天', value: 90 },{ key: '1年', value: 365 },{ key: '10年', value: 3650 },],
   options3: [
@@ -314,7 +99,9 @@ data: {
 
 | 属性         | 说明 |  类型   | 默认值 |
 | ------------ | :--: | :-----: | -----: |
-| options      |  传入的选项组[ [], [], [] ]    | Array | [] |
+| options      |  传入的选项值,当值为[[],[],[]]格式时为联动模式,传入格式为[{},{},{}]为单例模式  | Array | [] |
+| options.key   |  options里的对象属性key表示键值,显示在picker上的值  | String | - |
+| options.value |  options里的对象属性value表示值,会返回给最终结果  | String | - |
 | defaultValue      |  默认值 可以支持 key value  | Array | [] |
 | cancelTextColor      |  取消文本颜色    | String | - |
 | cancelText      |  取消文本文字    | String | '取消' |
@@ -323,6 +110,7 @@ data: {
 | confirmText      |  确认文本文字    | String | '确认' |
 | showValue      |  是否用value而不是key展示    | Boolean | false |
 | defaultKey      |  onChange和onSelect事件返回的值是何种格式 [value,value...] [key,key,...]    | String | 'value' |
+| shouldValueUpdate      |  指定该方法来处理何时需要更新值。类似React的shouldComponentUpdated()    | Function | ():boolean => true |
 
 #### Event 事件
 

diff --git a/docs/component_mds/countdown.md b/docs/component_mds/countdown.md
@@ -57,6 +57,7 @@
 
 | 事件名 | 说明 | 参数 |
 | ------ | ---- | ---- |
+| callback | 倒计时结束回调 | ---- |
 
 
 #### Slot 插槽