cleek 2.10.17 → 2.10.19
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 +13 -55
- package/dist/main.cjs.js +43 -43
- package/dist/main.css +1 -1
- package/dist/main.es.js +34446 -34358
- package/dist/types/components/ck-select.vue.d.ts +24 -1
- package/dist/types/components/index.d.ts +1 -0
- package/dist/types/composables/use-scroll-listener.composable.d.ts +3 -0
- package/dist/types/utils/string-helpers.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,66 +1,24 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
A lightweight Vue 3 component library.
|
|
4
|
-
|
|
5
|
-
When you are starting a new prototype you want to be able to develop features fast. We created this component library as a way for us to build products quickly without having to deal with complicated packages and a huge bundle sizes.
|
|
1
|
+
# Cleek
|
|
2
|
+
Complete Vue 3 component library.
|
|
6
3
|
|
|
7
4
|
## Usage
|
|
5
|
+
Install it in your project `bun install cleek`
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
yarn add cleek
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
then you can import the available components like so
|
|
16
|
-
|
|
7
|
+
then you can import the available components like this
|
|
17
8
|
```vue
|
|
18
9
|
import { Button } from cleek
|
|
19
10
|
```
|
|
20
11
|
|
|
21
|
-
## Available commands
|
|
22
|
-
|
|
23
|
-
Here is a list of all available npm commands.
|
|
24
|
-
|
|
25
|
-
**Starting the dev environment**
|
|
26
|
-
We use Vue Press to hold our component documentation and examples
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
yarn dev
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**Building the documentation**
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
yarn build
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
**Serving the documentation**
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
yarn serve
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Building the library bundles**
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
yarn build:library
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
**Analyzing bundle sizes with [rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer)**
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
yarn analyze
|
|
54
|
-
```
|
|
55
12
|
|
|
56
|
-
|
|
13
|
+
## CLEEK DEVS
|
|
57
14
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
```
|
|
15
|
+
## Prerequisites
|
|
16
|
+
- Have bun installed in your system
|
|
61
17
|
|
|
62
|
-
|
|
18
|
+
## Initialization
|
|
19
|
+
- Install dependencies: `bun install`
|
|
63
20
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
21
|
+
## Deployment
|
|
22
|
+
- Update version on package.json
|
|
23
|
+
- Run `bun run build`
|
|
24
|
+
- Publish to npm: `npm publish`
|