@rocketui/vue 0.0.2 → 0.0.4
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 +49 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,40 @@
|
|
|
1
1
|
# Rocket UI Vue
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
yarn add @rocket-ui/vue
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
Your `main.js` file should look like this:
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
import { createApp } from 'vue'
|
|
15
|
+
import App from './App.vue'
|
|
16
|
+
|
|
17
|
+
// Import the Styles
|
|
18
|
+
import '@rocket-ui/vue/dist/style.css'
|
|
19
|
+
|
|
20
|
+
createApp(App).mount('#app')
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then you can use the components in your `App.vue` file:
|
|
24
|
+
|
|
25
|
+
```vue
|
|
26
|
+
<script setup>
|
|
27
|
+
import { Button } from '@rocket-ui/vue'
|
|
28
|
+
</script>
|
|
29
|
+
|
|
30
|
+
<template>
|
|
31
|
+
<Button>Rocket UI Button</Button>
|
|
32
|
+
</template>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Development
|
|
36
|
+
|
|
37
|
+
### Recommended IDE Setup
|
|
4
38
|
|
|
5
39
|
[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).
|
|
6
40
|
|
|
@@ -15,36 +49,44 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
|
|
|
15
49
|
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
|
|
16
50
|
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
|
|
17
51
|
|
|
18
|
-
|
|
52
|
+
### Customize configuration
|
|
19
53
|
|
|
20
54
|
See [Vite Configuration Reference](https://vitejs.dev/config/).
|
|
21
55
|
|
|
22
|
-
|
|
56
|
+
### Project Setup
|
|
23
57
|
|
|
24
58
|
```sh
|
|
25
59
|
yarn install
|
|
26
60
|
```
|
|
27
61
|
|
|
28
|
-
|
|
62
|
+
#### Compile and Hot-Reload for Development
|
|
29
63
|
|
|
30
64
|
```sh
|
|
31
65
|
yarn dev
|
|
32
66
|
```
|
|
33
67
|
|
|
34
|
-
|
|
68
|
+
#### Type-Check, Compile and Minify for Production
|
|
35
69
|
|
|
36
70
|
```sh
|
|
37
71
|
yarn build
|
|
38
72
|
```
|
|
39
73
|
|
|
40
|
-
|
|
74
|
+
#### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
41
75
|
|
|
42
76
|
```sh
|
|
43
77
|
yarn test:unit
|
|
44
78
|
```
|
|
45
79
|
|
|
46
|
-
|
|
80
|
+
#### Lint with [ESLint](https://eslint.org/)
|
|
47
81
|
|
|
48
82
|
```sh
|
|
49
83
|
yarn lint
|
|
50
84
|
```
|
|
85
|
+
|
|
86
|
+
## Contribution
|
|
87
|
+
|
|
88
|
+
Clone the repo and run `yarn install` to install dependencies. Then run `yarn dev` to start the dev server.
|
|
89
|
+
|
|
90
|
+
## License
|
|
91
|
+
|
|
92
|
+
MIT. See [LICENSE](./LICENSE) for more details.
|