Browse Source

更新组件描述

Frans 7 years ago
parent
commit
0a7617719b

+ 0 - 2
docs/cases.md

@@ -1,2 +0,0 @@
-# 使用案例
-

+ 1 - 1
sites/demo/app.vue

@@ -38,7 +38,7 @@ body{
     font-size:16px;
     margin: 0;
     color:#2e2d2d;
-    font-family: PingHei,Lucida Grande,Lucida Sans Unicode,STHeiti,Helvetica,Arial,Verdana,"sans-serif","PingHei-light",SimHei,"Droid Sans";  
+    font-family: PingHei,"Microsoft YaHei","Lucida Grande","Lucida Sans Unicode",STHeiti,Helvetica,Arial,Verdana,"sans-serif","PingHei-light",SimHei,"Droid Sans";  
 }
 .demo-wrapper{
   width:100%;

File diff suppressed because it is too large
+ 5 - 1
sites/doc/app.vue


+ 14 - 13
sites/doc/asset/css/common.scss

@@ -139,30 +139,31 @@ pre {
     position: relative;
     max-width: 100%;
     overflow: auto;
-    i {
+    &>i {
         cursor: pointer;
         position: absolute;
+        top:10px;
+        width:16px;
+        height:16px;
+        background-repeat: no-repeat;
+        background-size:cover;
+        opacity: .8;
+        &:hover{
+            opacity: 1;
+        }
     }
     [toast="toast"] {
-        top: 10px;
         right: 10px;
-        width: 28px;
-        height: 28px;
-        background: url(./i/all.png) no-repeat center;
-        border-radius: 4px;
+        background-image: url(./i/all.png);
         &:hover {
-            background: #D5E5FF url(./i/all.png) no-repeat center;
+            background-color: #D5E5FF;
         }
     }
     [copy="copy"] {
-        top: 10px;
         right: 40px;
-        width: 28px;
-        height: 28px;
-        background: url(./i/cp.png) no-repeat center;
-        border-radius: 4px;
+        background-image: url(./i/cp.png);
         &:hover {
-            background: #D5E5FF url(./i/cp.png) no-repeat center;
+            background-color: #D5E5FF;
         }
     }
 }

File diff suppressed because it is too large
+ 4 - 1
sites/doc/index.vue


File diff suppressed because it is too large
+ 1 - 0
src/assets/svg/github.svg


+ 15 - 15
src/config.json

@@ -26,7 +26,7 @@
       "chnName": "对话框",
       "type": "method",
       "showDemo": true,
-      "desc": "一种对话框,支持遮罩层,支持按钮交互",
+      "desc": "模态弹窗,支持按钮交互,支持图片弹窗。",
       "author": "Frans"
     },
     {
@@ -44,7 +44,7 @@
       "name": "Toast",
       "sort": "2",
       "chnName": "吐司",
-      "desc": "轻提示组件",
+      "desc": "轻提示",
       "type": "method",
       "showDemo": true,
       "author": "Frans"
@@ -54,7 +54,7 @@
       "name": "ActionSheet",
       "sort": "2",
       "chnName": "动作面板",
-      "desc": "底部弹出动作面板",
+      "desc": "底部弹出动作菜单面板",
       "type": "component",
       "showDemo": true,
       "author": "iris"
@@ -64,7 +64,7 @@
       "name": "Tab",
       "sort": "3",
       "chnName": "选项卡",
-      "desc": "标签栏 选项卡组件",
+      "desc": "常用于平级区域大块内容的的收纳和展现。",
       "type": "component",
       "showDemo": true,
       "author": "甄玉磊"
@@ -134,7 +134,7 @@
       "name": "Slider",
       "sort": "1",
       "chnName": "滑块",
-      "desc": "滑动取值控件",
+      "desc": "滑动输入器,用于在数值区间/自定义区间内进行选择。",
       "type": "component",
       "showDemo": true,
       "author": "Frans"
@@ -153,8 +153,8 @@
       "version": "1.0.0",
       "name": "Picker",
       "sort": "1",
-      "chnName": "选择面板",
-      "desc": "选择面板",
+      "chnName": "拾取器",
+      "desc": "提供多个选项集合供用户选择其中一项。",
       "type": "component",
       "showDemo": true,
       "author": "iris"
@@ -164,7 +164,7 @@
       "name": "Progress",
       "sort": "2",
       "chnName": "进度条",
-      "desc": "实时显示当前任务的处理进度的组件度",
+      "desc": "展示操作或任务的当前进度,比如上传文件。",
       "type": "component",
       "showDemo": true,
       "author": "张毓飞"
@@ -214,7 +214,7 @@
       "name": "Steps",
       "sort": "0",
       "chnName": "步骤条",
-      "desc": "分步骤展示进度",
+      "desc": "拆分展示某项流程的步骤,引导用户按流程完成任务或向用户展示当前状态。",
       "type": "component",
       "showDemo": true,
       "author": "宋其斌"
@@ -234,7 +234,7 @@
       "name": "Badge",
       "sort": "0",
       "chnName": "徽标",
-      "desc": "提供按钮右上角的标志",
+      "desc": "出现在图标或文字右上角的红色圆点、数字或者文字,表示有新内容或者待处理的信息",
       "type": "component",
       "showDemo": true,
       "author": "杨磊"
@@ -244,7 +244,7 @@
       "name": "Rating",
       "sort": "1",
       "chnName": "评分",
-      "desc": "Vue评分组件",
+      "desc": "用于快速的评级操作,或对评价进行展示。",
       "type": "component",
       "showDemo": true,
       "author": "永无止晋"
@@ -254,7 +254,7 @@
       "name": "Swiper",
       "chnName": "滑动切换",
       "sort": "0",
-      "desc": "Vue滑动组件",
+      "desc": "常用于一组图片或卡片轮播,当内容空间不足时,可以用走马灯的形式进行收纳,进行轮播展现。",
       "type": "component",
       "showDemo": true,
       "author": "wangnan31"
@@ -273,7 +273,7 @@
       "version": "1.0.0",
       "name": "Stepper",
       "chnName": "步进器",
-      "desc": "步进器",
+      "desc": "通过点击按钮控制数字加减",
       "type": "component",
       "sort": "1",
       "showDemo": true,
@@ -316,7 +316,7 @@
       "chnName": "开关",
       "type": "component",
       "showDemo": true,
-      "desc": "一种滑动开关,通过点击使按钮左右滑动,同时触发对应的开关状态",
+      "desc": "滑动开关,通过点击使按钮左右滑动,同时触发对应的开关状态",
       "author": "Frans"
     },
     {
@@ -374,7 +374,7 @@
       "version":"1.0.0",
       "name":"Skeleton",
       "chnName":"骨架屏",
-      "des":"骨架屏",
+      "des":"在页面上待加载区域填充灰色的占位图,本质上是界面加载过程中的过渡效果",
       "type":"component",
       "sort":"0",
       "showDemo": true,

+ 3 - 1
src/packages/actionsheet/doc.md

@@ -1,5 +1,7 @@
 # ActionSheet 动作面板
 
+从底部弹出的动作菜单面板。
+
 ## 基本用法
 ```html
 <nut-actionsheet :is-visible="isVisible" 
@@ -151,7 +153,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 3 - 1
src/packages/badge/doc.md

@@ -1,5 +1,7 @@
 # Badge 徽标
 
+出现在图标或文字右上角的红色圆点、数字或者文字,表示有新内容或者待处理的信息。
+
 ## 基本用法
 
 ```html
@@ -128,7 +130,7 @@
 ```
 
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/button/doc.md

@@ -239,7 +239,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/buttongroup/doc.md

@@ -84,7 +84,7 @@
 </nut-button-group>
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/calendar/doc.md

@@ -95,7 +95,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/cell/doc.md

@@ -34,7 +34,7 @@
 </nut-cell>
 ```
 
-### API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/checkbox/doc.md

@@ -161,7 +161,7 @@ methods: {
 </nut-checkbox>
 ```
 
-## API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/checkboxgroup/doc.md

@@ -201,7 +201,7 @@ methods: {
 </nut-checkboxgroup>
 ```
 
-## API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/datepicker/doc.md

@@ -140,7 +140,7 @@ export default {
 }
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 2 - 0
src/packages/dialog/doc.md

@@ -1,5 +1,7 @@
 # Dialog 对话框
 
+模态对话框,在浮层中显示,引导用户进行相关操作,支持图片对话框。
+
 ## 基本用法
 
 ```javascript

+ 1 - 1
src/packages/flex/doc.md

@@ -199,7 +199,7 @@
 
 ```
 
-## Props
+## Prop
 
 ### row
 

+ 1 - 1
src/packages/icon/doc.md

@@ -47,7 +47,7 @@
 * circle-cross
 
 
-## API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/imagepicker/doc.md

@@ -92,7 +92,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | -----

+ 1 - 1
src/packages/menu/doc.md

@@ -381,7 +381,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | -----

+ 1 - 1
src/packages/navbar/doc.md

@@ -112,7 +112,7 @@ export default {
 ```
 
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 1 - 1
src/packages/noticebar/doc.md

@@ -35,7 +35,7 @@
 
 
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 4 - 2
src/packages/picker/doc.md

@@ -1,4 +1,6 @@
-# Picker 选择面板
+# Picker 拾取器
+
+提供多个选项集合供用户选择其中一项。
 
 ## 基本用法
 
@@ -141,7 +143,7 @@ export default {
 };
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 2 - 2
src/packages/price/doc.md

@@ -1,6 +1,6 @@
 # Price 商品价格
 
-用来对商品价格数值的小数点前后部分应用不同样式,还支持人民币符号、千位分隔符、设置小数点位数等功能
+用来对商品价格数值的小数点前后部分应用不同样式,还支持人民币符号、千位分隔符、设置小数点位数等功能
 
 ## 基本用法
 
@@ -33,7 +33,7 @@
 />
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 3 - 1
src/packages/progress/doc.md

@@ -1,5 +1,7 @@
 # Progress 进度条
 
+展示操作或任务的当前进度,比如上传文件。
+
 ## 基本用法
 
 ```html
@@ -78,7 +80,7 @@
 ```
 
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | -----

+ 1 - 1
src/packages/radio/doc.md

@@ -148,7 +148,7 @@ RadioGroup整体禁用
 ```
 **RadioGroup** 也支持新增自定义class
 
-## Props
+## Prop
 
 ### Radio
 

+ 1 - 1
src/packages/range/doc.md

@@ -33,7 +33,7 @@
 </nut-range>
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 | ----- | ----- | ----- | -----

+ 3 - 1
src/packages/rating/doc.md

@@ -1,5 +1,7 @@
 # Rating 评分
 
+用于快速的评级操作,或对评价进行展示。
+
 ## 基础用法
 
 ```html
@@ -34,7 +36,7 @@
 ></nut-rating>
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 | ----- | ----- | ----- | -----

+ 1 - 1
src/packages/searchbar/doc.md

@@ -68,7 +68,7 @@ export default {
 }
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | -----

+ 1 - 1
src/packages/shortpassword/doc.md

@@ -53,7 +53,7 @@ export default {
 ```
 
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | -----

+ 3 - 1
src/packages/skeleton/doc.md

@@ -1,5 +1,7 @@
 # Skeleton 骨架屏
 
+在页面上待加载区域填充灰色的占位图,本质上是界面加载过程中的过渡效果。
+
 ## 长方形
 
 ```html
@@ -54,7 +56,7 @@
 </column>
 ```
 
-## Props
+## Prop
 
 layout(row|column)
 

+ 3 - 1
src/packages/slider/doc.md

@@ -1,5 +1,7 @@
 # Slider 滑块
 
+滑动输入器,用于在数值区间/自定义区间内进行选择。
+
 ## 基本用法
 
 ```html
@@ -69,7 +71,7 @@
 </nut-slider>
 ```
 
-## API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 4 - 2
src/packages/stepper/doc.md

@@ -1,4 +1,6 @@
-# Stepper 加减按钮
+# Stepper 步进器
+
+通过点击按钮控制数字增减。
 
 ## 默认用法
 
@@ -52,7 +54,7 @@
 ></nut-stepper>
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值 
 | ----- | ----- | ----- | ----- 

+ 3 - 1
src/packages/steps/doc.md

@@ -1,5 +1,7 @@
 # Steps 步骤条
 
+拆分展示某项流程的步骤,引导用户按流程完成任务或向用户展示当前状态。
+
 ## 基本用法
 
 正常流程
@@ -72,7 +74,7 @@
 ```
 
 
-## Props
+## Prop
 
 ### nut-steps
 

+ 3 - 1
src/packages/swiper/doc.md

@@ -1,5 +1,7 @@
 # swiper 滑动切换
 
+常用于一组图片或卡片轮播,当内容空间不足时,可以用走马灯的形式进行收纳,进行轮播展现。
+
 ## 基本用法
 
 横向无缝切换
@@ -148,7 +150,7 @@
 
 ```
 
-## Props
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 3 - 1
src/packages/switch/doc.md

@@ -1,5 +1,7 @@
 # Switch 滑动开关
 
+用来打开或关闭选项。
+
 ## 基本用法
 
 ```html
@@ -80,7 +82,7 @@ export default {
 ```
 
 
-## API
+## Prop
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 

+ 3 - 1
src/packages/tab/doc.md

@@ -1,5 +1,7 @@
 # Tab 选项卡
 
+常用于平级区域大块内容的的收纳和展现。
+
 ## 基本用法
 
 ```html
@@ -129,7 +131,7 @@ export default {
 ```
 
 
-### 表格
+### Prop
 
 ### nut-tab
 

+ 1 - 1
src/packages/tabbar/doc.md

@@ -151,7 +151,7 @@ export default {
 ```
 
 
-### 表格
+### Prop
 
 ### nut-tabbar
 

+ 2 - 0
src/packages/toast/doc.md

@@ -1,5 +1,7 @@
 # Toast 吐司
 
+轻提示。
+
 ## 基本用法
 
 ```javascript

+ 2 - 2
src/styles/variable.scss

@@ -11,8 +11,8 @@ $dark-color: #DADADA !default;
 $body-background: #F6F6F6 !default;
 $mask-bg: rgba(0, 0, 0, 0.5) !default;
 $font-family: PingHei,
-Lucida Grande,
-Lucida Sans Unicode,
+"Lucida Grande",
+"Lucida Sans Unicode",
 STHeiti,
 Helvetica,
 Arial,