@hugocxl/design-system 0.2.12 → 0.2.16
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/DESIGN.md +4 -4
- package/README.md +7 -7
- package/package.json +7 -6
- package/skills/design-system/SKILL.md +1 -1
- package/system/plan.schema.json +1 -1
package/DESIGN.md
CHANGED
|
@@ -348,7 +348,7 @@ Radii: 6px for the button, code blocks and table edges, 12px for media and the f
|
|
|
348
348
|
|
|
349
349
|
## Components
|
|
350
350
|
|
|
351
|
-
These thirteen components make up the whole vocabulary. Each markup block below is copied from the live specimen in `index.html` by `
|
|
351
|
+
These thirteen components make up the whole vocabulary. Each markup block below is copied from the live specimen in `index.html` by `pnpm run sync`, so it is exactly what the reference renders. Keep every class and attribute.
|
|
352
352
|
|
|
353
353
|
### `masthead`
|
|
354
354
|
|
|
@@ -553,7 +553,7 @@ Mono links at both ends with a hairline between them. It is the last element in
|
|
|
553
553
|
|
|
554
554
|
## Icons and vectors
|
|
555
555
|
|
|
556
|
-
Pages draw with two companion libraries and nothing else. [`@hugocxl/icons`](https://hugocxl.github.io/icons/) label actions and [`@hugocxl/vectors`](https://hugocxl.github.io/vectors/) illustrate ideas. Both draw in `currentColor`, so they follow the theme and never touch the accent. Only an icon may take a color, from the [hues](#hues) or the [status roles](#status). No other icon set, illustration, emoji or symbol character may stand in for them.
|
|
556
|
+
Pages draw with two companion libraries and nothing else. [`@hugocxl/icons`](https://hugocxl.github.io/stack/icons/) label actions and [`@hugocxl/vectors`](https://hugocxl.github.io/stack/vectors/) illustrate ideas. Both draw in `currentColor`, so they follow the theme and never touch the accent. Only an icon may take a color, from the [hues](#hues) or the [status roles](#status). No other icon set, illustration, emoji or symbol character may stand in for them.
|
|
557
557
|
|
|
558
558
|
```sh
|
|
559
559
|
npm install @hugocxl/design-system @hugocxl/icons @hugocxl/vectors
|
|
@@ -632,7 +632,7 @@ import { ModularDesignVector } from '@hugocxl/vectors/react/modular-design';
|
|
|
632
632
|
<div className="ds-media"><ModularDesignVector className="ds-vector" /></div>
|
|
633
633
|
```
|
|
634
634
|
|
|
635
|
-
- Choose a vector for what it means. The [vectors browser](https://hugocxl.github.io/vectors/browse.html) lists all 2,000 by use case. Name it in the caption.
|
|
635
|
+
- Choose a vector for what it means. The [vectors browser](https://hugocxl.github.io/stack/vectors/browse.html) lists all 2,000 by use case. Name it in the caption.
|
|
636
636
|
- Keep the SVG's `title` and `desc`: they are its accessible name.
|
|
637
637
|
- Use an `<img>` only for a screenshot of the product itself.
|
|
638
638
|
- Never crop a vector, color it with the accent or place it on the field.
|
|
@@ -683,4 +683,4 @@ Give the agent this file at a pinned commit and a page plan. A page plan is JSON
|
|
|
683
683
|
|
|
684
684
|
### Verify
|
|
685
685
|
|
|
686
|
-
`
|
|
686
|
+
`pnpm test` lints this file, checks that its markup matches the specimens, and runs browser tests on the reference: computed tokens in both themes, column and figure geometry at 320, 760, 761 and 1440px, the accent budget, keyboard behavior and an axe WCAG 2.2 AA scan. For a generated page, check the same things plus the recipe order. To compare screenshots, fix the browser, viewport, scale, theme, locale and motion settings, and wait for fonts and figures to load.
|
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
The design system behind all my personal projects. Large reading type, quiet line vectors, rounded icons and a single orange accent, so every site I ship, from a product page to its docs, reads as part of the same body of work.
|
|
6
6
|
|
|
7
|
-
[Read the system](https://hugocxl.github.io/design-system/) · [See the icons and vectors in use](https://hugocxl.github.io/design-system/#stack) · [Visit the website](https://hugocxl.github.io/design-system/)
|
|
7
|
+
[Read the system](https://hugocxl.github.io/stack/design-system/) · [See the icons and vectors in use](https://hugocxl.github.io/stack/design-system/#stack) · [Visit the website](https://hugocxl.github.io/stack/design-system/)
|
|
8
8
|
|
|
9
|
-
[](https://hugocxl.github.io/design-system/)
|
|
9
|
+
[](https://hugocxl.github.io/stack/design-system/)
|
|
10
10
|
|
|
11
11
|
## Calm by default
|
|
12
12
|
|
|
@@ -28,10 +28,10 @@ Thirteen components and six page recipes cover a home page, articles, docs, chan
|
|
|
28
28
|
|
|
29
29
|
Four libraries, designed to work as one.
|
|
30
30
|
|
|
31
|
-
- **[@hugocxl/icons](https://hugocxl.github.io/icons/)** labels what people can do.
|
|
32
|
-
- **[@hugocxl/vectors](https://hugocxl.github.io/vectors/)** illustrates what you mean.
|
|
33
|
-
- **[@hugocxl/sounds](https://hugocxl.github.io/sounds/)** makes it feel like something.
|
|
34
|
-
- **[@hugocxl/design-system](https://hugocxl.github.io/design-system/)** gives them the type, color and space to live in.
|
|
31
|
+
- **[@hugocxl/icons](https://hugocxl.github.io/stack/icons/)** labels what people can do.
|
|
32
|
+
- **[@hugocxl/vectors](https://hugocxl.github.io/stack/vectors/)** illustrates what you mean.
|
|
33
|
+
- **[@hugocxl/sounds](https://hugocxl.github.io/stack/sounds/)** makes it feel like something.
|
|
34
|
+
- **[@hugocxl/design-system](https://hugocxl.github.io/stack/design-system/)** gives them the type, color and space to live in.
|
|
35
35
|
|
|
36
36
|
**Building with an AI agent?** The package ships an agent skill in `skills/design-system/`, and
|
|
37
37
|
[hugocxl/stack](https://github.com/hugocxl/stack) sets up any project so every agent uses the
|
|
@@ -41,4 +41,4 @@ four libraries the same way.
|
|
|
41
41
|
|
|
42
42
|
The system is [MIT licensed](LICENSE). It ships the [Geist](https://vercel.com/font) typefaces under their [own license](system/fonts/Geist-LICENSE.txt). Its paper, orange and reading scale take after [Superlogical](https://www.superlogical.com/).
|
|
43
43
|
|
|
44
|
-
Made by [Hugo](https://github.com/hugocxl). Ideas and contributions are welcome: [open an issue](https://github.com/hugocxl/
|
|
44
|
+
Made by [Hugo](https://github.com/hugocxl). Ideas and contributions are welcome: [open an issue](https://github.com/hugocxl/stack/issues).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hugocxl/design-system",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.16",
|
|
4
4
|
"description": "The personal design system of @hugocxl: the signature across every project.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
@@ -42,10 +42,11 @@
|
|
|
42
42
|
},
|
|
43
43
|
"style": "./system/ds.css",
|
|
44
44
|
"license": "MIT",
|
|
45
|
-
"homepage": "https://hugocxl.github.io/design-system/",
|
|
45
|
+
"homepage": "https://hugocxl.github.io/stack/design-system/",
|
|
46
46
|
"repository": {
|
|
47
47
|
"type": "git",
|
|
48
|
-
"url": "https://github.com/hugocxl/
|
|
48
|
+
"url": "https://github.com/hugocxl/stack.git",
|
|
49
|
+
"directory": "design-system"
|
|
49
50
|
},
|
|
50
51
|
"publishConfig": {
|
|
51
52
|
"access": "public"
|
|
@@ -53,15 +54,15 @@
|
|
|
53
54
|
"scripts": {
|
|
54
55
|
"sync": "node scripts/sync-assets.mjs && node scripts/sync-design.mjs",
|
|
55
56
|
"check": "design.md lint DESIGN.md && node scripts/sync-assets.mjs --check && node scripts/sync-design.mjs --check && node scripts/build-exports.mjs --check && node scripts/check-skill.mjs",
|
|
56
|
-
"test": "
|
|
57
|
+
"test": "pnpm run check && playwright test",
|
|
57
58
|
"build": "node scripts/build-exports.mjs",
|
|
58
59
|
"prepack": "node scripts/build-exports.mjs --check"
|
|
59
60
|
},
|
|
60
61
|
"devDependencies": {
|
|
61
62
|
"@axe-core/playwright": "4.14.0",
|
|
62
63
|
"@google/design.md": "0.4.0",
|
|
63
|
-
"@hugocxl/icons": "
|
|
64
|
-
"@hugocxl/vectors": "
|
|
64
|
+
"@hugocxl/icons": "0.2.0",
|
|
65
|
+
"@hugocxl/vectors": "0.1.0",
|
|
65
66
|
"@playwright/test": "1.65.1",
|
|
66
67
|
"yaml": "2.9.1"
|
|
67
68
|
}
|
|
@@ -94,4 +94,4 @@ markup and classes from DESIGN.md wherever one fits instead of inventing a new o
|
|
|
94
94
|
- Icons come from `@hugocxl/icons` (Stroke) and figures from `@hugocxl/vectors`.
|
|
95
95
|
- The page works at 320, 760, 761 and 1440 px in light and dark.
|
|
96
96
|
|
|
97
|
-
Reference page: https://hugocxl.github.io/design-system/
|
|
97
|
+
Reference page: https://hugocxl.github.io/stack/design-system/
|
package/system/plan.schema.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://hugocxl.github.io/design-system/system/plan.schema.json",
|
|
3
|
+
"$id": "https://hugocxl.github.io/stack/design-system/system/plan.schema.json",
|
|
4
4
|
"title": "Design system page plan",
|
|
5
5
|
"description": "One page as data. Render each block by copying its component markup from DESIGN.md and replacing only the slot values.",
|
|
6
6
|
"type": "object",
|