@ponchia/ui 0.3.2 → 0.3.4

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.
@@ -0,0 +1,209 @@
1
+ # Theming & branding contract
2
+
3
+ `@ponchia/ui` is one framework meant to dress several different projects.
4
+ This is the **stable, supported surface** for re-branding without forking.
5
+ Anything not listed here is internal and may change between minor versions.
6
+
7
+ ## The one knob: `--accent`
8
+
9
+ The whole accent family derives from `--accent` via `color-mix()`:
10
+
11
+ | Token | Derivation (light / dark) | Role |
12
+ | --------------------- | -------------------------------------------- | ---- |
13
+ | `--accent-strong` | `--accent` mixed 83% with black / 84% white | darker/lighter accent for hover, emphasis |
14
+ | `--accent-text` | `var(--accent-strong)` (alias) | **accent used as foreground text** — the on-surface, AA-safe one |
15
+ | `--accent-soft` | `--accent` at 10% / 14% over transparent | tinted fills |
16
+ | `--bg-accent` | `--accent` at 6% / 8% | faint accent backgrounds |
17
+ | `--field-dot-accent` | `--accent` at 78% / 82% | form dot indicators |
18
+ | `--focus-ring` | `var(--accent)` (solid) | **every focus outline** — override to tune the ring alone |
19
+
20
+ So a full re-brand is one declaration — globally or on any subtree:
21
+
22
+ ```css
23
+ :root { --accent: #2f6df6; } /* brand the whole app blue */
24
+ .promo { --accent: #16a34a; } /* …or just this section green */
25
+ :root[data-theme='dark'] { --accent: #6ea8ff; } /* per-theme tuning */
26
+ ```
27
+
28
+ Everything — buttons, focus rings, dot motifs, accent borders, soft
29
+ fills — follows automatically, in both light and dark.
30
+
31
+ > **Two contrast obligations when you change `--accent`:**
32
+ >
33
+ > 1. **Buttons** — pick an `--accent` with ≥ 4.5:1 against `--button-text`
34
+ > (white in light, black in dark) for accessible primary buttons.
35
+ > 2. **Accent-as-text** — anywhere the accent is foreground text (links,
36
+ > active nav/tabs, eyebrows, chips) the framework uses `--accent-text`,
37
+ > **not** raw `--accent`, so it stays AA on surfaces. `--accent-text`
38
+ > defaults to `--accent-strong` (a darkened/​lightened accent). If you
39
+ > re-brand to a pale hue, raw `--accent` would fail as text — override
40
+ > `--accent-text` to a sufficiently dark/light value rather than
41
+ > relying on the 83%/84% mix.
42
+ >
43
+ > The defaults are tuned for both; verify if you deviate hard. The focus
44
+ > ring is solid `--accent` (≥ 3:1 non-text) — re-brand to a near-`--bg`
45
+ > hue and you must also raise `--focus-ring` (it's an independent knob).
46
+
47
+ ## Other supported knobs
48
+
49
+ - **Spacing** — override the `--space-2xs … --space-2xl` scale, or use a
50
+ preset: `data-density="compact"` / `data-density="comfortable"` on any
51
+ element (defaults to the middle scale).
52
+ - **Radius** — `--radius-sm … --radius-xl`, `--radius-pill`. The Nothing
53
+ default is near-sharp; raise these for a softer brand.
54
+ - **Type** — `--display` (dot-matrix face), `--mono`, `--sans`. Override
55
+ to drop Doto or swap the body face; the token layer keeps working even
56
+ if you self-host fonts (see the `fonts.css` note in the README).
57
+ - **Surfaces / lines / text** — the `--bg*`, `--panel*`, `--line*`,
58
+ `--text*` tokens are overridable for a bespoke palette, but you then
59
+ own their contrast. Prefer just `--accent` unless you need a full
60
+ re-skin.
61
+ - **Native controls** — checkbox/radio/range tick marks use the CSS
62
+ `accent-color: var(--accent)` (browser-rendered). The check glyph
63
+ colour is the UA's choice and not in our control, so a very light
64
+ `--accent` (e.g. a pale yellow) can make native checkmarks low-
65
+ contrast. If you re-brand to a light hue, verify native controls or
66
+ set `accent-color` yourself on them — this is the one accent surface
67
+ the framework can't tune for you.
68
+
69
+ ## Beyond accent: a full re-skin (the knob really works)
70
+
71
+ The "Nothing" look is the **default skin, not the architecture**. It is
72
+ a handful of token declarations deep — no selector hardcodes the
73
+ identity. An audit of `css/` found radius (every rounded element goes
74
+ through `var(--radius-*)`), the display face, dot density, motion easings
75
+ and the colour scale are *all* token-driven; the only hardcoded geometry
76
+ is the deliberate `border-radius: 0` on a few sharp elements and `50%` on
77
+ dots/avatars (correct to hardcode — they are circles, not skin).
78
+
79
+ The framework derives its accent **per theme** (the shipped red is
80
+ `#d71921` light / `#ff3b41` dark) precisely so each side stays
81
+ contrast-safe. A serious re-skin does the same — one override block,
82
+ no fork:
83
+
84
+ ```css
85
+ /* "Warm" — softer, rounder, no dot-matrix. Per-theme so the primary
86
+ button label stays AA on both sides (measured: see below). */
87
+ :root,
88
+ :root[data-theme='light'] {
89
+ --accent: #a8431a; /* terracotta — #fff label = 6.03:1 */
90
+ --radius-md: 10px; /* the system rounds everywhere at once */
91
+ --radius-lg: 14px;
92
+ --radius-xl: 20px;
93
+ --display: var(--sans); /* retire the Doto dot-matrix face */
94
+ --dot-size: 0; /* mute the decorative dot-grid motif */
95
+ }
96
+ :root[data-theme='dark'] {
97
+ --accent: #e8a06a; /* lighter warm — #000 label = 9.67:1 */
98
+ }
99
+ @media (prefers-color-scheme: dark) {
100
+ :root:not([data-theme='light']) { --accent: #e8a06a; }
101
+ }
102
+ ```
103
+
104
+ That changes buttons, cards, inputs, badges, focus rings, the display
105
+ type and the dot motif together, because every component consumes those
106
+ tokens — not because there is a per-component theme file. This is the
107
+ difference between a *system* and a *skin*: the skin is swappable, the
108
+ system (rationed colour, density, classless prose, minimal JS) is what
109
+ you are actually adopting.
110
+
111
+ Caveat, restated: a custom `--accent` is **your** contrast obligation —
112
+ the shipped palettes are CI-gated ([contrast.md](contrast.md)), a re-skin
113
+ is not. The values above are *measured* (white label on `#a8431a` =
114
+ 6.03:1, black on `#e8a06a` = 9.67:1, both ≥ 4.5:1 AA); pick your own with
115
+ the same check. Don't set one global `--accent` and hope — that is why
116
+ this example is split per theme.
117
+
118
+ ## Token tiers (0.3.1)
119
+
120
+ Three additive, non-breaking tiers sit on top of the primitives. The
121
+ short legacy names (`--panel`, `--line`, `--accent`, …) keep working
122
+ forever as aliases — the tiers are about giving consumers stabler,
123
+ coarser-grained handles.
124
+
125
+ - **Semantic tier — `--bronto-color-*`.** Role-named aliases:
126
+ `--bronto-color-surface`, `-surface-raised`, `-border`,
127
+ `-border-strong`, `-text`, `-text-muted`, `-action`, `-on-action`,
128
+ `-focus`, `-success`, `-warning`, `-danger`, `-bg`. Target these in
129
+ new consumer code: re-skinning a _role_ is now one override instead of
130
+ chasing component internals. They resolve through the per-theme
131
+ primitives, so light/dark still Just Works.
132
+ - **Accent ramp — `--accent-1 … --accent-6`.** A stepped family
133
+ (subtle → bold) derived from the single `--accent` knob via
134
+ `color-mix` against the theme background. Re-brands and theme-adapts
135
+ automatically. This is the palette for charts / data-viz / multi-state
136
+ surfaces (the use case the JS token export advertises).
137
+ - **Neutral ramp — `--surface-1 … --surface-6`** (low → high contrast
138
+ against `--bg`) for layered surfaces without hand-picking greys.
139
+ - **Stacking scale — `--z-base / -raised / -sticky / -overlay /
140
+ -popover / -toast`.** Every framework `z-index` now resolves through
141
+ these; override one to slot your app's own layers around the
142
+ framework's without specificity/`z-index` wars.
143
+
144
+ All four tiers are in the DTCG export and the JS token model.
145
+
146
+ ## Accessibility markup contracts
147
+
148
+ A few components are styled but need the consumer to author the right
149
+ semantics — the CSS can't add ARIA for you:
150
+
151
+ - **`.ui-switch`** — put `role="switch"` on the `<input type="checkbox">`.
152
+ It then announces "switch, on/off" and the native `checked` drives
153
+ `aria-checked` (no JS). Forced-colors state cues ship in `forms.css`.
154
+ - **`.ui-tab` / tabs** — operability requires `initTabs()`; don't
155
+ server-render panels `hidden` unless it's guaranteed to run (see the
156
+ `initTabs` doc comment).
157
+ - **`.ui-combobox`** — use `initCombobox()`; it owns the APG ARIA.
158
+ - **`.ui-tooltip`** — fine for short labels; for edge-critical or rich
159
+ content use `.ui-popover` + `initPopover()` (collision-aware).
160
+
161
+ > **Verify a rebrand:** open
162
+ > [`demo/theme-playground.html`](../demo/theme-playground.html) — paste
163
+ > your `--accent`, see the derived family and the computed WCAG ratios
164
+ > for `--accent-text` / `--accent` against the surface, and copy the CSS
165
+ > + DTCG override. This is the instrument for the "verify your hue"
166
+ > obligation below.
167
+
168
+ ## Contrast
169
+
170
+ - `data-contrast="high"` on any element, **and** the OS
171
+ `prefers-contrast: more` signal, collapse the soft greys toward the
172
+ strong end (hairlines → `--line-strong`, dim text → `--text-soft`,
173
+ solid focus ring). Theme-agnostic — they reference the per-theme
174
+ `*-strong` tokens, so they work under light and dark.
175
+ - Windows High Contrast / `forced-colors: active` is handled in
176
+ `base.css`: state that was signalled only by a fill (progress, status
177
+ dots, switch, segmented) is re-asserted with system colors.
178
+
179
+ ## Design-token interop (DTCG)
180
+
181
+ `@ponchia/ui/tokens.dtcg.json` is the token model in the W3C Design
182
+ Tokens Community Group format, for Style Dictionary / Figma / other
183
+ tooling. Generated from `tokens/index.js` and drift-checked by
184
+ `npm run check`. Resolvable primitives (the scale, `--accent`, literal
185
+ palette) carry real `$value`s; the CSS-runtime-derived family
186
+ (`accent-soft`, `focus-ring`, aliases) is spec-shaped with
187
+ `$value: null` + the CSS in `$extensions["com.ponchia.css"]` rather than
188
+ fabricating a number — the resolvable knob is `color.<theme>.accent`.
189
+
190
+ ## Reading tokens from JS
191
+
192
+ `@ponchia/ui/tokens` exposes the model as data. The ergonomic view only
193
+ strips the `--` prefix — **keys stay kebab-case**, so they must be
194
+ bracket-accessed: `themeColor('dark')['accent-soft']`, **not**
195
+ `.accentSoft`. (`themeColor('dark').accent` works only because `accent`
196
+ is a single word.) `--accent` and the non-derived colors resolve to
197
+ literal hex; the derived members (`accent-strong`, `accent-soft`,
198
+ `focus-ring`, …) are `color-mix(…)` / alias strings — resolve them in the
199
+ DOM via `getComputedStyle` if you need the final value, or just read/​set
200
+ `--accent` itself. The `.d.ts` now types these keys as literal unions
201
+ (`ColorKey`/`ScaleKey`), so a mistyped key is a compile error and
202
+ autocomplete lists the real names.
203
+
204
+ ## Stability
205
+
206
+ The token **names** and the `--accent` derivation are the contract and
207
+ are covered by `npm run check` (the `tokens.css ⇄ tokens/index.js ⇄
208
+ index.json` drift check). Token **values** may be tuned within a theme;
209
+ treat a value change as visual, a name/derivation change as breaking.
package/docs/usage.md ADDED
@@ -0,0 +1,113 @@
1
+ # Usage — when to reach for what
2
+
3
+ `docs/reference.md` is the *catalog* (every class, generated). This is
4
+ the *decision guide*: the rules a kitchen-sink demo can't tell you. It is
5
+ hand-written and stable — treated as contract like
6
+ [theming.md](theming.md), not auto-generated.
7
+
8
+ The one principle everything below follows:
9
+
10
+ > **Color is rationed. Structure carries meaning.** Reach for layout,
11
+ > type weight, and the hairline before reaching for a hue. The accent is
12
+ > a spotlight, not a paint bucket.
13
+
14
+ ## Density: the unset default and its two presets
15
+
16
+ `data-density` has two presets over an unset middle default. There is no
17
+ `data-density="default"` value — *unset* is the design target; you opt
18
+ into a preset on `<html>` or any subtree:
19
+
20
+ | Value | Use for |
21
+ | ---------------------- | ------------------------------------------------ |
22
+ | _(unset)_ | general app & content — the design target |
23
+ | `compact` | data-dense admin: tables, dashboards, toolbars |
24
+ | `comfortable` | marketing / landing / reading-first pages |
25
+
26
+ Scope it, don't globalize blindly: a dashboard with one marketing-style
27
+ hero can set `compact` on `<html>` and `comfortable` on the hero section.
28
+
29
+ ## Badge vs chip vs status dot
30
+
31
+ All three are small. They are **not** interchangeable:
32
+
33
+ | Use | When |
34
+ | -------------- | ----------------------------------------------------------------- |
35
+ | **status dot** | a single piece of state on something else (row online, build ok). Smallest possible signal; pair with text for a11y, never color-only. |
36
+ | **badge** | a label *classifying* the thing it sits on (count, tone, "BETA"). Static, not actionable. `ui.badge({ tone })`. |
37
+ | **chip** | a discrete, often removable/selectable token the user manipulated (a filter, a tag input value). Interactive affordance implied. |
38
+
39
+ Rule of thumb: state → dot, classification → badge, user-controlled value
40
+ → chip.
41
+
42
+ ## Numbers: `ui-num` vs the table state classes
43
+
44
+ - Inside `.ui-table`, a numeric cell is `.is-num` (+ `.is-pos` /
45
+ `.is-neg` for P&L tone). These are table-local `is-*` hooks, not in
46
+ `cls` by design.
47
+ - **Anywhere else** (a card, a stat, inline figures) use the `ui-num`
48
+ primitive — `ui.num({ tone })`. Same tabular/aligned/tone intent,
49
+ freed from the table. Do not hand-roll right-align + `text-green`;
50
+ that's the duplication `ui-num` exists to kill.
51
+
52
+ ## Prose vs primitives, and prose inside a card
53
+
54
+ - `ui-prose` styles **raw, unclassed semantic HTML** (MDX / CMS / LLM
55
+ output). Use it for *body content you don't control the markup of*.
56
+ - Do **not** wrap app UI in `ui-prose` to "get nice spacing" — compose
57
+ primitives instead; prose deliberately restyles bare `<h2>`, `<table>`,
58
+ `<a>` and will fight your components.
59
+ - Prose **inside a card**: put `ui-prose` on an inner wrapper, not on
60
+ `.ui-card` itself, so card padding/border stays the card's and prose
61
+ rhythm stays the content's. One responsibility per element.
62
+
63
+ ## Buttons: variant and size
64
+
65
+ - **primary** — the single most important action in a view. Aim for one.
66
+ - **ghost** — secondary actions; the default for "another button here".
67
+ - **subtle** — tertiary / low-stakes (toolbar, inline).
68
+ - Size: default everywhere; `--sm` for dense tooling (toolbars,
69
+ pagination, table row actions), `--lg` for a hero CTA only.
70
+ - Loading is **not** a class: set `aria-busy="true"` (+ `disabled`); the
71
+ spinner is CSS. This is the ARIA-driven contract — see reference.md
72
+ → "Composition & state".
73
+
74
+ ## Link vs link--cta
75
+
76
+ Plain `ui-link` for in-flow links. `ui-link--cta` is the eyebrow-faced
77
+ action link (accent · display · uppercase + arrow) — a *navigational
78
+ call to action*, not a substitute for a button (no form submit, no
79
+ destructive action).
80
+
81
+ ## Feedback: alert vs toast vs tooltip
82
+
83
+ | Surface | Lifetime / trigger |
84
+ | -------- | ----------------------------------------------------------- |
85
+ | alert / callout | persistent, in-flow, part of the page (form errors, page-level notice). |
86
+ | toast | transient, out-of-flow, system-initiated. Danger toasts route to an assertive live region; everything else polite. |
87
+ | tooltip | supplemental, hover/focus, never essential info (it's not announced reliably; don't hide required content in it). |
88
+
89
+ ## Modal: native `<dialog>` vs `is-open`
90
+
91
+ Prefer the **native `<dialog>`** path — you get top-layer, backdrop and
92
+ focus-trap free. Only use `ui-modal.is-open` (`ui.modal({ open: true })`)
93
+ when a portal/React modal genuinely can't be a `<dialog>`; then the
94
+ backdrop and focus-trap are **yours** to provide. A drawer is a modal
95
+ that enters from an edge — same rule.
96
+
97
+ ## When to add a behavior
98
+
99
+ The CSS is the framework; `@ponchia/ui/behaviors` is the *sanctioned*
100
+ home for the little JS that genuinely needs scripting (theme persistence,
101
+ disclosure, dialog glue, toast, combobox, form-validation, table-sort).
102
+ Reach for it instead of reimplementing — every initializer is SSR-safe,
103
+ idempotent, and returns a cleanup. If you find yourself writing focus
104
+ management or `aria-expanded` toggling by hand, there is probably already
105
+ a behavior for it.
106
+
107
+ ## Re-brand obligations (the short version)
108
+
109
+ Changing `--accent` is one declaration, but **contrast is then yours**:
110
+ the shipped palettes are gated (see [contrast.md](contrast.md)); your
111
+ custom accent is not. Verify primary-button label, `--accent-text`, and
112
+ the focus ring against their backgrounds. Full contract:
113
+ [theming.md](theming.md).
package/llms.txt ADDED
@@ -0,0 +1,91 @@
1
+ # @ponchia/ui
2
+
3
+ > CSS-first, framework-agnostic UI framework. Zero runtime dependencies.
4
+ > One `@layer bronto` cascade, a typed class vocabulary, design tokens as
5
+ > data, and optional SSR-safe vanilla behaviors. Nothing-inspired:
6
+ > monochrome surfaces, a single rationed accent, dot-matrix display type.
7
+ >
8
+ > This file orients an LLM/agent. The authoritative, always-correct API
9
+ > is the TypeScript declarations shipped in this package (paths below):
10
+ > they are generated from the runtime sources and CI-drift-checked, so
11
+ > they never lie. Read them before guessing class or token names.
12
+
13
+ ## Use the framework
14
+
15
+ CSS (pick one; do not import both):
16
+
17
+ ```css
18
+ @import '@ponchia/ui'; /* dist/bronto.css — flattened, minified, one file (recommended) */
19
+ @import '@ponchia/ui/css'; /* css/core.css — @import fan-out, needs a bundler */
20
+ ```
21
+
22
+ Everything lands in `@layer bronto`. Consumer styles in no layer (or a
23
+ later layer) always win over framework styles regardless of selector
24
+ specificity — this is the intended override mechanism; do not fight it
25
+ with `!important`.
26
+
27
+ Typed class vocabulary (returns plain strings — works in any framework):
28
+
29
+ ```js
30
+ import { cls, ui, cx } from '@ponchia/ui/classes';
31
+ // ui.button({ variant: 'ghost' }) -> "ui-button ui-button--ghost"
32
+ // cx(ui.dot({ tone: 'success' }), 'my-extra') -> joined, falsy-skipped
33
+ // cls is the frozen flat registry of every class the framework defines
34
+ ```
35
+
36
+ Tokens as data (theming + reading the palette):
37
+
38
+ ```js
39
+ import { cssVars, tokens, themeColor } from '@ponchia/ui/tokens';
40
+ ```
41
+
42
+ Optional vanilla behaviors (theme toggle, etc. — SSR-safe, tree-shakeable):
43
+
44
+ ```js
45
+ import { applyStoredTheme } from '@ponchia/ui/behaviors';
46
+ ```
47
+
48
+ ## Authoritative offline references (shipped in this package)
49
+
50
+ Read these from `node_modules/@ponchia/ui/` — no network needed:
51
+
52
+ - `classes/index.d.ts` — literal-typed `cls` map (exact class strings),
53
+ every `ui.*()` recipe signature, every `*Opts` interface. The complete
54
+ class surface; an agent should read this to know valid class names.
55
+ - `docs/reference.md` — the full class catalog as prose tables (every
56
+ class grouped by component, with registry key + kind). Generated from
57
+ the same source as the types and CI-drift-checked.
58
+ - `docs/theming.md` — the token contract: which tokens to override, the
59
+ light/dark model, and the rationed-accent rule.
60
+ - `docs/usage.md` — the decision guide: badge vs chip vs dot, default
61
+ density, prose-in-card, when to add a behavior. Read this before
62
+ re-implementing UI the framework already has an opinion about.
63
+ - `docs/contrast.md` — the published, CI-gated WCAG 2.1 contrast matrix
64
+ for every contractual token pairing, per theme. Generated from the
65
+ resolved palette; the build fails below the declared floor.
66
+ - `tokens/index.d.ts` — every design-token name as a literal union.
67
+ - `tokens/index.json` — tokens as plain data (global / light / dark).
68
+ - `tokens/tokens.dtcg.json` — same tokens in W3C DTCG format.
69
+ - `tokens/resolved.json` — every colour token resolved to a static
70
+ `#rrggbb` / `rgba(...)` per theme (var() + color-mix() evaluated).
71
+ Use this for non-CSS render targets: MapLibre/canvas/WebGL/SVG.
72
+ - `behaviors/index.d.ts` — typed signatures for the optional behaviors.
73
+ - `classes/vscode.css-custom-data.json` — editor autocomplete for tokens.
74
+
75
+ ## Human-browsable references (not shipped in the npm tarball, by design)
76
+
77
+ - Live kitchen-sink demo (every component, light/dark, RTL): https://ponchia.github.io/bronto-ui/
78
+ - Architecture & the CSS-first decision: https://github.com/Ponchia/bronto-ui/blob/main/docs/architecture.md
79
+ - Framework integration guides (Astro / SvelteKit / React-Solid / vanilla):
80
+ https://github.com/Ponchia/bronto-ui/tree/main/docs/getting-started
81
+
82
+ ## Rules an agent should respect
83
+
84
+ - Never invent `ui-*` class names. Every valid class is a member of
85
+ `cls` in `classes/index.d.ts`; if it is not there, it does not exist.
86
+ - Prefer the `ui.*()` recipes over hand-concatenating modifier strings.
87
+ - Override framework styles by writing your own rules outside
88
+ `@layer bronto` — not with higher specificity or `!important`.
89
+ - The accent color is deliberately rationed (monochrome + one accent).
90
+ Do not introduce new hues; theme via the documented tokens only.
91
+ - Pre-1.0 SemVer: breaking changes ship in the *minor*. Pin `~0.x`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ponchia/ui",
3
- "version": "0.3.2",
3
+ "version": "0.3.4",
4
4
  "type": "module",
5
5
  "description": "Shared Bronto UI framework — Nothing-inspired monochrome CSS theme, dot-matrix motifs, admin shell.",
6
6
  "license": "MIT",
@@ -24,7 +24,12 @@
24
24
  "tokens",
25
25
  "classes",
26
26
  "behaviors",
27
- "shiki"
27
+ "shiki",
28
+ "llms.txt",
29
+ "docs/reference.md",
30
+ "docs/theming.md",
31
+ "docs/contrast.md",
32
+ "docs/usage.md"
28
33
  ],
29
34
  "style": "./dist/bronto.css",
30
35
  "scripts": {
@@ -34,8 +39,10 @@
34
39
  "check:format": "prettier --check .",
35
40
  "tokens:build": "node scripts/gen-tokens-json.mjs",
36
41
  "dtcg:build": "node scripts/gen-dtcg.mjs",
42
+ "resolved:build": "node scripts/gen-resolved.mjs",
37
43
  "dts:build": "node scripts/gen-dts.mjs",
38
44
  "reference:build": "node scripts/gen-reference.mjs",
45
+ "contrast:build": "node scripts/gen-contrast.mjs",
39
46
  "vscode:build": "node scripts/gen-vscode-data.mjs",
40
47
  "dist:build": "node scripts/build-dist.mjs",
41
48
  "check:exports": "node scripts/check-exports.mjs",
@@ -44,15 +51,17 @@
44
51
  "check:dts": "node scripts/check-dts.mjs",
45
52
  "check:types": "tsc -p tsconfig.json",
46
53
  "check:dtcg": "node scripts/check-dtcg.mjs",
54
+ "check:resolved": "node scripts/check-resolved.mjs",
47
55
  "check:shiki": "node scripts/check-shiki.mjs",
48
56
  "check:dist": "node scripts/check-dist.mjs",
49
57
  "check:pack": "node scripts/check-pack.mjs",
50
58
  "check:release": "node scripts/check-release.mjs",
51
59
  "check:reference": "node scripts/check-reference.mjs",
60
+ "check:contrast": "node scripts/check-contrast.mjs",
52
61
  "check:vscode": "node scripts/check-vscode-data.mjs",
53
- "check": "npm run lint && npm run check:format && npm run check:exports && npm run check:tokens && npm run check:classes && npm run check:dts && npm run check:types && npm run check:dtcg && npm run check:shiki && npm run check:dist && npm run check:pack && npm run check:release && npm run check:reference && npm run check:vscode",
62
+ "check": "npm run lint && npm run check:format && npm run check:exports && npm run check:tokens && npm run check:classes && npm run check:dts && npm run check:types && npm run check:dtcg && npm run check:resolved && npm run check:shiki && npm run check:dist && npm run check:pack && npm run check:release && npm run check:reference && npm run check:contrast && npm run check:vscode",
54
63
  "test": "node --test \"test/*.test.mjs\"",
55
- "prepack": "npm run tokens:build && npm run dtcg:build && npm run dts:build && npm run reference:build && npm run vscode:build && npm run dist:build",
64
+ "prepack": "npm run tokens:build && npm run dtcg:build && npm run resolved:build && npm run dts:build && npm run reference:build && npm run contrast:build && npm run vscode:build && npm run dist:build",
56
65
  "prepublishOnly": "npm run check && npm test"
57
66
  },
58
67
  "devDependencies": {
@@ -110,7 +119,13 @@
110
119
  "./vscode.css-custom-data.json": "./classes/vscode.css-custom-data.json",
111
120
  "./tokens.json": "./tokens/index.json",
112
121
  "./tokens.dtcg.json": "./tokens/tokens.dtcg.json",
122
+ "./tokens/resolved.json": "./tokens/resolved.json",
113
123
  "./shiki/nothing.json": "./shiki/nothing.json",
124
+ "./llms.txt": "./llms.txt",
125
+ "./docs/reference.md": "./docs/reference.md",
126
+ "./docs/theming.md": "./docs/theming.md",
127
+ "./docs/contrast.md": "./docs/contrast.md",
128
+ "./docs/usage.md": "./docs/usage.md",
114
129
  "./classes": {
115
130
  "types": "./classes/index.d.ts",
116
131
  "default": "./classes/index.js"
package/tokens/index.d.ts CHANGED
@@ -3,9 +3,9 @@
3
3
 
4
4
  export type ThemeName = 'light' | 'dark';
5
5
 
6
- export type GlobalTokenName = '--radius-xl' | '--radius-lg' | '--radius-md' | '--radius-sm' | '--radius-pill' | '--space-2xs' | '--space-xs' | '--space-sm' | '--space-md' | '--space-lg' | '--space-xl' | '--space-2xl' | '--mono' | '--sans' | '--display' | '--dot-font' | '--text-2xs' | '--text-xs' | '--text-sm' | '--text-base' | '--text-lg' | '--text-xl' | '--tracking-wide' | '--tracking-wider' | '--ease-standard' | '--ease-spring' | '--ease-out' | '--duration-fast' | '--duration-base' | '--duration-slow' | '--dot-size' | '--dot-gap' | '--z-base' | '--z-raised' | '--z-sticky' | '--z-overlay' | '--z-popover' | '--z-toast' | '--accent-1' | '--accent-2' | '--accent-3' | '--accent-4' | '--accent-5' | '--accent-6' | '--surface-1' | '--surface-2' | '--surface-3' | '--surface-4' | '--surface-5' | '--surface-6' | '--bronto-color-bg' | '--bronto-color-surface' | '--bronto-color-surface-raised' | '--bronto-color-border' | '--bronto-color-border-strong' | '--bronto-color-text' | '--bronto-color-text-muted' | '--bronto-color-action' | '--bronto-color-on-action' | '--bronto-color-focus' | '--bronto-color-success' | '--bronto-color-warning' | '--bronto-color-danger' | '--surface' | '--surface-raised' | '--surface-muted' | '--border' | '--border-strong';
7
- export type LightTokenName = '--bg' | '--bg-elevated' | '--bg-accent' | '--panel' | '--panel-strong' | '--panel-soft' | '--line' | '--line-strong' | '--text' | '--text-soft' | '--text-dim' | '--accent' | '--accent-strong' | '--accent-text' | '--accent-soft' | '--success' | '--success-soft' | '--warning' | '--warning-soft' | '--orange' | '--orange-soft' | '--danger' | '--danger-soft' | '--code-bg' | '--button-text' | '--field-dot' | '--field-dot-hot' | '--field-dot-accent' | '--focus-ring' | '--shadow' | '--shadow-raised';
8
- export type DarkTokenName = '--bg' | '--bg-elevated' | '--bg-accent' | '--panel' | '--panel-strong' | '--panel-soft' | '--line' | '--line-strong' | '--text' | '--text-soft' | '--text-dim' | '--accent' | '--accent-strong' | '--accent-text' | '--accent-soft' | '--success' | '--success-soft' | '--warning' | '--warning-soft' | '--orange' | '--orange-soft' | '--danger' | '--danger-soft' | '--code-bg' | '--button-text' | '--field-dot' | '--field-dot-hot' | '--field-dot-accent' | '--focus-ring' | '--shadow' | '--shadow-raised';
6
+ export type GlobalTokenName = '--radius-xl' | '--radius-lg' | '--radius-md' | '--radius-sm' | '--radius-pill' | '--space-2xs' | '--space-xs' | '--space-sm' | '--space-md' | '--space-lg' | '--space-xl' | '--space-2xl' | '--mono' | '--sans' | '--dot-font' | '--display' | '--text-2xs' | '--text-xs' | '--text-sm' | '--text-base' | '--text-lg' | '--text-xl' | '--tracking-wide' | '--tracking-wider' | '--ease-standard' | '--ease-spring' | '--ease-out' | '--duration-fast' | '--duration-base' | '--duration-slow' | '--dot-size' | '--dot-gap' | '--z-base' | '--z-raised' | '--z-sticky' | '--z-overlay' | '--z-popover' | '--z-toast' | '--accent-1' | '--accent-2' | '--accent-3' | '--accent-4' | '--accent-5' | '--accent-6' | '--surface-1' | '--surface-2' | '--surface-3' | '--surface-4' | '--surface-5' | '--surface-6' | '--bronto-color-bg' | '--bronto-color-surface' | '--bronto-color-surface-raised' | '--bronto-color-border' | '--bronto-color-border-strong' | '--bronto-color-text' | '--bronto-color-text-muted' | '--bronto-color-action' | '--bronto-color-on-action' | '--bronto-color-focus' | '--bronto-color-success' | '--bronto-color-warning' | '--bronto-color-danger' | '--bronto-color-info' | '--surface' | '--surface-raised' | '--surface-muted' | '--border' | '--border-strong';
7
+ export type LightTokenName = '--bg' | '--bg-elevated' | '--bg-accent' | '--panel' | '--panel-strong' | '--panel-soft' | '--line' | '--line-strong' | '--text' | '--text-soft' | '--text-dim' | '--accent' | '--accent-strong' | '--accent-text' | '--accent-soft' | '--success' | '--success-soft' | '--warning' | '--warning-soft' | '--orange' | '--orange-soft' | '--danger' | '--danger-soft' | '--info' | '--info-soft' | '--code-bg' | '--button-text' | '--field-dot' | '--field-dot-hot' | '--field-dot-accent' | '--focus-ring' | '--shadow' | '--shadow-raised';
8
+ export type DarkTokenName = '--bg' | '--bg-elevated' | '--bg-accent' | '--panel' | '--panel-strong' | '--panel-soft' | '--line' | '--line-strong' | '--text' | '--text-soft' | '--text-dim' | '--accent' | '--accent-strong' | '--accent-text' | '--accent-soft' | '--success' | '--success-soft' | '--warning' | '--warning-soft' | '--orange' | '--orange-soft' | '--danger' | '--danger-soft' | '--info' | '--info-soft' | '--code-bg' | '--button-text' | '--field-dot' | '--field-dot-hot' | '--field-dot-accent' | '--focus-ring' | '--shadow' | '--shadow-raised';
9
9
 
10
10
  /** Exact mirror of the :root blocks in css/tokens.css (literal keys). */
11
11
  export declare const cssVars: {
@@ -14,8 +14,8 @@ export declare const cssVars: {
14
14
  dark: Record<DarkTokenName, string>;
15
15
  };
16
16
 
17
- export type ScaleKey = 'radius-xl' | 'radius-lg' | 'radius-md' | 'radius-sm' | 'radius-pill' | 'space-2xs' | 'space-xs' | 'space-sm' | 'space-md' | 'space-lg' | 'space-xl' | 'space-2xl' | 'mono' | 'sans' | 'display' | 'dot-font' | 'text-2xs' | 'text-xs' | 'text-sm' | 'text-base' | 'text-lg' | 'text-xl' | 'tracking-wide' | 'tracking-wider' | 'ease-standard' | 'ease-spring' | 'ease-out' | 'duration-fast' | 'duration-base' | 'duration-slow' | 'dot-size' | 'dot-gap' | 'z-base' | 'z-raised' | 'z-sticky' | 'z-overlay' | 'z-popover' | 'z-toast' | 'accent-1' | 'accent-2' | 'accent-3' | 'accent-4' | 'accent-5' | 'accent-6' | 'surface-1' | 'surface-2' | 'surface-3' | 'surface-4' | 'surface-5' | 'surface-6' | 'bronto-color-bg' | 'bronto-color-surface' | 'bronto-color-surface-raised' | 'bronto-color-border' | 'bronto-color-border-strong' | 'bronto-color-text' | 'bronto-color-text-muted' | 'bronto-color-action' | 'bronto-color-on-action' | 'bronto-color-focus' | 'bronto-color-success' | 'bronto-color-warning' | 'bronto-color-danger' | 'surface' | 'surface-raised' | 'surface-muted' | 'border' | 'border-strong';
18
- export type ColorKey = 'bg' | 'bg-elevated' | 'bg-accent' | 'panel' | 'panel-strong' | 'panel-soft' | 'line' | 'line-strong' | 'text' | 'text-soft' | 'text-dim' | 'accent' | 'accent-strong' | 'accent-text' | 'accent-soft' | 'success' | 'success-soft' | 'warning' | 'warning-soft' | 'orange' | 'orange-soft' | 'danger' | 'danger-soft' | 'code-bg' | 'button-text' | 'field-dot' | 'field-dot-hot' | 'field-dot-accent' | 'focus-ring' | 'shadow' | 'shadow-raised';
17
+ export type ScaleKey = 'radius-xl' | 'radius-lg' | 'radius-md' | 'radius-sm' | 'radius-pill' | 'space-2xs' | 'space-xs' | 'space-sm' | 'space-md' | 'space-lg' | 'space-xl' | 'space-2xl' | 'mono' | 'sans' | 'dot-font' | 'display' | 'text-2xs' | 'text-xs' | 'text-sm' | 'text-base' | 'text-lg' | 'text-xl' | 'tracking-wide' | 'tracking-wider' | 'ease-standard' | 'ease-spring' | 'ease-out' | 'duration-fast' | 'duration-base' | 'duration-slow' | 'dot-size' | 'dot-gap' | 'z-base' | 'z-raised' | 'z-sticky' | 'z-overlay' | 'z-popover' | 'z-toast' | 'accent-1' | 'accent-2' | 'accent-3' | 'accent-4' | 'accent-5' | 'accent-6' | 'surface-1' | 'surface-2' | 'surface-3' | 'surface-4' | 'surface-5' | 'surface-6' | 'bronto-color-bg' | 'bronto-color-surface' | 'bronto-color-surface-raised' | 'bronto-color-border' | 'bronto-color-border-strong' | 'bronto-color-text' | 'bronto-color-text-muted' | 'bronto-color-action' | 'bronto-color-on-action' | 'bronto-color-focus' | 'bronto-color-success' | 'bronto-color-warning' | 'bronto-color-danger' | 'bronto-color-info' | 'surface' | 'surface-raised' | 'surface-muted' | 'border' | 'border-strong';
18
+ export type ColorKey = 'bg' | 'bg-elevated' | 'bg-accent' | 'panel' | 'panel-strong' | 'panel-soft' | 'line' | 'line-strong' | 'text' | 'text-soft' | 'text-dim' | 'accent' | 'accent-strong' | 'accent-text' | 'accent-soft' | 'success' | 'success-soft' | 'warning' | 'warning-soft' | 'orange' | 'orange-soft' | 'danger' | 'danger-soft' | 'info' | 'info-soft' | 'code-bg' | 'button-text' | 'field-dot' | 'field-dot-hot' | 'field-dot-accent' | 'focus-ring' | 'shadow' | 'shadow-raised';
19
19
 
20
20
  /** Ergonomic view derived from {@link cssVars} (`--` prefix stripped). */
21
21
  export declare const tokens: {
package/tokens/index.js CHANGED
@@ -32,8 +32,8 @@ export const cssVars = {
32
32
  '--mono': "'JetBrains Mono', 'Fira Code', 'Cascadia Code', 'SF Mono', ui-monospace, monospace",
33
33
  '--sans':
34
34
  "'Inter', 'SF Pro Text', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif",
35
- '--display': "'Doto', var(--mono)",
36
35
  '--dot-font': "'Doto', var(--mono)",
36
+ '--display': 'var(--dot-font)',
37
37
  '--text-2xs': '0.68rem',
38
38
  '--text-xs': '0.76rem',
39
39
  '--text-sm': '0.86rem',
@@ -81,6 +81,7 @@ export const cssVars = {
81
81
  '--bronto-color-success': 'var(--success)',
82
82
  '--bronto-color-warning': 'var(--warning)',
83
83
  '--bronto-color-danger': 'var(--danger)',
84
+ '--bronto-color-info': 'var(--info)',
84
85
  '--surface': 'var(--panel)',
85
86
  '--surface-raised': 'var(--panel-strong)',
86
87
  '--surface-muted': 'var(--panel-soft)',
@@ -112,6 +113,8 @@ export const cssVars = {
112
113
  '--orange-soft': 'rgb(168, 95, 50, 0.13)',
113
114
  '--danger': '#c01622',
114
115
  '--danger-soft': 'rgb(192, 22, 34, 0.1)',
116
+ '--info': '#1f63c4',
117
+ '--info-soft': 'rgb(31, 99, 196, 0.12)',
115
118
  '--code-bg': 'rgb(10, 10, 10, 0.05)',
116
119
  '--button-text': '#ffffff',
117
120
  '--field-dot': 'rgb(10, 10, 10, 0.16)',
@@ -146,6 +149,8 @@ export const cssVars = {
146
149
  '--orange-soft': 'rgb(208, 140, 91, 0.15)',
147
150
  '--danger': '#ff4d54',
148
151
  '--danger-soft': 'rgb(255, 77, 84, 0.15)',
152
+ '--info': '#6fb0e6',
153
+ '--info-soft': 'rgb(111, 176, 230, 0.14)',
149
154
  '--code-bg': 'rgb(255, 255, 255, 0.05)',
150
155
  '--button-text': '#000000',
151
156
  '--field-dot': 'rgb(242, 242, 242, 0.14)',
package/tokens/index.json CHANGED
@@ -15,8 +15,8 @@
15
15
  "--space-2xl": "2.5rem",
16
16
  "--mono": "'JetBrains Mono', 'Fira Code', 'Cascadia Code', 'SF Mono', ui-monospace, monospace",
17
17
  "--sans": "'Inter', 'SF Pro Text', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif",
18
- "--display": "'Doto', var(--mono)",
19
18
  "--dot-font": "'Doto', var(--mono)",
19
+ "--display": "var(--dot-font)",
20
20
  "--text-2xs": "0.68rem",
21
21
  "--text-xs": "0.76rem",
22
22
  "--text-sm": "0.86rem",
@@ -64,6 +64,7 @@
64
64
  "--bronto-color-success": "var(--success)",
65
65
  "--bronto-color-warning": "var(--warning)",
66
66
  "--bronto-color-danger": "var(--danger)",
67
+ "--bronto-color-info": "var(--info)",
67
68
  "--surface": "var(--panel)",
68
69
  "--surface-raised": "var(--panel-strong)",
69
70
  "--surface-muted": "var(--panel-soft)",
@@ -94,6 +95,8 @@
94
95
  "--orange-soft": "rgb(168, 95, 50, 0.13)",
95
96
  "--danger": "#c01622",
96
97
  "--danger-soft": "rgb(192, 22, 34, 0.1)",
98
+ "--info": "#1f63c4",
99
+ "--info-soft": "rgb(31, 99, 196, 0.12)",
97
100
  "--code-bg": "rgb(10, 10, 10, 0.05)",
98
101
  "--button-text": "#ffffff",
99
102
  "--field-dot": "rgb(10, 10, 10, 0.16)",
@@ -127,6 +130,8 @@
127
130
  "--orange-soft": "rgb(208, 140, 91, 0.15)",
128
131
  "--danger": "#ff4d54",
129
132
  "--danger-soft": "rgb(255, 77, 84, 0.15)",
133
+ "--info": "#6fb0e6",
134
+ "--info-soft": "rgb(111, 176, 230, 0.14)",
130
135
  "--code-bg": "rgb(255, 255, 255, 0.05)",
131
136
  "--button-text": "#000000",
132
137
  "--field-dot": "rgb(242, 242, 242, 0.14)",
@@ -153,8 +158,8 @@
153
158
  "space-2xl": "2.5rem",
154
159
  "mono": "'JetBrains Mono', 'Fira Code', 'Cascadia Code', 'SF Mono', ui-monospace, monospace",
155
160
  "sans": "'Inter', 'SF Pro Text', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif",
156
- "display": "'Doto', var(--mono)",
157
161
  "dot-font": "'Doto', var(--mono)",
162
+ "display": "var(--dot-font)",
158
163
  "text-2xs": "0.68rem",
159
164
  "text-xs": "0.76rem",
160
165
  "text-sm": "0.86rem",
@@ -202,6 +207,7 @@
202
207
  "bronto-color-success": "var(--success)",
203
208
  "bronto-color-warning": "var(--warning)",
204
209
  "bronto-color-danger": "var(--danger)",
210
+ "bronto-color-info": "var(--info)",
205
211
  "surface": "var(--panel)",
206
212
  "surface-raised": "var(--panel-strong)",
207
213
  "surface-muted": "var(--panel-soft)",
@@ -233,6 +239,8 @@
233
239
  "orange-soft": "rgb(168, 95, 50, 0.13)",
234
240
  "danger": "#c01622",
235
241
  "danger-soft": "rgb(192, 22, 34, 0.1)",
242
+ "info": "#1f63c4",
243
+ "info-soft": "rgb(31, 99, 196, 0.12)",
236
244
  "code-bg": "rgb(10, 10, 10, 0.05)",
237
245
  "button-text": "#ffffff",
238
246
  "field-dot": "rgb(10, 10, 10, 0.16)",
@@ -266,6 +274,8 @@
266
274
  "orange-soft": "rgb(208, 140, 91, 0.15)",
267
275
  "danger": "#ff4d54",
268
276
  "danger-soft": "rgb(255, 77, 84, 0.15)",
277
+ "info": "#6fb0e6",
278
+ "info-soft": "rgb(111, 176, 230, 0.14)",
269
279
  "code-bg": "rgb(255, 255, 255, 0.05)",
270
280
  "button-text": "#000000",
271
281
  "field-dot": "rgb(242, 242, 242, 0.14)",