@enos5/enos-vue-default 0.2.0 → 0.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 +59 -6
- package/dist/index.css +1028 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +133 -129
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,71 @@
|
|
|
1
1
|
# `@enos5/enos-vue-default`
|
|
2
2
|
|
|
3
|
-
Default workspace
|
|
3
|
+
Shared Vue 3 UI components from Enos, packaged as the Default workspace inside the monorepo.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Requirements
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- Node.js 20+
|
|
8
|
+
- npm
|
|
8
9
|
|
|
9
|
-
##
|
|
10
|
+
## Install
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
From the workspace root:
|
|
12
13
|
|
|
13
14
|
```bash
|
|
14
|
-
npm
|
|
15
|
+
npm install
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Build this package:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm run build -w @enos5/enos-vue-default
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Use In Another Project
|
|
25
|
+
|
|
26
|
+
Install the published package:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm install @enos5/enos-vue-default
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This package expects these peer dependencies in the consuming app:
|
|
33
|
+
|
|
34
|
+
- `vue`
|
|
35
|
+
- `@inertiajs/vue3` (`^2.0.0` or `^3.0.0`)
|
|
36
|
+
- `@heroicons/vue`
|
|
37
|
+
- `vue-i18n`
|
|
38
|
+
|
|
39
|
+
Rich text support uses TinyMCE and is bundled as a regular dependency in this library. The component set mirrors the Jetstream package except for `ApplicationLogo`, `AuthenticationCard`, `Banner`, `NavGroup`, `NavLink`, `NavMenu`, and `ResponsiveNavLink`.
|
|
40
|
+
|
|
41
|
+
You can register everything globally:
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
import { createApp } from 'vue'
|
|
45
|
+
import App from './App.vue'
|
|
46
|
+
import { EnosVueDefault } from '@enos5/enos-vue-default'
|
|
47
|
+
|
|
48
|
+
createApp(App).use(EnosVueDefault).mount('#app')
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Or import individual components:
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
import { Button, TextInput } from '@enos5/enos-vue-default'
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Publish To npm
|
|
58
|
+
|
|
59
|
+
Before publishing, build the package and verify the tarball:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm run build -w @enos5/enos-vue-default
|
|
15
63
|
npm pack --dry-run -w packages/default
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Then bump the version in `packages/default/package.json`, commit the change, and publish the workspace:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
16
69
|
npm publish -w packages/default --access public
|
|
17
70
|
```
|
|
18
71
|
|