@imfusion/web-ui 0.5.1-dev.6.ge1cebe1f → 0.5.1-dev.6.gece7a7b5
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 +18 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,11 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
`@imfusion/web-ui` — the official shared Web UI library for ImFusion web apps, built on Base UI.
|
|
4
4
|
|
|
5
|
-
- [Usage](#usage) — install, wire up, and keep the version current
|
|
6
|
-
- [Documentation](#documentation) — Storybook and the developer docs
|
|
7
|
-
- [Development](#development) — working on the library itself, including the Agent Skills
|
|
8
|
-
- [Releasing](#releasing) — how versions are derived and how to cut one
|
|
9
|
-
|
|
10
5
|
## Usage
|
|
11
6
|
|
|
12
7
|
The packages are private on npmjs.com.
|
|
@@ -38,17 +33,8 @@ import "@imfusion/web-ui/styles.css";
|
|
|
38
33
|
import { WebUIProvider } from "@imfusion/web-ui";
|
|
39
34
|
```
|
|
40
35
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
A set of skills lets an AI agent drive the library without reading its source. With the package installed, add them to your
|
|
44
|
-
project:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
npx web-ui-install-skills
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
Re-run it after a version bump to stay current. The entry point is `/imf-web-ui`, a router that points at the right skill for
|
|
51
|
-
the task at hand. Storybook's **User Guide → AI Agents** page covers the whole family.
|
|
36
|
+
**There is also an AI skill to help you set up the Web UI library in your project:
|
|
37
|
+
[`/imf-web-ui-setup`](./src/llms/skills/imf-web-ui-setup/SKILL.md). **
|
|
52
38
|
|
|
53
39
|
### Versions and updates
|
|
54
40
|
|
|
@@ -72,6 +58,20 @@ Every merge to master publishes a new build under the `dev` dist-tag. Which spec
|
|
|
72
58
|
- **A `file:` tarball never updates.** npm copies the archive into `node_modules` and re-copies the same one on every
|
|
73
59
|
install. Switch to `dev` or a version range to get updates.
|
|
74
60
|
|
|
61
|
+
### Consumer skills — `imf-web-ui-*`
|
|
62
|
+
|
|
63
|
+
These skills are shipped with a `imf-web-ui` prefix, so to make their names identifiable and not pollute the skill namespace
|
|
64
|
+
of the user.
|
|
65
|
+
|
|
66
|
+
| Skill | What it does |
|
|
67
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
68
|
+
| `/imf-web-ui` | The router: decides whether guidance is needed, then which companion to open. |
|
|
69
|
+
| `/imf-web-ui-setup` | One-time wiring in a consumer project — the styles import and the provider. |
|
|
70
|
+
| `/imf-web-ui-components` | Component reference — what exists and how it's meant to be used. |
|
|
71
|
+
| `/imf-web-ui-ux` | UX guidance for building interfaces with the library. |
|
|
72
|
+
| `/imf-web-ui-frontend-patterns` | Frontend patterns, including the sanctioned styling seams (tokens, data attributes). |
|
|
73
|
+
| `/imf-web-ui-imfusion-frontend-setup` | Set up or audit an ImFusion frontend's tooling against the house baseline. |
|
|
74
|
+
|
|
75
75
|
## Documentation
|
|
76
76
|
|
|
77
77
|
**[Storybook](https://storybook.js.org/)** is the documentation platform — the component catalog, every prop, and the setup
|
|
@@ -131,18 +131,8 @@ Given the tag `web-ui/v0.5.0`:
|
|
|
131
131
|
| Exactly on `web-ui/v0.5.0` | `0.5.0` | `latest` |
|
|
132
132
|
| 5 commits after that tag | `0.5.1-dev.5.gb4de52d7` | `dev` |
|
|
133
133
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
```
|
|
137
|
-
0.5.1-dev.5.gb4de52d7
|
|
138
|
-
└─┬─┘ └┬┘ │ └───┬────┘
|
|
139
|
-
│ │ │ └── commit hash, abbreviated; the leading g means "git"
|
|
140
|
-
│ │ └──────── commits since the tag
|
|
141
|
-
│ └─────────── pre-release marker, which is what puts it on the dev tag
|
|
142
|
-
└──────────────── the tag's version, patch bumped
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
Bumping the patch is what makes a dev build sort above the release it follows and below the next one.
|
|
134
|
+
where `5` is the number of commits since the tag and `b4de52d7` the abbreviated hash. Off-tag builds bump the patch, so a dev
|
|
135
|
+
build always sorts above the release it follows and below the next one.
|
|
146
136
|
|
|
147
137
|
Every build of `master` publishes a `dev` version automatically. To check what the current checkout would publish:
|
|
148
138
|
|
package/package.json
CHANGED