Skip to content

Commit 262b844

Browse files
authored
Merge pull request #31 from Himenon/chore/update
chore: update docs and props
2 parents 885e545 + dab3675 commit 262b844

File tree

8 files changed

+76
-16
lines changed

8 files changed

+76
-16
lines changed

packages/react/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
### Install
1010

1111
```bash
12-
yarn add @path-tree/react
12+
yarn add @path-tree/react tslib
1313
```
1414

1515
### Basic Usage

packages/react/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"types": "lib/index.d.ts",
77
"files": [
88
"README.md",
9-
"lib"
9+
"lib",
10+
"LICENSE"
1011
],
1112
"license": "MIT",
1213
"scripts": {

packages/react/src/DevServer.tsx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ const props: PathTree.Props = {
3131
"packages/collection/package.json",
3232
"packages/collection/tsconfig.json",
3333
"packages/collection/tsconfig.tsbuildinfo",
34-
"packages/react-ui/package.json",
35-
"packages/react-ui/public/index.html",
36-
"packages/react-ui/public/main.css",
37-
"packages/react-ui/src/DevServer.tsx",
38-
"packages/react-ui/src/Directory.tsx",
39-
"packages/react-ui/src/DirectoryTree.tsx",
40-
"packages/react-ui/src/File.tsx",
41-
"packages/react-ui/src/index.tsx",
42-
"packages/react-ui/src/Tree.tsx",
43-
"packages/react-ui/tsconfig.json",
44-
"packages/react-ui/webpack.config.ts",
34+
"packages/react/package.json",
35+
"packages/react/public/index.html",
36+
"packages/react/public/main.css",
37+
"packages/react/src/DevServer.tsx",
38+
"packages/react/src/Directory.tsx",
39+
"packages/react/src/DirectoryTree.tsx",
40+
"packages/react/src/File.tsx",
41+
"packages/react/src/index.tsx",
42+
"packages/react/src/Tree.tsx",
43+
"packages/react/tsconfig.json",
44+
"packages/react/webpack.config.ts",
4545
"renovate.json",
4646
"tsconfig.json",
4747
"yarn.lock",

packages/vue/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
lib
2+
dist

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: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44

55
## Usage
66

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

911
```bash
10-
yarn add @path-tree/vue
12+
yarn add @path-tree/vue tslib
1113
```
1214

1315
### Basic Usage
@@ -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

packages/vue/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"types": "lib/index.d.ts",
77
"files": [
88
"README.md",
9-
"lib"
9+
"lib",
10+
"LICENSE"
1011
],
1112
"license": "MIT",
1213
"scripts": {

packages/vue/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"extends": "../../tsconfig.json",
3-
"include": ["./src/*.ts", "./src/*.tsx"],
3+
"include": ["src/Directory.ts", "src/DirectoryTree.ts", "src/File.ts", "src/Tree.ts", "src/index.ts"],
44
"compilerOptions": {
55
"lib": ["ES2019", "DOM"],
66
"module": "commonjs",

0 commit comments

Comments
 (0)