Skip to content

Commit 5b2ebb4

Browse files
committed
docs: update docs
1 parent e27defe commit 5b2ebb4

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

packages/vue/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Himenon
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

packages/vue/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Usage
66

7+
[DEMO](https://codesandbox.io/s/vue-path-tree-demo-72p76)
8+
79
### Install
810

911
```bash
@@ -37,6 +39,39 @@ new Vue({
3739
}).$mount("#root");
3840
```
3941

42+
#### use `.vue`
43+
44+
```vue
45+
<template>
46+
<PathTree :pathItems="pathItems"></PathTree>
47+
</template>
48+
49+
<script>
50+
import * as PathTree from "@path-tree/vue";
51+
52+
export default {
53+
name: "Tree",
54+
components: {
55+
PathTree: PathTree.Component,
56+
},
57+
data() {
58+
return {
59+
pathItems: [
60+
{
61+
type: "file",
62+
path: "a/b/index.js",
63+
},
64+
{
65+
type: "file",
66+
path: "a/b/c/index.js",
67+
},
68+
],
69+
};
70+
},
71+
};
72+
</script>
73+
```
74+
4075
### Define components
4176

4277
```tsx

0 commit comments

Comments
 (0)