Browse Source

docs: 更新了 tab 的文档 (#666)

* fix: 更新tab文档
zhenyulei 4 years ago
parent
commit
33a562e52d
1 changed files with 13 additions and 9 deletions
  1. 13 9
      src/packages/__VUE/tab/doc.md

+ 13 - 9
src/packages/__VUE/tab/doc.md

@@ -2,24 +2,22 @@
 
 常用于平级区域大块内容的的收纳和展现,支持内嵌标签形式和渲染循环数据形式。
 
-> 注意,由于小程序端依赖的swiper组件存在兼容性问题,因此在小程序端暂时只支持基础的tab切换功能,待swiper组件修复后,开放所有功能。
+> 注意,由于小程序端依赖的 swiper 组件存在兼容性问题,因此在小程序端暂时只支持基础的 tab 切换功能,待 swiper 组件修复后,开放所有功能。
 
 ## 安装
 
 ```js
 import { createApp } from 'vue';
 // vue
-import { Tab, TabPanel,Swiper,SwiperItem } from '@nutui/nutui';
+import { Tab, TabPanel, Swiper, SwiperItem } from '@nutui/nutui';
 // taro
-import { Tab, TabPanel,Swiper,SwiperItem } from '@nutui/nutui-taro';
+import { Tab, TabPanel, Swiper, SwiperItem } from '@nutui/nutui-taro';
 
 const app = createApp();
 app.use(Tab);
 app.use(TabPanel);
 app.use(Swiper);
 app.use(SwiperItem);
-
-
 ```
 
 ## 基础样式,默认 tab-title 宽度均分相等
@@ -71,7 +69,7 @@ switchTab 监听切换 tab 返回事件
         switchTab
       };
     }
-  }
+  };
 </script>
 ```
 
@@ -169,7 +167,13 @@ switchTab 监听切换 tab 返回事件
 ## 左右 tab 布局
 
 ```html
-<nut-tab direction="vertical" :animatedTime="500" :defaultIndex="2">
+<nut-tab
+  direction="vertical"
+  :animated-time="500"
+  :default-index="2"
+  scrollType="scroll"
+  icon-type="half"
+>
   <nut-tab-panel tab-title="页签一"
     ><p class="content-tab">这里是页签一内容</p></nut-tab-panel
   >
@@ -253,6 +257,6 @@ export default {
 
 ### Event
 
-| 事件名称   | 说明               | 回调参数               |
-| ---------- | ------------------ | ---------------------- |
+| 事件名称   | 说明               | 回调参数             |
+| ---------- | ------------------ | -------------------- |
 | switch-tab | 切换页签时触发事件 | 当前活动状态的索引值 |