code review

2017-03-30 21:22:14 +08:00
parent e241d92cd9
commit e20022b868
20 changed files with 522 additions and 186 deletions
@@ -1,7 +1,3 @@
-## Badge 徽章
-
-### 基础用法
-
 <script>
  export default {
    data() {
@@ -17,13 +13,68 @@
  };
 </script>

+## Badge 徽章
+
+### 使用指南
+
+如果你已经按照[快速上手](/vue/component/quickstart)中引入了整个`ZanUI`，以下**组件注册**就可以忽略了，因为你已经全局注册了`ZanUI`中的全部组件。
+
+#### 全局注册
+
+你可以在全局注册`Badge`组件，比如页面的主文件（`index.js`，`main.js`），这样页面任何地方都可以直接使用`Badge`组件了：
+
+```js
+import Vue from 'vue';
+import { Badge, BadgeGroup } from '@youzan/zanui-vue';
+import '@youzan/zanui-vue/lib/zanui-css/badge.css';
+
+Vue.component(Badge.name, Badge);
+Vue.component(BadgeGroup.name, BadgeGroup);
+```
+
+#### 局部注册
+
+如果你只是想在某个组件中使用，你可以在对应组件中注册`Badge`组件，这样只能在你注册的组件中使用`Badge`：
+
+```js
+import { Badge, BadgeGroup } from '@youzan/zanui-vue';
+
+export default {
+  components: {
+    'zan-badge': Badge,
+    'zan-badge-group': BadgeGroup
+  }
+};
+```
+
+### 代码演示
+
+#### 基础用法
+
+默认情况下激活第一个`badge`。
+
 :::demo 基础用法
 ```html
-<zan-badge-group :active-key="activeKey">
-  <zan-badge mark="0" title="热销榜" info="8" url="http://baidu.com" @click="onItemClick"></zan-badge>
-  <zan-badge mark="1" title="花式寿司" info="99" @click="onItemClick"></zan-badge>
-  <zan-badge mark="2" title="火炽寿司" @click="onItemClick"></zan-badge>
-  <zan-badge mark="3" title="手握寿司" info="199" @click="onItemClick"></zan-badge>
+<zan-badge-group>
+  <zan-badge title="热销榜" info="8" url="http://baidu.com" @click="onItemClick"></zan-badge>
+  <zan-badge title="花式寿司" info="99" @click="onItemClick"></zan-badge>
+  <zan-badge title="火炽寿司" @click="onItemClick"></zan-badge>
+  <zan-badge title="手握寿司" info="199" @click="onItemClick"></zan-badge>
+</zan-badge-group>
+```
+:::
+
+#### 选中某个badge
+
+如果想默认选中某个`badge`，你可以在`zan-badge-group`上设置`activeKey`属性，属性值为对应的`badge`索引。
+
+:::demo 选中某个badge
+```html
+<zan-badge-group :active-key="2">
+  <zan-badge title="热销榜" info="8" url="http://baidu.com" @click="onItemClick"></zan-badge>
+  <zan-badge title="花式寿司" info="99" @click="onItemClick"></zan-badge>
+  <zan-badge title="火炽寿司" @click="onItemClick"></zan-badge>
+  <zan-badge title="手握寿司" info="199" @click="onItemClick"></zan-badge>
 </zan-badge-group>
 ```
 :::
@@ -38,7 +89,6 @@
 ### z-badge API
 | 参数       | 说明      | 类型       | 默认值       | 必须       |
 |-----------|-----------|-----------|-------------|-------------|
-| mark | badge的唯一key值 | `string`  | `''`          | `required`         |
 | title | badge的文案标题 | `string`  | `''`          | `required`          |
-| info | 当前badge的提示消息数量 | `string`  | `''`         |           |
-| url | 跳转链接 | `string`  | 全连接直接跳转或者hash          |           |
+| info | 当前badge的提示消息 | `string`  | `''`         |           |
+| url | 跳转链接 | `string`  | 链接直接跳转或者hash          |           |