doc: 更新文档

jd-opensource · Mar 29, 2019 · f0249d8 · f0249d8
1 parent 05a60b8
commit f0249d8
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 10 deletions.
diff --git a/docs/start.md b/docs/start.md
@@ -93,6 +93,13 @@ NutUI.install(Vue);
 
 > 注意：这种方式将会导入所有组件
 
+> 服务端渲染请引入NutUI的 **commonjs** 版本 **nutui.common.js**
+
+```javascript
+//服务端渲染使用NutUI的commonjs版本
+import NutUI from '@nutui/nutui/dist/nutui.common.js';
+```
+
 ## 按需加载
 
 以下两种方式都可以实现只加载用到的组件，从而减少加载的文件体积。

diff --git a/sites/demo/view/index.vue b/sites/demo/view/index.vue
@@ -22,7 +22,7 @@
         </template>
       </ul>
     </div>
-    <div id="demo-footer">京东用户体验设计部（JDC） · 前端开发部</div>
+    <div id="demo-footer" @click="showCode">京东用户体验设计部（JDC） · 前端开发部</div>
   </div>
 </template>
 
@@ -41,6 +41,16 @@ export default {
     };
   },
   methods: {
+    showCode(){
+        this.$dialog({
+          type:"image",
+          link:"",
+          imgSrc:"https://img14.360buyimg.com/imagetools/s350x350_jfs/t1/23439/7/11643/155926/5c90d554E7f03c831/bd45cd0ee2daa2fa.jpg.dpg",
+          onClickImageLink(){
+            return false;  //返回false可阻止默认的链接跳转行为
+          }
+        });
+    },
     toggleFold(idx) {
       this.foldStatus.splice(idx, 1, !this.foldStatus[idx]);
       sessionStorage.setItem("foldStatus", JSON.stringify(this.foldStatus));

diff --git a/sites/doc/asset/css/common.scss b/sites/doc/asset/css/common.scss
@@ -136,7 +136,7 @@ pre {
     position: relative;
     max-width: 100%;
     overflow: auto;
-    margin .code-wrapper {
+    .code-wrapper {
         width: 100%;
         overflow: auto;
     }

diff --git a/sites/doc/asset/js/bookmark.js b/sites/doc/asset/js/bookmark.js
@@ -10,7 +10,6 @@ import root from '../root.js';
                 let id  = res.target.id;
                 let index =id.replace(/head/,'');                
                 let li = document.querySelector('.level'+index);
-                console.log(li,index)
                 if(li){
 
                 }

diff --git a/sites/doc/info.vue b/sites/doc/info.vue
@@ -228,6 +228,7 @@ dd {
     }
   }
   .l-c-i {
+    cursor: pointer;
     position: relative;
     span {
       padding: 0 0 0 35px;

diff --git a/src/config.json b/src/config.json
@@ -397,7 +397,8 @@
       "chnName": "滚动",
       "desc": "滚动组件",
       "type": "component",
-      "sort": "1",
+      "sort": "0",
+      "star": 5,
       "showDemo": true,
       "author": "iris"
     },
@@ -427,7 +428,8 @@
       "chnName": "无限加载",
       "desc": "无限加载",
       "type": "component",
-      "sort": "1",
+      "sort": "0",
+      "star": 4,
       "showDemo": true,
       "author": "iris"
     }

diff --git a/src/packages/infiniteloading/doc.md b/src/packages/infiniteloading/doc.md
@@ -4,9 +4,19 @@
 ## 基本用法
 
 ```html
-<nut-infiniteloading @loadmore="onInfinite" :is-show-mod="true" :has-more="isHasMore" :is-loading="isLoading" :threshold="200">
+<nut-infiniteloading 
+    @loadmore="onInfinite" 
+    :is-show-mod="true" 
+    :has-more="isHasMore" 
+    :is-loading="isLoading" 
+    :threshold="200"
+>
     <ul class="list" >
-        <li class="list-item" v-for="(item, index) of data" :key="item">我是测试数据{{index + 1}}</li>
+        <li 
+            class="list-item" 
+            v-for="(item, index) of data" 
+            :key="item"
+        >我是测试数据{{index + 1}}</li>
     </ul>
 </nut-infiniteloading>
 ```

diff --git a/src/packages/scroller/doc.md b/src/packages/scroller/doc.md
@@ -45,7 +45,7 @@
     <div slot="list" class="nut-vert-list-panel">
         <div class="nut-vert-list-item" v-for="(item, index) of listData1" :key="index">
             <dl class="nut-scroller-item-info">
-                <dt>{{index}}防水升级版 蓝牙音箱 低音炮 IPX7设计 户外便携音响 迷你小音</dt>
+                <dt>防水升级版 蓝牙音箱 低音炮 IPX7设计 户外便携音响 迷你小音</dt>
                 <dd>2018-02-25</dd>
             </dl>
         </div>
@@ -66,7 +66,7 @@
     <div slot="list" class="nut-vert-list-panel">
         <div class="nut-vert-list-item" v-for="(item, index) of listData2" :key="index">
             <dl class="nut-scroller-item-info">
-                <dt>{{index}}防水升级版 蓝牙音箱 低音炮 IPX7设计 户外便携音响 迷你小音</dt>
+                <dt>防水升级版 蓝牙音箱 低音炮 IPX7设计 户外便携音响 迷你小音</dt>
                 <dd>2018-02-25</dd>
             </dl>
         </div>

diff --git a/src/packages/swiper/doc.md b/src/packages/swiper/doc.md
@@ -170,7 +170,7 @@
 | next | 去下一页 | -
 | prev | 去上一页 | -
 | setPage |  设置当前显示第几页 | number
-| updateEvent | 异步数据渲染slide，都需要重新调用方法，绑定事件，如【横向无缝滑动】this.$ref.demo1.update(1)。也提供设置初始页面 | number
+| updateEvent | 异步数据渲染slide，都需要重新调用方法，绑定事件，如【横向无缝滑动】this.$refs.demo1.update(1)。也提供设置初始页面 | number
 
 ## Events
 | 字段 | 说明 | 回调参数