feat: migrate TreeSelect component

2020-07-12 15:34:08 +08:00
parent d04c8c1e24
commit 7a197fc90f
13 changed files with 1281 additions and 24 deletions
@@ -0,0 +1,170 @@
+# TreeSelect
+
+### Install
+
+```js
+import Vue from 'vue';
+import { TreeSelect } from 'vant';
+
+Vue.use(TreeSelect);
+```
+
+## Usage
+
+### Radio Mode
+
+```html
+<van-tree-select
+  v-model:active-id="activeId"
+  v-model:main-active-index="activeIndex"
+  :items="items"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      items,
+      activeId: 1,
+      activeIndex: 0,
+    };
+  },
+};
+```
+
+### Multiple Mode
+
+```html
+<van-tree-select
+  v-model:active-id="activeIds"
+  v-model:main-active-index="activeIndex"
+  :items="items"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      items,
+      activeIds: [1, 2],
+      activeIndex: 0,
+    };
+  },
+};
+```
+
+### Custom Content
+
+```html
+<van-tree-select v-model:main-active-index="active" height="55vw" :items="items">
+  <template #content>
+    <van-image
+      v-if="active === 0"
+      src="https://img.yzcdn.cn/vant/apple-1.jpg"
+    />
+    <van-image
+      v-if="active === 1"
+      src="https://img.yzcdn.cn/vant/apple-2.jpg"
+    />
+  </template>
+</van-tree-select>
+```
+
+```js
+export default {
+  data() {
+    return {
+      active: 0,
+      items: [{ text: 'Group 1' }, { text: 'Group 2' }],
+    };
+  },
+};
+```
+
+### Show Badge
+
+```html
+<van-tree-select
+  v-model:main-active-index="activeIndex"
+  height="55vw"
+  :items="items"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      activeIndex: 0,
+      items: [
+        { text: 'Group 1', children: [], dot: true },
+        { text: 'Group 2', children: [], badge: 5 },
+      ],
+    };
+  },
+};
+```
+
+## API
+
+### Props
+
+| Attribute | Description | Type | Default |
+| --- | --- | --- | --- |
+| items | Required datasets for the component | _Item[]_ | `[]` |
+| height | Height | _number \| string_ | `300` |
+| main-active-index | The index of selected parent node | _number \| string_ | `0` |
+| active-id | Id of selected item | _number \| string \|<br>(number \| string)[]_ | `0` |
+| max `v2.2.0` | Maximum number of selected items | _number \| string_ | `Infinity` |
+| selected-icon `v2.9.0` | Selected icon | _string_ | `success` |
+
+### Events
+
+| Event | Description | Arguments |
+| --- | --- | --- |
+| click-nav | triggered when parent node is selected | index: index of selected parent |
+| click-item | triggered when item is selected | data: selected item |
+
+### Slots
+
+| Name    | Description          |
+| ------- | -------------------- |
+| content | Custom right content |
+
+### Data Structure of Item
+
+`items` should be an array contains specified tree objects.
+
+In every tree object, `text` property defines `id` stands for the unique key while the `children` contains sub-tree objects.
+
+```js
+[
+  {
+    // name of the parent node
+    text: 'Group 1',
+    // badge
+    badge: 3,
+    // Whether to show red dot
+    dot: true,
+    // ClassName of parent node
+    className: 'my-class',
+    // leaves of this parent node
+    children: [
+      {
+        // name of the leaf node
+        text: 'Washington',
+        // id of the leaf node, component highlights leaf node by comparing the activeId with this.
+        id: 1,
+        // disable options
+        disabled: true,
+      },
+      {
+        text: 'Baltimore',
+        id: 2,
+      },
+    ],
+  },
+];
+```