[Doc] rename component README file (#3662)

2019-06-27 14:22:40 +08:00
parent a56f96c246
commit ddb24e6762
119 changed files with 4 additions and 3 deletions
@@ -0,0 +1,69 @@
+# Sidebar 侧边导航
+
+### 引入
+
+``` javascript
+import { Sidebar, SidebarItem } from 'vant';
+
+Vue.use(Sidebar);
+Vue.use(SidebarItem);
+```
+
+## 代码演示
+
+### 基础用法
+
+通过在`van-sidebar`上设置`active-key`属性来控制选中项
+
+```html
+<van-sidebar :active-key="activeKey" @change="onChange">
+  <van-sidebar-item title="标签名称" />
+  <van-sidebar-item title="标签名称" info="8" />
+  <van-sidebar-item title="标签名称" info="99" />
+  <van-sidebar-item title="标签名称" info="99+" />
+</van-sidebar>
+```
+
+``` javascript
+export default {
+  data() {
+    return {
+      activeKey: 0
+    };
+  },
+
+  methods: {
+    onChange(key) {
+      this.activeKey = key;
+    }
+  }
+};
+```
+
+## API
+
+### Sidebar Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| active-key | 当前导航项的索引 | `String | Number` | `0` | - |
+
+### Sidebar Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| change | 切换当前导航项时触发 | key: 当前导航项的索引 |
+
+### SidebarItem Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| title | 内容 | `String` | `''` | - |
+| info | 提示消息 | `String | Number` | `''` | - |
+| url | 跳转链接 | `String` | - | - |
+
+### SidebarItem Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| click | 点击时触发 | key: 当前导航项的索引 |