@public-ui/vue 4.0.0-alpha.0 → 4.0.0-alpha.2
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 +16 -6
- package/dist/index.cjs +124 -147
- package/dist/index.d.cts +65 -0
- package/dist/index.d.mts +65 -0
- package/dist/index.d.ts +5 -7
- package/dist/index.mjs +122 -143
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# KoliBri - Vue-Adapter
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@public-ui/components)
|
|
4
|
+
[](https://github.com/public-ui/kolibri/blob/main/LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/@public-ui/vue)
|
|
6
|
+
[](https://github.com/public-ui/kolibri/issues)
|
|
7
|
+
[](https://github.com/public-ui/kolibri/pulls)
|
|
8
|
+
[](https://bundlephobia.com/result?p=@public-ui/vue)
|
|
9
|
+
|
|
10
|
+
|
|
3
11
|
## Motivation
|
|
4
12
|
|
|
5
13
|
Provide an adapter for [Vue](https://vuejs.org/) to use the KoliBri components.
|
|
@@ -9,18 +17,18 @@ Provide an adapter for [Vue](https://vuejs.org/) to use the KoliBri components.
|
|
|
9
17
|
You can install the adapter with `npm`, `pnpm` or `yarn`:
|
|
10
18
|
|
|
11
19
|
```bash
|
|
12
|
-
npm i
|
|
13
|
-
pnpm i
|
|
14
|
-
yarn add
|
|
20
|
+
npm i @public-ui/vue
|
|
21
|
+
pnpm i @public-ui/vue
|
|
22
|
+
yarn add @public-ui/vue
|
|
15
23
|
```
|
|
16
24
|
|
|
17
25
|
## Usage
|
|
18
26
|
|
|
19
|
-
First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/
|
|
27
|
+
First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/vue) and create a Vue app:
|
|
20
28
|
|
|
21
29
|
```ts
|
|
22
30
|
import { createApp } from 'vue';
|
|
23
|
-
import { DEFAULT } from '@public-ui/
|
|
31
|
+
import { DEFAULT } from '@public-ui/theme-default';
|
|
24
32
|
import { defineCustomElements } from '@public-ui/components/dist/loader';
|
|
25
33
|
import { register } from '@public-ui/components';
|
|
26
34
|
|
|
@@ -40,6 +48,8 @@ Then, you can import any component from `@public-ui/vue` and render it within yo
|
|
|
40
48
|
import { KolButton } from '@public-ui/vue';
|
|
41
49
|
</script>
|
|
42
50
|
<template>
|
|
43
|
-
|
|
51
|
+
<KolButton _label="Hello World" />
|
|
44
52
|
</template>
|
|
45
53
|
```
|
|
54
|
+
|
|
55
|
+
Find available design tokens in the [default theme README](../../themes/default/README.md).
|