@deskhero/dh_ui 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -8
- package/package.json +31 -2
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
## Deskhero ui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Deskhero ui is component library, based on Deskhero design system and Vue 3.
|
|
4
|
+
|
|
5
|
+
|
|
4
6
|
|
|
5
7
|
<hr/>
|
|
6
8
|
|
|
@@ -23,10 +25,19 @@ import "@deskhero/dh_ui/dist/style.css"
|
|
|
23
25
|
```
|
|
24
26
|
|
|
25
27
|
## Storybook
|
|
28
|
+
|
|
29
|
+
Storybook helps you build UI components in isolation from your app's business logic, data, and context. That makes it easy to develop hard-to-reach states. Save these UI states as stories to revisit during development, testing, or QA.
|
|
30
|
+
|
|
26
31
|
We are using storybook in order to develop the components independently from any consumer.
|
|
27
32
|
run this to build & run the storybook locally:
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
First install the node packages:
|
|
28
36
|
```bash
|
|
29
37
|
npm install
|
|
38
|
+
```
|
|
39
|
+
then serve storybook application
|
|
40
|
+
```bash
|
|
30
41
|
npm run storybook
|
|
31
42
|
```
|
|
32
43
|
the storybook will be served on `http://localhost:6006`
|
|
@@ -37,14 +48,13 @@ When developing locally we are using a npm functionality called npm link, this a
|
|
|
37
48
|
work locally on our package and use it in a different project without publishing.
|
|
38
49
|
This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.
|
|
39
50
|
|
|
40
|
-
|
|
51
|
+
From dh_ui
|
|
41
52
|
|
|
42
53
|
```sh
|
|
43
|
-
npm run build
|
|
44
|
-
npm link
|
|
54
|
+
npm run build && npm link
|
|
45
55
|
```
|
|
46
56
|
|
|
47
|
-
|
|
57
|
+
Then on your project
|
|
48
58
|
|
|
49
59
|
```sh
|
|
50
60
|
npm link @deskhero/dh_ui
|
|
@@ -52,12 +62,12 @@ npm link @deskhero/dh_ui
|
|
|
52
62
|
|
|
53
63
|
<hr/>
|
|
54
64
|
|
|
55
|
-
|
|
65
|
+
### Recommended IDE Setup
|
|
56
66
|
|
|
57
67
|
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
|
|
58
68
|
|
|
59
69
|
|
|
60
|
-
|
|
70
|
+
### Type Support for .vue Imports in TS
|
|
61
71
|
|
|
62
72
|
|
|
63
73
|
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
|
|
@@ -68,3 +78,5 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
|
|
|
68
78
|
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
|
|
69
79
|
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
|
|
70
80
|
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
|
|
81
|
+
|
|
82
|
+
<hr/>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deskhero/dh_ui",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"files": [
|
|
5
5
|
"dist"
|
|
6
6
|
],
|
|
@@ -65,7 +65,36 @@
|
|
|
65
65
|
},
|
|
66
66
|
"release": {
|
|
67
67
|
"plugins": [
|
|
68
|
-
|
|
68
|
+
[
|
|
69
|
+
"@semantic-release/commit-analyzer",
|
|
70
|
+
{
|
|
71
|
+
"preset": "angular",
|
|
72
|
+
"releaseRules": [
|
|
73
|
+
{
|
|
74
|
+
"type": "docs",
|
|
75
|
+
"scope": "README",
|
|
76
|
+
"release": "patch"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"type": "refactor",
|
|
80
|
+
"scope": "core-*",
|
|
81
|
+
"release": "minor"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"type": "feat",
|
|
85
|
+
"release": "minor"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"type": "fix",
|
|
89
|
+
"release": "patch"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"type": "perf",
|
|
93
|
+
"release": "patch"
|
|
94
|
+
}
|
|
95
|
+
]
|
|
96
|
+
}
|
|
97
|
+
],
|
|
69
98
|
"@semantic-release/release-notes-generator",
|
|
70
99
|
"@semantic-release/npm",
|
|
71
100
|
"@semantic-release/changelog",
|