@buffercreations/levelsui 0.1.0 → 0.1.1
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 +84 -18
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,30 +1,96 @@
|
|
|
1
|
-
#
|
|
1
|
+
# LevelsUI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**LevelsUI** is a modular UI Asset Library built on [BufferCore](https://www.npmjs.com/package/@buffercreations/buffercore), providing reusable interface elements, layouts, components, templates and pages.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Assets are designed to work with BufferCore's design tokens, utilities, Runtime and shared Behaviours, keeping custom CSS and JavaScript to a minimum.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Installation
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
9
|
+
Install BufferCore and LevelsUI:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @buffercreations/buffercore
|
|
13
|
+
npm install -D @buffercreations/levelsui
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Initialise LevelsUI in your project:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx levelsui init
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
Browse the available Assets:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx levelsui list
|
|
28
|
+
npx levelsui info button
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Add an Asset to your project:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx levelsui add button
|
|
16
35
|
```
|
|
17
36
|
|
|
18
|
-
|
|
37
|
+
Activate it and build your Assets:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx levelsui activate button
|
|
41
|
+
npx levelsui build
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Only active Assets and their required dependencies are included in the generated Asset output.
|
|
45
|
+
|
|
46
|
+
## Asset Library
|
|
47
|
+
|
|
48
|
+
LevelsUI organises Assets into five categories:
|
|
49
|
+
|
|
50
|
+
| Category | Purpose |
|
|
51
|
+
|---|---|
|
|
52
|
+
| Elements | Fundamental interface building blocks |
|
|
53
|
+
| Layouts | Structure, positioning and composition |
|
|
54
|
+
| Components | Reusable interface patterns |
|
|
55
|
+
| Templates | Compositions for common interface structures |
|
|
56
|
+
| Pages | Complete page-level compositions |
|
|
57
|
+
|
|
58
|
+
Assets can reference other Assets and shared BufferCore Behaviours.
|
|
59
|
+
|
|
60
|
+
## CLI
|
|
61
|
+
|
|
62
|
+
| Command | Description |
|
|
63
|
+
|---|---|
|
|
64
|
+
| `init` | Initialise LevelsUI in a project |
|
|
65
|
+
| `list` | List available or installed Assets |
|
|
66
|
+
| `info` | View Asset information |
|
|
67
|
+
| `add` | Install an Asset |
|
|
68
|
+
| `activate` | Enable an installed Asset |
|
|
69
|
+
| `deactivate` | Disable an Asset |
|
|
70
|
+
| `update` | Update an installed Asset |
|
|
71
|
+
| `remove` | Remove an Asset |
|
|
72
|
+
| `prune` | Identify unused dependencies |
|
|
73
|
+
| `entries` | Generate Asset entry points |
|
|
74
|
+
| `build` | Build active Assets |
|
|
75
|
+
| `validate` | Validate Asset definitions |
|
|
76
|
+
| `doctor` | Check project configuration and installation health |
|
|
77
|
+
|
|
78
|
+
Run `npx levelsui help` for command details.
|
|
79
|
+
|
|
80
|
+
## Requirements
|
|
81
|
+
|
|
82
|
+
- Node.js 20 or later
|
|
83
|
+
- BufferCore installed in the project
|
|
19
84
|
|
|
20
|
-
|
|
85
|
+
## Packages
|
|
21
86
|
|
|
22
|
-
|
|
87
|
+
- [BufferCore](https://www.npmjs.com/package/@buffercreations/buffercore) — standalone design system
|
|
88
|
+
- [LevelsUI](https://www.npmjs.com/package/@buffercreations/levelsui) — optional UI Asset Library
|
|
23
89
|
|
|
24
|
-
|
|
90
|
+
## Licence
|
|
25
91
|
|
|
26
|
-
|
|
92
|
+
See the included `LICENSE` file for terms of use.
|
|
27
93
|
|
|
28
|
-
|
|
94
|
+
---
|
|
29
95
|
|
|
30
|
-
|
|
96
|
+
Developed by **BufferCreations**.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@buffercreations/levelsui",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.1",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "BufferCore LevelsUI: optional Assets and management tooling",
|
|
7
7
|
"scripts": {
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"ajv": "8.20.0"
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {
|
|
45
|
-
"@buffercreations/buffercore": "^
|
|
45
|
+
"@buffercreations/buffercore": "^0.8.0"
|
|
46
46
|
},
|
|
47
47
|
"publishConfig": {
|
|
48
48
|
"access": "public"
|