@tenphi/tasty 0.0.0-snapshot.256c7b2 → 0.0.0-snapshot.265bb7f
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 +408 -385
- package/dist/babel-types-BKDTT4--.d.ts +18 -0
- package/dist/chunks/async-storage-f9j9JRtq.js +37 -0
- package/dist/chunks/async-storage-f9j9JRtq.js.map +1 -0
- package/dist/chunks/build-config-BZMGNb_I.js +60 -0
- package/dist/chunks/build-config-BZMGNb_I.js.map +1 -0
- package/dist/{collector-B3OsM252.js → chunks/collector-CPiziP8g.js} +10 -127
- package/dist/chunks/collector-CPiziP8g.js.map +1 -0
- package/dist/chunks/config-engine-WjJNcZ-C.js +272 -0
- package/dist/chunks/config-engine-WjJNcZ-C.js.map +1 -0
- package/dist/chunks/config-file-DlZXJMj8.js +25 -0
- package/dist/chunks/config-file-DlZXJMj8.js.map +1 -0
- package/dist/chunks/css-definitions-BmiT9P4x.js +910 -0
- package/dist/chunks/css-definitions-BmiT9P4x.js.map +1 -0
- package/dist/{css-resources-Cyl_axbI.js → chunks/css-resources-P7IBUUZs.js} +2 -9
- package/dist/chunks/css-resources-P7IBUUZs.js.map +1 -0
- package/dist/chunks/debug-B2zJjf2X.js +502 -0
- package/dist/chunks/debug-B2zJjf2X.js.map +1 -0
- package/dist/chunks/dsl-BKtRQR_O.js +1399 -0
- package/dist/chunks/dsl-BKtRQR_O.js.map +1 -0
- package/dist/chunks/hydration-TRcz5vnk.js +41 -0
- package/dist/chunks/hydration-TRcz5vnk.js.map +1 -0
- package/dist/chunks/react-runtime-B5Xn6hwM.js +689 -0
- package/dist/chunks/react-runtime-B5Xn6hwM.js.map +1 -0
- package/dist/chunks/runtime-engine-fT0CiDZU.js +2432 -0
- package/dist/chunks/runtime-engine-fT0CiDZU.js.map +1 -0
- package/dist/chunks/runtime-state-D-UAVby0.js +152 -0
- package/dist/chunks/runtime-state-D-UAVby0.js.map +1 -0
- package/dist/{merge-styles-DuoZEsm9.js → chunks/shared-utils-y-HjvPN4.js} +60 -55
- package/dist/chunks/shared-utils-y-HjvPN4.js.map +1 -0
- package/dist/chunks/style-engine-CguKjOki.js +5576 -0
- package/dist/chunks/style-engine-CguKjOki.js.map +1 -0
- package/dist/{css-writer-Bgowobbx.js → chunks/zero-engine-CP7TnjOl.js} +65 -145
- package/dist/chunks/zero-engine-CP7TnjOl.js.map +1 -0
- package/dist/{collector-BTVXj2hS.d.ts → collector-CTU-nl0g.d.ts} +6 -5
- package/dist/{config-LfIDmVHx.d.ts → config-CcxqSZI2.d.ts} +45 -40
- package/dist/core/index.d.ts +5 -5
- package/dist/core/index.js +9 -6
- package/dist/hydrate-CRyjjAyl.d.ts +22 -0
- package/dist/{index-Bm9ltvdH.d.ts → index-C5hbbo0t.d.ts} +272 -243
- package/dist/index.d.ts +5 -5
- package/dist/index.js +11 -922
- package/dist/{merge-styles-BcLl1u_d.d.ts → merge-styles-DSkVc6CD.d.ts} +2 -3
- package/dist/ssr/astro-client.d.ts +1 -1
- package/dist/ssr/astro-client.js +1 -14
- package/dist/ssr/astro-client.js.map +1 -1
- package/dist/ssr/astro-middleware-extract-static.d.ts +1 -2
- package/dist/ssr/astro-middleware-extract-static.js +1 -1
- package/dist/ssr/astro-middleware-extract.d.ts +1 -2
- package/dist/ssr/astro-middleware-extract.js +1 -1
- package/dist/ssr/astro-middleware-static.d.ts +1 -2
- package/dist/ssr/astro-middleware-static.js +1 -12
- package/dist/ssr/astro-middleware-static.js.map +1 -1
- package/dist/ssr/astro-middleware.d.ts +1 -2
- package/dist/ssr/astro-middleware.js +1 -13
- package/dist/ssr/astro-middleware.js.map +1 -1
- package/dist/ssr/astro.d.ts +8 -16
- package/dist/ssr/astro.js +220 -1
- package/dist/ssr/astro.js.map +1 -0
- package/dist/ssr/client.d.ts +2 -0
- package/dist/ssr/client.js +2 -0
- package/dist/ssr/index.d.ts +5 -25
- package/dist/ssr/index.js +5 -5
- package/dist/ssr/index.js.map +1 -1
- package/dist/ssr/next-config.d.ts +3 -5
- package/dist/ssr/next-config.js +47 -28
- package/dist/ssr/next-config.js.map +1 -1
- package/dist/ssr/next.d.ts +3 -9
- package/dist/ssr/next.js +7 -38
- package/dist/ssr/next.js.map +1 -1
- package/dist/static/index.d.ts +8 -9
- package/dist/static/index.js +4 -22
- package/dist/static/index.js.map +1 -1
- package/dist/static/inject.d.ts +1 -2
- package/dist/{index-BmogEzTo.d.ts → types-DJEM_BOJ.d.ts} +852 -860
- package/dist/zero/babel.d.ts +67 -2
- package/dist/zero/babel.js +77 -140
- package/dist/zero/babel.js.map +1 -1
- package/dist/zero/index.d.ts +63 -8
- package/dist/zero/index.js +25 -2
- package/dist/zero/index.js.map +1 -0
- package/dist/zero/next.d.ts +4 -5
- package/dist/zero/next.js +3 -38
- package/dist/zero/next.js.map +1 -1
- package/docs/README.md +4 -1
- package/docs/adoption.md +25 -17
- package/docs/ai-agents.md +67 -33
- package/docs/comparison.md +9 -8
- package/docs/configuration.md +192 -60
- package/docs/debug.md +18 -7
- package/docs/design-system.md +117 -15
- package/docs/dsl.md +235 -82
- package/docs/getting-started.md +81 -22
- package/docs/injector.md +41 -40
- package/docs/methodology.md +48 -23
- package/docs/migration-v3.md +3 -3
- package/docs/pipeline.md +54 -27
- package/docs/plugins.md +22 -42
- package/docs/react-api.md +74 -9
- package/docs/runtime-benchmarks.md +257 -47
- package/docs/ssr.md +93 -67
- package/docs/styles.md +121 -31
- package/docs/tasty-static.md +174 -58
- package/package.json +98 -37
- package/dist/astro-CeYENy2x.js +0 -301
- package/dist/astro-CeYENy2x.js.map +0 -1
- package/dist/async-storage-DKK-wTD4.js +0 -44
- package/dist/async-storage-DKK-wTD4.js.map +0 -1
- package/dist/babel-DWCsafYw.d.ts +0 -83
- package/dist/collector-B3OsM252.js.map +0 -1
- package/dist/config-B3gPdCqd.js +0 -12421
- package/dist/config-B3gPdCqd.js.map +0 -1
- package/dist/context-CA8YKeMn.js +0 -24
- package/dist/context-CA8YKeMn.js.map +0 -1
- package/dist/core-Cj3UViUi.js +0 -1687
- package/dist/core-Cj3UViUi.js.map +0 -1
- package/dist/css-resources-Cyl_axbI.js.map +0 -1
- package/dist/css-writer-Bgowobbx.js.map +0 -1
- package/dist/format-global-rules-DklyaXv-.js +0 -22
- package/dist/format-global-rules-DklyaXv-.js.map +0 -1
- package/dist/format-rules-XRw9u7d4.js +0 -104
- package/dist/format-rules-XRw9u7d4.js.map +0 -1
- package/dist/hydrate-CNOmZprz.js +0 -37
- package/dist/hydrate-CNOmZprz.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/keyframes-DE-OE76F.js +0 -535
- package/dist/keyframes-DE-OE76F.js.map +0 -1
- package/dist/merge-styles-DuoZEsm9.js.map +0 -1
- package/dist/resolve-recipes-H9NqOQuP.js +0 -144
- package/dist/resolve-recipes-H9NqOQuP.js.map +0 -1
- package/dist/ssr-collector-ref-COs_ioWl.js +0 -29
- package/dist/ssr-collector-ref-COs_ioWl.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="assets/tasty.svg" width="128" height="128" alt="Tasty logo"
|
|
2
|
+
<img src="assets/tasty.svg" width="128" height="128" alt="Tasty logo" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">Tasty</h1>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>CSS-in-JS for React design systems.</strong><br
|
|
8
|
+
<strong>CSS-in-JS for React design systems.</strong><br />
|
|
9
9
|
Build components whose styles don’t fight.
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
13
|
-
<a href="https://www.npmjs.com/package/@tenphi/tasty"><img src="https://img.shields.io/npm/v/@tenphi/tasty.svg" alt="npm version"
|
|
14
|
-
<a href="https://github.com/tenphi/tasty/actions/workflows/ci.yml"><img src="https://github.com/tenphi/tasty/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"
|
|
15
|
-
<a href="https://github.com/tenphi/tasty/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tenphi/tasty" alt="license"
|
|
13
|
+
<a href="https://www.npmjs.com/package/@tenphi/tasty"><img src="https://img.shields.io/npm/v/@tenphi/tasty.svg" alt="npm version" /></a>
|
|
14
|
+
<a href="https://github.com/tenphi/tasty/actions/workflows/ci.yml"><img src="https://github.com/tenphi/tasty/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
|
|
15
|
+
<a href="https://github.com/tenphi/tasty/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tenphi/tasty" alt="license" /></a>
|
|
16
16
|
</p>
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Tasty is a styling engine for teams that build component libraries. You describe hover, disabled, variants, themes, and breakpoints as **state maps**, in a CSS-like language built from your design system's own tokens and conventions. Tasty compiles each map into selectors that never match at the same time, so the result never depends on specificity or source order.
|
|
21
21
|
|
|
22
22
|
```tsx
|
|
23
23
|
import { tasty } from '@tenphi/tasty';
|
|
@@ -35,39 +35,20 @@ const Button = tasty({
|
|
|
35
35
|
});
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Later
|
|
39
|
-
|
|
40
|
-
That is the core promise: add states, variants, themes, and overrides without reopening selector logic by hand.
|
|
41
|
-
|
|
42
|
-
Tasty fits best when you are building a design system or component library whose components need to stay predictable as their state logic grows. Alongside state maps, it provides a CSS-like DSL, typed style props, tokens, recipes, sub-elements, and client-side, server-only, or build-time CSS delivery.
|
|
38
|
+
Later keys have higher priority. If this button is both hovered and disabled, `[disabled]` wins and the hover rule does not apply. That decision is compiled into the selectors themselves, so you can add states, variants, themes, and overrides without reopening selector logic by hand.
|
|
43
39
|
|
|
44
40
|
- **Ready to try it?** Follow [Getting Started](docs/getting-started.md).
|
|
45
41
|
- **Evaluating fit?** Read [Comparison](docs/comparison.md) and the [Adoption Guide](docs/adoption.md).
|
|
46
|
-
- **Want the compiler model?** Jump to [How It Actually Works](#how-it-actually-works).
|
|
47
42
|
- **Building a component library?** See [Methodology](docs/methodology.md) and [Building a Design System](docs/design-system.md).
|
|
48
43
|
|
|
49
44
|
## Why Tasty
|
|
50
45
|
|
|
51
|
-
- **States that
|
|
52
|
-
- **
|
|
53
|
-
- **
|
|
54
|
-
- **
|
|
55
|
-
- **
|
|
56
|
-
- **
|
|
57
|
-
|
|
58
|
-
### Supporting capabilities
|
|
59
|
-
|
|
60
|
-
- **Typed style props and mod props** — `styleProps` exposes selected CSS properties as typed React props (`<Space flow="row" gap="2x">`); `modProps` does the same for modifier keys (`<Button isLoading size="large">`). Both support state maps and full TypeScript autocomplete. See [Style Props](#style-props) and [Mod Props](#mod-props).
|
|
61
|
-
- **Zero client styling runtime with the full React API** — All `tasty()` components and style functions are hook-free. In server-only rendering, they generate CSS on the server and ship no Tasty styling runtime to the browser. Astro without islands is the concrete integration; server-only Next.js RSC follows the same architecture. Use `tastyStatic()` when you specifically need build-time extraction without React.
|
|
62
|
-
- **Broad modern CSS coverage** — Media queries, container queries, `@supports`, `:has()`, `@starting-style`, `@property`, `@keyframes`, `@font-face`, `@counter-style`, `@function`, and more. Features that do not fit the component model (such as `@layer` and `!important`) are intentionally left out.
|
|
63
|
-
- **Performance and caching** — When styles are generated in the browser, Tasty injects CSS on demand, reuses chunks aggressively, and relies on multi-level caching so large component systems stay practical.
|
|
64
|
-
- **TypeScript-first and AI-friendly** — Style definitions are declarative, structurally consistent, and fully typed, which helps both humans and tooling understand advanced stateful styles without hidden cascade logic.
|
|
65
|
-
|
|
66
|
-
## Why State Maps Matter
|
|
67
|
-
|
|
68
|
-
Component styling becomes fragile when multiple selectors can win for the same property. Hover, disabled, theme, breakpoint, parent state, and root state rules start competing through specificity and source order.
|
|
69
|
-
|
|
70
|
-
Tasty replaces that competition with explicit priority in the state map. Each property compiles into mutually exclusive branches, so only one generated selector can match. For the full mechanism, jump to [How It Actually Works](#how-it-actually-works).
|
|
46
|
+
- **States that can't conflict** — Every state map compiles into mutually exclusive selectors, and the last matching key wins by construction. Adding a state, variant, or override never means re-deriving selector interactions. [How it works →](#how-it-works)
|
|
47
|
+
- **Your design system's language** — Define color tokens, units, state aliases like `@mobile` and `@dark`, typography presets, and recipes once with `configure()`. Components then read like the spec: `padding: '2x'`, `fill: '#surface'`, `preset: 'h3'`. [Design-system integration →](#design-system-integration)
|
|
48
|
+
- **Typed component APIs** — Decide exactly what consumers can change. `styleProps`, `modProps`, `tokenProps`, `variants`, and sub-elements become typed React props and components with full autocomplete. [Component API →](#component-api)
|
|
49
|
+
- **Guardrails in the editor and CI** — An ESLint and oxlint plugin with 40+ rules checks property names, values, tokens, state keys, presets, and recipes against your project's config. TypeScript augmentation autocompletes your own token, preset, and theme names. [Types and linting →](#types-and-linting)
|
|
50
|
+
- **Modern CSS, one model** — Media and container queries, `@supports`, `:has()`, root and parent states, and `@starting-style` are all state keys. `@keyframes`, `@property`, `@font-face`, `@counter-style`, and `@function` are built in. [CSS coverage →](#css-coverage)
|
|
51
|
+
- **Render anywhere** — The same styles work in client React, React Server Components, and streaming SSR (Next.js, Astro). Render only on the server to ship no styling runtime at all, or extract CSS at build time with `tastyStatic()`. [Rendering modes →](#rendering-modes)
|
|
71
52
|
|
|
72
53
|
## Installation
|
|
73
54
|
|
|
@@ -75,33 +56,13 @@ Tasty replaces that competition with explicit priority in the state map. Each pr
|
|
|
75
56
|
pnpm add @tenphi/tasty
|
|
76
57
|
```
|
|
77
58
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
- Node.js 20+
|
|
81
|
-
- React 18+ (peer dependency for the React entry points)
|
|
82
|
-
- `pnpm`, `npm`, or `yarn`
|
|
83
|
-
|
|
84
|
-
Other package managers:
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
npm add @tenphi/tasty
|
|
88
|
-
yarn add @tenphi/tasty
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
## Start Here
|
|
92
|
-
|
|
93
|
-
For the fuller docs map beyond the quick routes above, start here:
|
|
94
|
-
|
|
95
|
-
- **[Comparison](docs/comparison.md)** — read this first if you are evaluating whether Tasty fits your team's styling model
|
|
96
|
-
- **[Adoption Guide](docs/adoption.md)** — understand who Tasty is for, where it fits, and how to introduce it incrementally
|
|
97
|
-
- **[Getting Started](docs/getting-started.md)** — the canonical onboarding path: install, first component, optional shared `configure()`, ESLint, editor tooling, and rendering mode selection
|
|
98
|
-
- **[Style rendering pipeline](docs/pipeline.md)** — see the selector model behind deterministic style resolution
|
|
99
|
-
- **[Docs Hub](docs/README.md)** — choose docs by role and task: React rendering, zero-client-runtime delivery, build-time extraction, design-system authoring, internals, and debugging
|
|
100
|
-
- **[Methodology](docs/methodology.md)** — the recommended component model and public API conventions for design-system code
|
|
59
|
+
Requires Node.js 20+ and React 18+ (a peer dependency of the React entry points). `npm add @tenphi/tasty` and `yarn add @tenphi/tasty` work the same way.
|
|
101
60
|
|
|
102
61
|
## Quick Start
|
|
103
62
|
|
|
104
|
-
###
|
|
63
|
+
### 1. Write a component
|
|
64
|
+
|
|
65
|
+
Plain CSS values work as-is, so a first component looks like CSS you already know:
|
|
105
66
|
|
|
106
67
|
```tsx
|
|
107
68
|
import { tasty } from '@tenphi/tasty';
|
|
@@ -110,147 +71,154 @@ const Card = tasty({
|
|
|
110
71
|
as: 'div',
|
|
111
72
|
styles: {
|
|
112
73
|
display: 'flex',
|
|
113
|
-
flow: 'column',
|
|
74
|
+
flow: 'column', // flex-flow
|
|
114
75
|
padding: '24px',
|
|
115
76
|
gap: '12px',
|
|
116
|
-
fill: 'white',
|
|
77
|
+
fill: 'white', // background-color
|
|
117
78
|
color: '#222',
|
|
118
79
|
border: '1px solid #ddd',
|
|
119
|
-
radius: '12px',
|
|
80
|
+
radius: '12px', // border-radius
|
|
120
81
|
},
|
|
121
82
|
});
|
|
122
83
|
|
|
123
|
-
// Just a React component
|
|
124
84
|
<Card>Hello World</Card>;
|
|
125
85
|
```
|
|
126
86
|
|
|
127
|
-
|
|
87
|
+
### 2. Bring in your design system
|
|
88
|
+
|
|
89
|
+
Call `configure()` once, before your app renders, to define the vocabulary every component shares:
|
|
90
|
+
|
|
91
|
+
```tsx
|
|
92
|
+
// tasty.setup.ts — import it at the top of your entry point
|
|
93
|
+
import { configure } from '@tenphi/tasty';
|
|
94
|
+
|
|
95
|
+
configure({
|
|
96
|
+
tokens: {
|
|
97
|
+
'#surface': { '': '#fff', '@dark': '#1c1c1e' },
|
|
98
|
+
'#text': { '': '#222', '@dark': '#f2f2f7' },
|
|
99
|
+
'#border': '#ddd',
|
|
100
|
+
},
|
|
101
|
+
units: { x: '8px', r: '12px' }, // spacing step and radius
|
|
102
|
+
states: {
|
|
103
|
+
'@mobile': '@media(w < 768px)',
|
|
104
|
+
'@dark':
|
|
105
|
+
'@root(schema=dark) | (!@root(schema) & @media(prefers-color-scheme: dark))',
|
|
106
|
+
},
|
|
107
|
+
});
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
The same card, written in that vocabulary:
|
|
128
111
|
|
|
129
|
-
|
|
112
|
+
```tsx
|
|
113
|
+
const Card = tasty({
|
|
114
|
+
styles: {
|
|
115
|
+
display: 'flex',
|
|
116
|
+
flow: 'column',
|
|
117
|
+
padding: { '': '3x', '@mobile': '2x' }, // 24px, 16px on mobile
|
|
118
|
+
gap: '1.5x', // 12px
|
|
119
|
+
fill: '#surface', // var(--surface-color)
|
|
120
|
+
color: '#text',
|
|
121
|
+
border: true, // 1bw solid #border
|
|
122
|
+
radius: '1r', // 12px
|
|
123
|
+
},
|
|
124
|
+
});
|
|
125
|
+
```
|
|
130
126
|
|
|
131
|
-
|
|
127
|
+
The component never mentions dark mode, yet it follows the `@dark` tokens. Change a token or a unit once and every component follows.
|
|
132
128
|
|
|
133
|
-
### Add
|
|
129
|
+
### 3. Add states and a typed API
|
|
134
130
|
|
|
135
131
|
```tsx
|
|
136
132
|
const Button = tasty({
|
|
137
133
|
as: 'button',
|
|
134
|
+
modProps: { isLoading: Boolean, size: ['sm', 'md', 'lg'] as const },
|
|
138
135
|
styles: {
|
|
139
|
-
padding: '1.5x 3x',
|
|
136
|
+
padding: { '': '1.5x 3x', 'size=sm': '1x 2x', 'size=lg': '2x 4x' },
|
|
137
|
+
radius: '1r',
|
|
140
138
|
fill: {
|
|
141
139
|
'': '#primary',
|
|
142
140
|
':hover': '#primary-hover',
|
|
143
141
|
':active': '#primary-pressed',
|
|
144
142
|
disabled: '#surface',
|
|
145
143
|
},
|
|
146
|
-
color: {
|
|
147
|
-
|
|
148
|
-
disabled: '#text.40',
|
|
149
|
-
},
|
|
150
|
-
cursor: {
|
|
151
|
-
'': 'pointer',
|
|
152
|
-
disabled: 'not-allowed',
|
|
153
|
-
},
|
|
144
|
+
color: { '': '#on-primary', disabled: '#text.40' },
|
|
145
|
+
cursor: { '': 'pointer', isLoading: 'wait', disabled: 'not-allowed' },
|
|
154
146
|
transition: 'theme',
|
|
155
147
|
},
|
|
156
148
|
});
|
|
149
|
+
|
|
150
|
+
<Button size="lg" isLoading>
|
|
151
|
+
Save
|
|
152
|
+
</Button>;
|
|
153
|
+
// renders <button data-is-loading data-size="lg" class="…">
|
|
157
154
|
```
|
|
158
155
|
|
|
159
|
-
|
|
156
|
+
`size` is typed as `'sm' | 'md' | 'lg'`. Mod props become `data-*` attributes, which state keys like `size=lg` and `isLoading` select. `disabled` tracks the native `disabled` prop, `#text.40` is the text color at 40% opacity, and `transition: 'theme'` is a named group that transitions color, background, border, shadow, outline, and opacity together.
|
|
160
157
|
|
|
161
|
-
### Extend
|
|
158
|
+
### 4. Extend a component
|
|
162
159
|
|
|
163
160
|
```tsx
|
|
164
|
-
import { Button } from 'my-ui-lib';
|
|
165
|
-
|
|
166
161
|
const DangerButton = tasty(Button, {
|
|
167
162
|
styles: {
|
|
168
163
|
fill: {
|
|
169
164
|
'': '#danger',
|
|
170
165
|
':hover': '#danger-hover',
|
|
166
|
+
':active': '#danger-pressed',
|
|
167
|
+
disabled: '@inherit', // keep the parent's disabled branch
|
|
171
168
|
},
|
|
172
169
|
},
|
|
173
170
|
});
|
|
174
171
|
```
|
|
175
172
|
|
|
176
|
-
|
|
173
|
+
A state map with a `''` key replaces the parent's map; a map without one extends it. `@inherit` pulls a single branch from the parent, `null` removes one, and `false` blocks it entirely. See [Extending vs. replacing state maps](docs/dsl.md#extending-vs-replacing-state-maps). An extension can also declare its own `styleProps`, `modProps`, `tokenProps`, `variants`, and `elements`, and it keeps the base's sub-elements.
|
|
177
174
|
|
|
178
|
-
|
|
175
|
+
[Getting Started](docs/getting-started.md) continues from here with setup, linting, editor tooling, and choosing a rendering mode.
|
|
179
176
|
|
|
180
|
-
|
|
181
|
-
import { configure } from '@tenphi/tasty';
|
|
177
|
+
## How It Works
|
|
182
178
|
|
|
183
|
-
|
|
184
|
-
states: {
|
|
185
|
-
'@mobile': '@media(w < 768px)',
|
|
186
|
-
'@tablet': '@media(w < 1024px)',
|
|
187
|
-
'@dark':
|
|
188
|
-
'@root(schema=dark) | (!@root(schema) & @media(prefers-color-scheme: dark))',
|
|
189
|
-
},
|
|
190
|
-
recipes: {
|
|
191
|
-
card: { padding: '4x', fill: '#surface', radius: '1r', border: true },
|
|
192
|
-
},
|
|
193
|
-
});
|
|
194
|
-
```
|
|
179
|
+
The cascade resolves conflicts by specificity, then by source order. Take two rules for a button's background:
|
|
195
180
|
|
|
196
|
-
|
|
181
|
+
```css
|
|
182
|
+
.btn:hover {
|
|
183
|
+
background: dodgerblue;
|
|
184
|
+
}
|
|
185
|
+
.btn[disabled] {
|
|
186
|
+
background: gray;
|
|
187
|
+
}
|
|
188
|
+
```
|
|
197
189
|
|
|
198
|
-
|
|
190
|
+
Both selectors have specificity `(0, 2, 0)`. When the button is hovered **and** disabled, both match and the later rule wins. Swap the two rules and a hovered disabled button silently turns blue. The logic is correct; only the order is wrong, which is why this class of bug survives code review.
|
|
199
191
|
|
|
200
|
-
|
|
192
|
+
Tasty removes the competition. For the same intent:
|
|
201
193
|
|
|
202
194
|
```tsx
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
195
|
+
fill: {
|
|
196
|
+
'': '#primary',
|
|
197
|
+
':hover': '#primary-hover',
|
|
198
|
+
'[disabled]': '#surface',
|
|
199
|
+
}
|
|
208
200
|
```
|
|
209
201
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
## Choose a Styling Approach
|
|
213
|
-
|
|
214
|
-
Once you understand the component model, choose where Tasty should generate CSS. Zero-runtime delivery is an outcome, not a synonym for `tastyStatic()`.
|
|
215
|
-
|
|
216
|
-
| Approach | Authoring API | CSS is generated | Tasty runtime in the browser | Best for |
|
|
217
|
-
| ------------------------- | ------------------------------------------- | ----------------------------------- | ---------------------------- | ------------------------------------------------------------------- |
|
|
218
|
-
| **Server-only React** | `tasty()`; optional `@tenphi/tasty/ssr/*` | During server or static rendering | None | Astro without islands, server-only RSC, SSG |
|
|
219
|
-
| **Hydrated React** | `tasty()` plus `@tenphi/tasty/ssr/*` | During SSR, then on demand in React | Only in hydrated components | Interactive React apps, Next.js client components, Astro islands |
|
|
220
|
-
| **Build-time extraction** | `tastyStatic()` from `@tenphi/tasty/static` | During the build | None in file mode | Non-React frameworks or CSS that must be extracted before rendering |
|
|
221
|
-
|
|
222
|
-
The first approach and `tastyStatic()`'s default file mode both ship zero Tasty styling runtime to the browser. The difference is authoring and timing: server-only `tasty()` retains `styleProps`, sub-elements, variants, and the rest of the React API, while `tastyStatic()` extracts build-time-known styles without a React dependency. (`tastyStatic()` inject mode intentionally ships a tiny CSS injector.) Astro supports the server-only path directly with `tastyIntegration({ islands: false })`; the same server-only model applies to Next.js RSC, though you should verify the output for your deployment. See [Getting Started](docs/getting-started.md#choosing-a-rendering-mode), [Build-Time Extraction](docs/tasty-static.md), and [Server-Side Rendering](docs/ssr.md).
|
|
223
|
-
|
|
224
|
-
## How It Actually Works
|
|
225
|
-
|
|
226
|
-
This is the core idea that makes everything else possible.
|
|
227
|
-
|
|
228
|
-
For the end-to-end architecture — parsing state keys, building exclusive conditions, merging by output, and materializing selectors and at-rules — see **[Style rendering pipeline](docs/pipeline.md)**.
|
|
229
|
-
|
|
230
|
-
### The structural problem with normal CSS
|
|
231
|
-
|
|
232
|
-
First, the **cascade** resolves conflicts by specificity and source order: when multiple selectors match, the one with the highest specificity wins, or — if specificity is equal — the last one in source order wins. That makes styles inherently fragile. Reordering imports, adding a media query, or composing components from different libraries can silently break styling.
|
|
233
|
-
|
|
234
|
-
A small example makes this tangible. Two rules for a button's background:
|
|
202
|
+
it generates:
|
|
235
203
|
|
|
236
204
|
```css
|
|
237
|
-
.
|
|
238
|
-
background:
|
|
205
|
+
.t0.t0:where(:not([disabled]):not(:hover)) {
|
|
206
|
+
background-color: var(--primary-color);
|
|
239
207
|
}
|
|
240
|
-
.
|
|
241
|
-
background:
|
|
208
|
+
.t0.t0:where(:not([disabled]):hover) {
|
|
209
|
+
background-color: var(--primary-hover-color);
|
|
210
|
+
}
|
|
211
|
+
.t0.t0:where([disabled]) {
|
|
212
|
+
background-color: var(--surface-color);
|
|
242
213
|
}
|
|
243
214
|
```
|
|
244
215
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
### Why real state logic is hard to author by hand
|
|
216
|
+
Each branch is guarded by the negation of every higher-priority branch, so exactly one rule matches any element. Reorder the rules, split them across stylesheets, or extend the component: the outcome stays the same. Because the logic stays in CSS rather than JavaScript, the browser handles layout, painting, and transitions natively.
|
|
248
217
|
|
|
249
|
-
|
|
218
|
+
<details>
|
|
219
|
+
<summary><strong>A harder case: dark mode from a root attribute or the OS preference</strong></summary>
|
|
250
220
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
Tasty solves both problems at once: **every state mapping compiles into mutually exclusive selectors.**
|
|
221
|
+
Say `@dark` means "the root has `data-schema="dark"`, or no schema is set and the OS prefers dark":
|
|
254
222
|
|
|
255
223
|
```tsx
|
|
256
224
|
const Text = tasty({
|
|
@@ -259,18 +227,13 @@ const Text = tasty({
|
|
|
259
227
|
'': '#text',
|
|
260
228
|
'@dark': '#text-on-dark',
|
|
261
229
|
},
|
|
262
|
-
padding: {
|
|
263
|
-
'': '4x',
|
|
264
|
-
'@mobile': '2x',
|
|
265
|
-
},
|
|
266
230
|
},
|
|
267
231
|
});
|
|
268
232
|
```
|
|
269
233
|
|
|
270
|
-
|
|
234
|
+
A first attempt by hand:
|
|
271
235
|
|
|
272
236
|
```css
|
|
273
|
-
/* First attempt — the @media branch is too broad */
|
|
274
237
|
.t0 {
|
|
275
238
|
color: var(--text-color);
|
|
276
239
|
}
|
|
@@ -284,339 +247,399 @@ If `@dark` expands to `@root(schema=dark) | (!@root(schema) & @media(prefers-col
|
|
|
284
247
|
}
|
|
285
248
|
```
|
|
286
249
|
|
|
287
|
-
The `@media` branch fires even when `data-schema="light"` is explicitly
|
|
250
|
+
The `@media` branch fires even when `data-schema="light"` is set explicitly. Scoping it to `:root:not([data-schema])` fixes that, but the bare `.t0` default still matches unconditionally, and it can beat the attribute selector by source order if another rule re-declares it later. No single selector says "apply the default only when none of the dark branches win". The correct version negates every other branch, which is what Tasty generates:
|
|
288
251
|
|
|
289
252
|
```css
|
|
290
|
-
/*
|
|
291
|
-
.t0 {
|
|
292
|
-
color: var(--text-color);
|
|
293
|
-
}
|
|
294
|
-
:root[data-schema='dark'] .t0 {
|
|
253
|
+
/* Explicit dark schema */
|
|
254
|
+
:where(:root[data-schema='dark']) .t0.t0 {
|
|
295
255
|
color: var(--text-on-dark-color);
|
|
296
256
|
}
|
|
297
|
-
@media (prefers-color-scheme: dark) {
|
|
298
|
-
:root:not([data-schema]) .t0 {
|
|
299
|
-
color: var(--text-on-dark-color);
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
Better — but the bare `.t0` default still matches unconditionally. It matches in dark mode, it matches when `data-schema="dark"` is set, and it can beat the attribute selector by source order if another rule re-declares it later. There is no selector that says "apply this default only when none of the dark branches win."
|
|
305
257
|
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
```css
|
|
309
|
-
/* Branch 1: Explicit dark schema */
|
|
310
|
-
:root[data-schema='dark'] .t0.t0 {
|
|
311
|
-
color: var(--text-on-dark-color);
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
/* Branch 2: No schema attribute + OS prefers dark */
|
|
258
|
+
/* No schema attribute, OS prefers dark */
|
|
315
259
|
@media (prefers-color-scheme: dark) {
|
|
316
|
-
:root:not([data-schema]) .t0.t0 {
|
|
260
|
+
:where(:root:not([data-schema])) .t0.t0 {
|
|
317
261
|
color: var(--text-on-dark-color);
|
|
318
262
|
}
|
|
319
263
|
}
|
|
320
264
|
|
|
321
|
-
/* Default:
|
|
265
|
+
/* Default: OS prefers light, schema is not dark */
|
|
322
266
|
@media (not (prefers-color-scheme: dark)) {
|
|
323
|
-
:root:not([data-schema='dark']) .t0.t0 {
|
|
267
|
+
:where(:root:not([data-schema='dark'])) .t0.t0 {
|
|
324
268
|
color: var(--text-color);
|
|
325
269
|
}
|
|
326
270
|
}
|
|
327
271
|
|
|
328
|
-
/* Default:
|
|
329
|
-
|
|
330
|
-
|
|
272
|
+
/* Default: OS prefers dark, but a non-dark schema is set */
|
|
273
|
+
@media (prefers-color-scheme: dark) {
|
|
274
|
+
:where(:root:not([data-schema='dark'])[data-schema]) .t0.t0 {
|
|
275
|
+
color: var(--text-color);
|
|
276
|
+
}
|
|
331
277
|
}
|
|
332
278
|
```
|
|
333
279
|
|
|
334
|
-
|
|
280
|
+
That is one property with one state. Multiply it by dozens of properties, breakpoints, and container queries, and hand-written selectors stop being maintainable.
|
|
281
|
+
|
|
282
|
+
</details>
|
|
283
|
+
|
|
284
|
+
For the full compiler model (parsing state keys, building exclusive conditions, merging by value, materializing selectors and at-rules), see the [Style rendering pipeline](docs/pipeline.md). [Try it in the playground →](https://tasty.style/playground)
|
|
285
|
+
|
|
286
|
+
## Design-System Integration
|
|
287
|
+
|
|
288
|
+
`configure()` is where a design system's vocabulary lives. Everything defined there is available to every component, and the same names feed the linter and TypeScript.
|
|
335
289
|
|
|
336
|
-
|
|
290
|
+
| Define | With `configure({ … })` | Use in styles |
|
|
291
|
+
| ---------------------------- | ------------------------------------------------------- | -------------------------------------------------------- |
|
|
292
|
+
| Color tokens | `tokens: { '#surface': '#fff' }` | `fill: '#surface'`, `color: '#text.60'` |
|
|
293
|
+
| Value tokens | `tokens: { '$sidebar-width': '280px' }` | `width: '$sidebar-width'` |
|
|
294
|
+
| Units | `units: { x: '8px', r: '6px' }` | `padding: '2x'`, `radius: '1r'` |
|
|
295
|
+
| State aliases | `states: { '@mobile': '@media(w < 768px)' }` | `gap: { '': '2x', '@mobile': '1x' }` |
|
|
296
|
+
| Typography presets | `presets: { h1: { fontSize: '2rem', … } }` | `preset: 'h1'` |
|
|
297
|
+
| Recipes | `recipes: { card: { padding: '4x', … } }` | `recipe: 'card'` |
|
|
298
|
+
| Global at-rules | `keyframes`, `properties`, `fontFaces`, `counterStyles` | `animation: 'fade-in 200ms'` |
|
|
299
|
+
| Functions, handlers, plugins | `functions`, `handlers`, `propHandlers`, `plugins` | `$$name(...)`, new style properties, new component props |
|
|
337
300
|
|
|
338
|
-
|
|
301
|
+
Tokens accept state maps, so a theme is just more branches: `'#surface': { '': '#fff', '@dark': '#1c1c1e' }`. To generate whole light, dark, and high-contrast palettes with contrast solving, use [Glaze](#glaze).
|
|
339
302
|
|
|
340
|
-
|
|
303
|
+
### Built-in units
|
|
341
304
|
|
|
342
|
-
|
|
305
|
+
| Unit | Default | Example |
|
|
306
|
+
| ---- | ------------------- | ------------------------ |
|
|
307
|
+
| `x` | `8px` spacing step | `2x` → `16px` |
|
|
308
|
+
| `r` | `6px` radius | `1r` → `6px` |
|
|
309
|
+
| `cr` | `10px` card radius | `1cr` → `10px` |
|
|
310
|
+
| `bw` | `1px` border width | `2bw` → `2px` |
|
|
311
|
+
| `ow` | `3px` outline width | `1ow` → `3px` |
|
|
312
|
+
| `sf` | stable fraction | `1sf` → `minmax(0, 1fr)` |
|
|
343
313
|
|
|
344
|
-
|
|
314
|
+
Units compile to plain values. Override them with `configure({ units })`. When the scale has to change at runtime, point a unit at a custom property and define it as a token: `units: { x: 'var(--gap)' }` with `tokens: { $gap: '8px' }` makes `2x` compile to `calc(2 * var(--gap))`. Parentheses become `calc()`: `width: '(100% - 4x)'`.
|
|
345
315
|
|
|
346
|
-
###
|
|
316
|
+
### Recipes
|
|
347
317
|
|
|
348
|
-
|
|
318
|
+
Recipes are reusable style bundles, state maps included:
|
|
349
319
|
|
|
350
320
|
```tsx
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
padding: '
|
|
354
|
-
|
|
355
|
-
|
|
321
|
+
configure({
|
|
322
|
+
recipes: {
|
|
323
|
+
card: { padding: '4x', fill: '#surface', radius: '1r', border: true },
|
|
324
|
+
elevated: { shadow: '0 1x 3x #shadow' },
|
|
325
|
+
},
|
|
326
|
+
});
|
|
327
|
+
|
|
328
|
+
const Panel = tasty({ styles: { recipe: 'card elevated', gap: '2x' } });
|
|
356
329
|
```
|
|
357
330
|
|
|
358
|
-
|
|
359
|
-
| ---- | ---------------------------- | ------------------------------ |
|
|
360
|
-
| `x` | `--gap` multiplier | `2x` → `calc(var(--gap) * 2)` |
|
|
361
|
-
| `r` | `--radius` multiplier | `1r` → `var(--radius)` |
|
|
362
|
-
| `bw` | `--border-width` multiplier | `1bw` → `var(--border-width)` |
|
|
363
|
-
| `ow` | `--outline-width` multiplier | `1ow` → `var(--outline-width)` |
|
|
364
|
-
| `cr` | `--card-radius` multiplier | `1cr` → `var(--card-radius)` |
|
|
331
|
+
Local styles merge over recipes with the same extend/replace rules as component extension. Recipes listed after `/` apply after local styles, and `none` skips base recipes. See [Style DSL — Recipes](docs/dsl.md#recipes).
|
|
365
332
|
|
|
366
|
-
|
|
333
|
+
For token vocabularies, state aliases, layout primitives, and override contracts, see [Building a Design System](docs/design-system.md). To add your own style properties, units, functions, or component props, see [Plugins & Extension Points](docs/plugins.md).
|
|
367
334
|
|
|
368
|
-
|
|
335
|
+
## Component API
|
|
369
336
|
|
|
370
|
-
|
|
337
|
+
A Tasty component's public API is something you design. Instead of handing consumers an open `styles` escape hatch, expose the knobs they need as typed props.
|
|
371
338
|
|
|
372
|
-
|
|
373
|
-
| --------------------------------- | -------------------------- | ----------------------------------- |
|
|
374
|
-
| Data attribute (boolean modifier) | `disabled` | `[data-disabled]` |
|
|
375
|
-
| Data attribute (value modifier) | `theme=danger` | `[data-theme="danger"]` |
|
|
376
|
-
| Pseudo-class | `:hover` | `:hover` |
|
|
377
|
-
| Attribute selector | `[role="tab"]` | `[role="tab"]` |
|
|
378
|
-
| Class selector (supported) | `.is-active` | `.is-active` |
|
|
379
|
-
| Media query | `@media(w < 768px)` | `@media (width < 768px)` |
|
|
380
|
-
| Container query | `@(panel, w >= 300px)` | `@container panel (width >= 300px)` |
|
|
381
|
-
| Root state | `@root(schema=dark)` | `:root[data-schema="dark"]` |
|
|
382
|
-
| Parent state | `@parent(theme=danger)` | `:is([data-theme="danger"] *)` |
|
|
383
|
-
| Feature query | `@supports(display: grid)` | `@supports (display: grid)` |
|
|
384
|
-
| Entry animation | `@starting` | `@starting-style` |
|
|
339
|
+
### Style props
|
|
385
340
|
|
|
386
|
-
|
|
341
|
+
`styleProps` turns selected style properties into props. They accept state maps, so responsive values use the same syntax:
|
|
387
342
|
|
|
388
343
|
```tsx
|
|
389
|
-
|
|
390
|
-
'': '#surface',
|
|
391
|
-
'theme=danger & :hover': '#danger-hover',
|
|
392
|
-
'[aria-selected="true"]': '#accent-subtle',
|
|
393
|
-
}
|
|
394
|
-
```
|
|
344
|
+
import { tasty, FLOW_STYLES } from '@tenphi/tasty';
|
|
395
345
|
|
|
396
|
-
|
|
346
|
+
const Space = tasty({
|
|
347
|
+
styles: { display: 'flex', flow: 'column', gap: '1x' },
|
|
348
|
+
styleProps: FLOW_STYLES,
|
|
349
|
+
});
|
|
397
350
|
|
|
398
|
-
|
|
351
|
+
<Space flow="row" gap={{ '': '2x', '@mobile': '1x' }} />;
|
|
352
|
+
```
|
|
399
353
|
|
|
400
|
-
|
|
354
|
+
### Mod props
|
|
401
355
|
|
|
402
|
-
|
|
356
|
+
`modProps` exposes modifiers as typed props (`<Button isLoading size="lg">`, as in the [Quick Start](#3-add-states-and-a-typed-api)). Use `Boolean`, `String`, `Number`, or a `const` array of allowed values.
|
|
403
357
|
|
|
404
|
-
###
|
|
358
|
+
### Token props
|
|
405
359
|
|
|
406
|
-
`
|
|
360
|
+
`tokenProps` handles values that change often, such as progress, user-picked colors, or measured sizes. They set custom properties inline, so the class name and the CSS stay the same while the value changes:
|
|
407
361
|
|
|
408
362
|
```tsx
|
|
409
|
-
const
|
|
410
|
-
|
|
411
|
-
|
|
363
|
+
const Progress = tasty({
|
|
364
|
+
tokenProps: ['progress', 'accentColor'] as const,
|
|
365
|
+
styles: { width: '$progress', fill: '#accent' },
|
|
412
366
|
});
|
|
413
367
|
|
|
414
|
-
<
|
|
368
|
+
<Progress progress="75%" accentColor="#purple" />;
|
|
369
|
+
// style="--progress:75%;--accent-color:var(--purple-color)"
|
|
415
370
|
```
|
|
416
371
|
|
|
417
|
-
|
|
372
|
+
### Variants
|
|
373
|
+
|
|
374
|
+
Variants are named style sets. `variant` is typed from their keys, `default` (or the variant named by the `variant` option) applies when no `variant` is passed, and only the variants actually rendered emit CSS:
|
|
375
|
+
|
|
376
|
+
```tsx
|
|
377
|
+
const Badge = tasty({
|
|
378
|
+
styles: { padding: '.5x 1x', radius: '1r' },
|
|
379
|
+
variants: {
|
|
380
|
+
default: { fill: '#surface', color: '#text' },
|
|
381
|
+
danger: { fill: '#danger', color: '#on-danger' },
|
|
382
|
+
},
|
|
383
|
+
});
|
|
418
384
|
|
|
419
|
-
|
|
385
|
+
<Badge variant="danger">Failed</Badge>;
|
|
386
|
+
```
|
|
420
387
|
|
|
421
|
-
|
|
388
|
+
### Sub-elements
|
|
389
|
+
|
|
390
|
+
Compound components style their inner parts from one definition. `elements` produces typed sub-components:
|
|
422
391
|
|
|
423
392
|
```tsx
|
|
424
|
-
const
|
|
425
|
-
as: 'button',
|
|
426
|
-
modProps: { isLoading: Boolean, size: ['sm', 'md', 'lg'] as const },
|
|
393
|
+
const Card = tasty({
|
|
427
394
|
styles: {
|
|
428
|
-
|
|
429
|
-
|
|
395
|
+
padding: '4x',
|
|
396
|
+
Title: { preset: 'h3', color: { '': '#text', ':hover': '#primary' } },
|
|
397
|
+
Content: { color: '#text' },
|
|
430
398
|
},
|
|
399
|
+
elements: { Title: 'h3', Content: 'div' },
|
|
431
400
|
});
|
|
432
401
|
|
|
433
|
-
<
|
|
434
|
-
|
|
435
|
-
</
|
|
402
|
+
<Card>
|
|
403
|
+
<Card.Title>Revenue</Card.Title>
|
|
404
|
+
<Card.Content>Up 12% this week</Card.Content>
|
|
405
|
+
</Card>;
|
|
436
406
|
```
|
|
437
407
|
|
|
438
|
-
|
|
408
|
+
Sub-elements share the root's state context: `:hover` inside `Title` means "when the card is hovered". Use `@own(...)` when a part should react to its own state, and the `$` selector affix for precise descendant targeting.
|
|
439
409
|
|
|
440
|
-
|
|
410
|
+
All of these are covered in [React API](docs/react-api.md). For guidance on what to expose and when, see [Methodology](docs/methodology.md).
|
|
441
411
|
|
|
442
|
-
|
|
412
|
+
## Types and Linting
|
|
443
413
|
|
|
444
|
-
|
|
414
|
+
### TypeScript
|
|
445
415
|
|
|
446
|
-
|
|
416
|
+
Component props are typed from their definitions: `modProps` value lists become unions, `variant` is typed from the variant keys, style props are typed like the styles they expose, and sub-elements are typed components. Register your design system's names to get autocomplete inside style values too:
|
|
447
417
|
|
|
448
|
-
|
|
418
|
+
```ts
|
|
419
|
+
// tasty.d.ts
|
|
420
|
+
import '@tenphi/tasty';
|
|
449
421
|
|
|
450
|
-
|
|
422
|
+
declare module '@tenphi/tasty' {
|
|
423
|
+
// '#surface', '#primary.50' in fill, color, and other color props
|
|
424
|
+
interface TastyNamedColors {
|
|
425
|
+
surface: true;
|
|
426
|
+
primary: true;
|
|
427
|
+
}
|
|
428
|
+
// preset: 'h1'
|
|
429
|
+
interface TastyPresetNames {
|
|
430
|
+
h1: true;
|
|
431
|
+
t2: true;
|
|
432
|
+
}
|
|
433
|
+
// <Button theme="danger" />
|
|
434
|
+
interface TastyThemeNames {
|
|
435
|
+
danger: true;
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
```
|
|
451
439
|
|
|
452
|
-
|
|
440
|
+
`StylesInterface`, `TastyCustomProps`, and `TastyBaseStylePropNames` type the style properties, component props, and base style props your plugins add. See [Configuration → TypeScript](docs/configuration.md#typescript).
|
|
453
441
|
|
|
454
|
-
###
|
|
442
|
+
### ESLint and oxlint
|
|
455
443
|
|
|
456
|
-
|
|
444
|
+
[`@tenphi/eslint-plugin-tasty`](https://github.com/tenphi/eslint-plugin-tasty) validates style objects and JSX style props at lint time:
|
|
457
445
|
|
|
458
|
-
|
|
446
|
+
```bash
|
|
447
|
+
pnpm add -D @tenphi/eslint-plugin-tasty
|
|
448
|
+
```
|
|
459
449
|
|
|
460
|
-
|
|
450
|
+
```js
|
|
451
|
+
// eslint.config.js
|
|
452
|
+
import tasty from '@tenphi/eslint-plugin-tasty';
|
|
461
453
|
|
|
462
|
-
|
|
454
|
+
export default [tasty.configs.recommended]; // or tasty.configs.strict
|
|
455
|
+
```
|
|
463
456
|
|
|
464
|
-
|
|
457
|
+
A `tasty.config.ts` at the project root tells the plugin what your design system defines:
|
|
458
|
+
|
|
459
|
+
```ts
|
|
460
|
+
// tasty.config.ts
|
|
461
|
+
export default {
|
|
462
|
+
tokens: ['#surface', '#text', '#primary', '$sidebar-width'],
|
|
463
|
+
states: ['@mobile', '@dark'],
|
|
464
|
+
presets: ['h1', 'h2', 't1', 't2'],
|
|
465
|
+
recipes: ['card', 'elevated'],
|
|
466
|
+
importSources: ['@my-org/ui'], // modules that re-export tasty()
|
|
467
|
+
};
|
|
468
|
+
```
|
|
465
469
|
|
|
466
|
-
|
|
470
|
+
With that in place, `recommended` catches:
|
|
467
471
|
|
|
468
|
-
|
|
472
|
+
- Typos in property names (checked against the full CSS property set) and malformed values
|
|
473
|
+
- Unknown color tokens, units, presets, and recipes (plus `$` tokens and state aliases in `strict`)
|
|
474
|
+
- Invalid state keys, missing `''` defaults, nested state maps, and `!important`
|
|
475
|
+
- Raw colors and pixel lengths where tokens belong, and non-idiomatic syntax such as `calc(...)` or `display: 'none'`, some with autofixes
|
|
476
|
+
- `style`, `className`, and instance `styles` on Tasty components, in favor of their typed API
|
|
477
|
+
- Bad values in JSX style props, such as `<Box fill="red" gap="17px" />`
|
|
469
478
|
|
|
470
|
-
|
|
479
|
+
The same rule sets run under oxlint. See the [plugin README](https://github.com/tenphi/eslint-plugin-tasty) for every rule and option.
|
|
471
480
|
|
|
472
|
-
|
|
473
|
-
const Card = tasty({
|
|
474
|
-
styles: {
|
|
475
|
-
'@function': {
|
|
476
|
-
$$negative: { args: ['$value'], result: '(-1 * $value)' },
|
|
477
|
-
},
|
|
478
|
-
margin: '$$negative(2x) top',
|
|
479
|
-
},
|
|
480
|
-
});
|
|
481
|
-
```
|
|
481
|
+
## CSS Coverage
|
|
482
482
|
|
|
483
|
-
|
|
483
|
+
Every style property accepts a state map, and every kind of condition is a state key:
|
|
484
484
|
|
|
485
|
-
|
|
485
|
+
| State type | Syntax | CSS output |
|
|
486
|
+
| ---------------- | -------------------------- | ----------------------------------- |
|
|
487
|
+
| Boolean modifier | `loading` | `[data-loading]` |
|
|
488
|
+
| Value modifier | `theme=danger` | `[data-theme="danger"]` |
|
|
489
|
+
| Pseudo-class | `:hover` | `:hover` |
|
|
490
|
+
| Attribute | `[aria-selected="true"]` | `[aria-selected="true"]` |
|
|
491
|
+
| Class | `.is-active` | `.is-active` |
|
|
492
|
+
| Media query | `@media(w < 768px)` | `@media (width < 768px)` |
|
|
493
|
+
| Container query | `@(panel, w >= 300px)` | `@container panel (width >= 300px)` |
|
|
494
|
+
| Root state | `@root(schema=dark)` | `:root[data-schema="dark"]` |
|
|
495
|
+
| Parent state | `@parent(theme=danger)` | `:is([data-theme="danger"] *)` |
|
|
496
|
+
| Structural | `:has(> Icon)` | `:has(> [data-element="Icon"])` |
|
|
497
|
+
| Feature query | `@supports(display: grid)` | `@supports (display: grid)` |
|
|
498
|
+
| Entry animation | `@starting` | `@starting-style` |
|
|
486
499
|
|
|
487
|
-
|
|
500
|
+
Combine them with `&` (and), `|` (or), `!` (not), and `^` (xor): `'theme=danger & :hover'`. The `_` key sets a fallback floor for queries a browser may evaluate as unknown. See [Style DSL](docs/dsl.md).
|
|
488
501
|
|
|
489
|
-
|
|
502
|
+
At-rules live next to the styles that use them:
|
|
490
503
|
|
|
491
|
-
|
|
504
|
+
```tsx
|
|
505
|
+
const Spinner = tasty({
|
|
506
|
+
styles: {
|
|
507
|
+
'@keyframes': { spin: { to: { transform: 'rotate(360deg)' } } },
|
|
508
|
+
animation: 'spin 1s linear infinite',
|
|
509
|
+
},
|
|
510
|
+
});
|
|
511
|
+
```
|
|
492
512
|
|
|
493
|
-
|
|
513
|
+
- **`@keyframes`**: inline, as above, or global via `configure({ keyframes })`.
|
|
514
|
+
- **`@property`**: inferred automatically when a custom property gets a concrete value, so custom properties can transition and animate with no boilerplate. Declare one explicitly to change `inherits` or the initial value.
|
|
515
|
+
- **`@font-face`** and **`@counter-style`**: in styles, in `configure()`, or with the matching style function.
|
|
516
|
+
- **`@function`**: define parameterized CSS functions as `$$name` and call them anywhere a value is accepted. An opt-in polyfill inlines the calls for browsers that do not support it yet.
|
|
494
517
|
|
|
495
|
-
|
|
518
|
+
Tasty also ships its own style properties (`fill`, `flow`, `radius`, `preset`, `fade`, `scrollbar`, `hide`, and more), documented in [Style Properties](docs/styles.md). `@layer` and `!important` are intentionally left out: they would bring back the priority fights that state maps remove.
|
|
496
519
|
|
|
497
|
-
|
|
498
|
-
- Use `tastyStatic()` to extract build-time-known CSS without React.
|
|
520
|
+
### Style functions
|
|
499
521
|
|
|
500
|
-
|
|
522
|
+
When you don't need a component, call the style functions directly: `useStyles` for a class name, `useGlobalStyles` for selector-scoped global CSS, `useRawCSS` for raw rules, plus `useKeyframes`, `useProperty`, `useFontFace`, `useCounterStyle`, and `useFunction`. All of them work in React Server Components. Apart from `useStyles`, which reads React context on the client, they are plain functions despite the `use` prefix, so they also work outside React; `computeStyles` is the hook-free equivalent of `useStyles`. See [React API — Style Functions](docs/react-api.md#style-functions).
|
|
501
523
|
|
|
502
|
-
|
|
524
|
+
## Rendering Modes
|
|
503
525
|
|
|
504
|
-
|
|
526
|
+
The DSL, tokens, units, state maps, and recipes are the same everywhere. What changes is where CSS is generated:
|
|
505
527
|
|
|
506
|
-
|
|
528
|
+
| Approach | Authoring API | CSS is generated | Tasty runtime in the browser | Best for |
|
|
529
|
+
| ------------------------- | ------------------------------------------- | ----------------------------------- | ---------------------------- | ---------------------------------------------------------------- |
|
|
530
|
+
| **Server-only React** | `tasty()` plus `@tenphi/tasty/ssr/*` | During server or static rendering | None | Astro without islands, server-only RSC, SSG |
|
|
531
|
+
| **Hydrated React** | `tasty()` plus `@tenphi/tasty/ssr/*` | During SSR, then on demand in React | Only in hydrated components | Interactive React apps, Next.js client components, Astro islands |
|
|
532
|
+
| **Build-time extraction** | `tastyStatic()` from `@tenphi/tasty/static` | During the build | None in file mode | Non-React frameworks, CSS needed before rendering |
|
|
507
533
|
|
|
508
|
-
|
|
534
|
+
- **`tasty()` renders on the server.** Components are hook-free and render as React Server Components by default. Rendered only on the server, they keep the full React API (`styleProps`, sub-elements, variants) and ship no styling runtime. Astro's `tastyIntegration({ islands: false })` is the verified zero-JavaScript setup; server-only Next.js RSC follows the same architecture. Without an integration, each element inlines its own CSS, and configured tokens, global styles, and Tasty's default `@property` set are not emitted (Tasty warns in development), so use one for anything that relies on `configure()` or on those defaults.
|
|
535
|
+
- **SSR integrations** add CSS batching, cross-tree deduplication, FOUC prevention, and client cache hydration for apps that also render on the client: `TastyRegistry` from `@tenphi/tasty/ssr/next` (plus `withTastyNext()` from `@tenphi/tasty/ssr/next-config` for a shared global stylesheet), `tastyIntegration()` from `@tenphi/tasty/ssr/astro`, and a core API for other React SSR setups. Streaming is supported.
|
|
536
|
+
- **`tastyStatic()`** returns class names and extracts CSS during the build through a Babel plugin, with no React dependency. File mode ships no runtime; inject mode ships a tiny CSS injector.
|
|
509
537
|
|
|
510
|
-
|
|
538
|
+
See [Server-Side Rendering](docs/ssr.md), [Build-Time Extraction](docs/tasty-static.md), and [Choosing a rendering mode](docs/getting-started.md#choosing-a-rendering-mode).
|
|
511
539
|
|
|
512
|
-
|
|
540
|
+
## Tooling
|
|
513
541
|
|
|
514
|
-
|
|
515
|
-
- `@tenphi/tasty/ssr/astro` for Astro (with or without islands)
|
|
516
|
-
- The core SSR API for other React SSR setups
|
|
542
|
+
### ESLint plugin
|
|
517
543
|
|
|
518
|
-
|
|
544
|
+
Covered in [Types and Linting](#eslint-and-oxlint): 40+ rules for ESLint 9+ and oxlint, configured from `tasty.config.ts`.
|
|
519
545
|
|
|
520
|
-
|
|
546
|
+
### VS Code extension
|
|
521
547
|
|
|
522
|
-
|
|
523
|
-
| -------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------- |
|
|
524
|
-
| `@tenphi/tasty` | React style engine (`tasty`, style functions, `configure`) | Browser / Node |
|
|
525
|
-
| `@tenphi/tasty/static` | Build-time extraction authoring API (`tastyStatic`) | Build time |
|
|
526
|
-
| `@tenphi/tasty/static/inject` | Runtime helper the Babel plugin rewrites `tastyStatic` imports to in inject mode | Browser |
|
|
527
|
-
| `@tenphi/tasty/core` | Lower-level internals (config, parser, pipeline, injector, style handlers) for tooling and advanced use | Browser / Node |
|
|
528
|
-
| `@tenphi/tasty/babel-plugin` | Babel plugin for build-time CSS extraction | Node |
|
|
529
|
-
| `@tenphi/tasty/zero` | Programmatic extraction API | Node |
|
|
530
|
-
| `@tenphi/tasty/zero/next` | Next.js integration wrapper | Node |
|
|
531
|
-
| `@tenphi/tasty/ssr` | Core SSR API (collector, context, hydration) | Node |
|
|
532
|
-
| `@tenphi/tasty/ssr/next` | Next.js App Router SSR integration | Node |
|
|
533
|
-
| `@tenphi/tasty/ssr/astro` | Astro integration + middleware | Node |
|
|
534
|
-
| `@tenphi/tasty/ssr/astro-client` | Astro client-side cache hydration | Browser |
|
|
548
|
+
[Tasty for VS Code](https://github.com/tenphi/tasty-vscode-extension) highlights color tokens, units, state keys, presets, and style properties inside `tasty()`, `tastyStatic()`, `styles` objects, and style functions, and adds snippets for components, state maps, and `configure()`. Install the `.vsix` from the [latest release](https://github.com/tenphi/tasty-vscode-extension/releases/latest).
|
|
535
549
|
|
|
536
|
-
|
|
550
|
+
<p align="center">
|
|
551
|
+
<img src="assets/tasty-vscode-highlight.png" width="512" alt="Tasty VS Code syntax highlighting example" />
|
|
552
|
+
</p>
|
|
537
553
|
|
|
538
|
-
|
|
554
|
+
### Glaze
|
|
539
555
|
|
|
540
|
-
|
|
541
|
-
- **Level-4 `:not()` with selector lists** — Chrome/Edge 88+, Firefox 84+, Safari 9+, Opera 75+.
|
|
542
|
-
- **Not supported:** IE 11.
|
|
556
|
+
[`@tenphi/glaze`](https://github.com/tenphi/glaze) generates light, dark, and high-contrast themes from one hue in the OKHST color space, solves WCAG and APCA contrast, and exports Tasty tokens directly (as well as CSS, DTCG, and Tailwind):
|
|
543
557
|
|
|
544
|
-
|
|
558
|
+
```ts
|
|
559
|
+
import { glaze } from '@tenphi/glaze';
|
|
560
|
+
import { configure } from '@tenphi/tasty';
|
|
545
561
|
|
|
546
|
-
|
|
562
|
+
const theme = glaze(280, 80); // hue, saturation
|
|
563
|
+
theme.colors({
|
|
564
|
+
surface: { tone: 97, saturation: 0.15 },
|
|
565
|
+
text: { base: 'surface', tone: '-1', contrast: 'AA' },
|
|
566
|
+
});
|
|
547
567
|
|
|
548
|
-
|
|
568
|
+
configure({ tokens: theme.tasty() }); // #surface and #text, light and dark
|
|
569
|
+
```
|
|
549
570
|
|
|
550
|
-
|
|
551
|
-
| ------------------------------------------------- | -------- |
|
|
552
|
-
| `@tenphi/tasty` (client + server rendering) | 50.19 kB |
|
|
553
|
-
| `@tenphi/tasty/core` (runtime, no SSR) | 47.76 kB |
|
|
554
|
-
| `@tenphi/tasty/static` (build-time authoring API) | 16.43 kB |
|
|
555
|
-
| `@tenphi/tasty/zero` (programmatic extraction) | 29.6 kB |
|
|
556
|
-
| `@tenphi/tasty/babel-plugin` (Babel plugin entry) | 43.7 kB |
|
|
571
|
+
### Debugging
|
|
557
572
|
|
|
558
|
-
|
|
573
|
+
`tastyDebug` inspects what Tasty injected, straight from the browser console:
|
|
559
574
|
|
|
560
|
-
|
|
575
|
+
```ts
|
|
576
|
+
import { tastyDebug } from '@tenphi/tasty';
|
|
561
577
|
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
React update with shared styles. See
|
|
566
|
-
[Runtime Benchmarks](docs/runtime-benchmarks.md) for the methodology, exact
|
|
567
|
-
results, limitations, and commands.
|
|
578
|
+
tastyDebug.install(); // exposes window.tastyDebug
|
|
579
|
+
tastyDebug.inspect('.my-button'); // classes, chunks, and the CSS that applies
|
|
580
|
+
```
|
|
568
581
|
|
|
569
|
-
|
|
582
|
+
See [Debug Utilities](docs/debug.md).
|
|
570
583
|
|
|
571
|
-
|
|
572
|
-
- Multi-level caching avoids repeated parsing and style recomputation.
|
|
573
|
-
- Styles are split into reusable chunks and applied as multiple class names, so matching chunks can be reused across components instead of re-injected.
|
|
574
|
-
- Style normalization guarantees equivalent style input resolves to the same chunks, improving deduplication hit rates.
|
|
575
|
-
- A style garbage collector removes unused styles/chunks over time.
|
|
576
|
-
- A dedicated style injector minimizes DOM/style-tag overhead.
|
|
577
|
-
- Optional [batched injection](docs/configuration.md#batched-injection) keeps stylesheet writes together before layout reads, allowing the browser to resolve their effects together instead of between individual insertions.
|
|
578
|
-
- This approach is validated in enterprise-scale apps where runtime styling overhead is not noticeable in normal UI flows.
|
|
584
|
+
### AI coding agents
|
|
579
585
|
|
|
580
|
-
|
|
586
|
+
Style definitions are declarative and fully typed, so agents can read and write them reliably. [Style Rules for AI Agents](docs/ai-agents.md) is a one-page brief to add to an agent's context.
|
|
581
587
|
|
|
582
|
-
|
|
588
|
+
## Performance
|
|
583
589
|
|
|
584
|
-
###
|
|
590
|
+
### Bundle size
|
|
585
591
|
|
|
586
|
-
|
|
592
|
+
Measured with [size-limit](https://github.com/ai/size-limit): minified and brotli-compressed, including all dependencies.
|
|
587
593
|
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
594
|
+
| Entry point | Size |
|
|
595
|
+
| ------------------------------------------------- | -------- |
|
|
596
|
+
| `@tenphi/tasty`, importing `tasty` | 52.26 kB |
|
|
597
|
+
| `@tenphi/tasty`, everything | 58.9 kB |
|
|
598
|
+
| `@tenphi/tasty/core`, everything (no SSR) | 55.2 kB |
|
|
599
|
+
| `@tenphi/tasty/static` (build-time authoring API) | 920 B |
|
|
600
|
+
| `@tenphi/tasty/ssr/client` | 277 B |
|
|
601
|
+
| `@tenphi/tasty/ssr/astro-client` | 283 B |
|
|
602
|
+
| `@tenphi/tasty/zero` (Node, build time) | 38.87 kB |
|
|
603
|
+
| `@tenphi/tasty/babel-plugin` (Node, build time) | 43.05 kB |
|
|
591
604
|
|
|
592
|
-
|
|
593
|
-
import tasty from '@tenphi/eslint-plugin-tasty';
|
|
594
|
-
export default [tasty.configs.recommended];
|
|
595
|
-
```
|
|
605
|
+
Run `pnpm size` to reproduce; numbers shift slightly between releases.
|
|
596
606
|
|
|
597
|
-
###
|
|
607
|
+
### Runtime
|
|
598
608
|
|
|
599
|
-
|
|
609
|
+
When styles are generated in the browser:
|
|
600
610
|
|
|
601
|
-
|
|
602
|
-
|
|
611
|
+
- CSS is generated and injected only for styles that are actually rendered.
|
|
612
|
+
- Styles are split into chunks and normalized, so equivalent styles resolve to the same classes and are reused across components instead of re-injected.
|
|
613
|
+
- Multi-level caching avoids re-parsing and recomputation.
|
|
614
|
+
- Unused styles can be garbage-collected over time with `configure({ gc })`, or on demand with `gc()` and `cleanup()`.
|
|
615
|
+
- Optional [batched injection](docs/configuration.md#batched-injection) groups stylesheet writes before layout reads.
|
|
616
|
+
- The approach runs in enterprise-scale apps where runtime styling overhead is not noticeable in normal UI flows.
|
|
603
617
|
|
|
604
|
-
|
|
605
|
-
theme.colors({
|
|
606
|
-
surface: { lightness: 97 },
|
|
607
|
-
text: { base: 'surface', lightness: '-52', contrast: 'AAA' },
|
|
608
|
-
});
|
|
618
|
+
Reproducible benchmarks cover the core pipeline, the React overhead of an empty `tasty({})` wrapper, cold generation and injection against equivalent precompiled CSS, steady-state interactions, and page-load cold start. See [Runtime Benchmarks](docs/runtime-benchmarks.md) for methodology and results.
|
|
609
619
|
|
|
610
|
-
|
|
611
|
-
```
|
|
620
|
+
## Browser Support
|
|
612
621
|
|
|
613
|
-
|
|
622
|
+
Exclusive selectors rely on `:is()`, `:where()`, and level-4 `:not()` with selector lists: Chrome and Edge 88+, Firefox 84+, Safari 14+. Internet Explorer is not supported.
|
|
614
623
|
|
|
615
|
-
|
|
624
|
+
The defaults that style handlers read, such as the `#border` color and the `$transition` duration, are registered with `@property` (Chrome and Edge 85+, Firefox 128+, Safari 16.4+). For older engines, define those tokens yourself; see [Default properties](docs/dsl.md#default-properties).
|
|
616
625
|
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
626
|
+
## Entry Points
|
|
627
|
+
|
|
628
|
+
| Import | Description | Platform |
|
|
629
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------- |
|
|
630
|
+
| `@tenphi/tasty` | React style engine (`tasty`, style functions, `configure`) | Browser / Node |
|
|
631
|
+
| `@tenphi/tasty/core` | Lower-level internals (config, parser, pipeline, injector, style handlers) for tooling and advanced use | Browser / Node |
|
|
632
|
+
| `@tenphi/tasty/static` | Build-time extraction authoring API (`tastyStatic`) | Build time |
|
|
633
|
+
| `@tenphi/tasty/static/inject` | Runtime helper the Babel plugin rewrites `tastyStatic` imports to in inject mode | Browser |
|
|
634
|
+
| `@tenphi/tasty/babel-plugin` | Babel plugin for build-time CSS extraction | Node |
|
|
635
|
+
| `@tenphi/tasty/zero` | Programmatic extraction API | Node |
|
|
636
|
+
| `@tenphi/tasty/zero/next` | Next.js wrapper for build-time extraction | Node |
|
|
637
|
+
| `@tenphi/tasty/ssr` | Core SSR API (collector, context, hydration) | Node |
|
|
638
|
+
| `@tenphi/tasty/ssr/next` | Next.js App Router SSR integration (`TastyRegistry`) | Node |
|
|
639
|
+
| `@tenphi/tasty/ssr/next-config` | Next.js config wrapper for a shared global stylesheet (`withTastyNext`) | Node |
|
|
640
|
+
| `@tenphi/tasty/ssr/astro` | Astro integration and middleware | Node |
|
|
641
|
+
| `@tenphi/tasty/ssr/client` | Browser-safe SSR hydration for any framework (`hydrateTastyClasses`) | Browser |
|
|
642
|
+
| `@tenphi/tasty/ssr/astro-client` | Astro client-side cache hydration | Browser |
|
|
620
643
|
|
|
621
644
|
## Built with Tasty
|
|
622
645
|
|
|
@@ -624,6 +647,10 @@ Syntax highlighting for Tasty styles in TypeScript, TSX, JavaScript, and JSX. Hi
|
|
|
624
647
|
|
|
625
648
|
The official Tasty documentation and landing page — itself built entirely with `tasty()`. A showcase for server-rendered Tasty with Next.js and OKHST color theming with Glaze.
|
|
626
649
|
|
|
650
|
+
### [Cookbook](https://cookbook.tenphi.me) ([source](https://github.com/tenphi/cookbook))
|
|
651
|
+
|
|
652
|
+
`@tenphi/cookbook` builds a static Astro documentation site from your repository or a published npm package. Brand colors, semantic palettes, fonts, typography, and individual component parts are configured through Tasty and Glaze, so the docs match your product.
|
|
653
|
+
|
|
627
654
|
### [Cube Cloud](https://cube.dev/)
|
|
628
655
|
|
|
629
656
|
Enterprise universal semantic layer platform by Cube Dev, Inc. Cube Cloud unifies data modeling, caching, access control, and APIs (REST, GraphQL, SQL, AI) for analytics at scale. Tasty has powered its frontend for over 5 years in production.
|
|
@@ -638,47 +665,43 @@ Open-source React UI kit built on Tasty + React Aria. 100+ production components
|
|
|
638
665
|
|
|
639
666
|
## Documentation
|
|
640
667
|
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
- **[Docs Hub](docs/README.md)** — audience-based navigation across onboarding, design-system authoring, client and server rendering, build-time extraction, debugging, and internals
|
|
644
|
-
|
|
645
|
-
### Start here
|
|
646
|
-
|
|
647
|
-
- **[Getting Started](docs/getting-started.md)** — Installation, first component, optional shared configuration, ESLint plugin setup, editor tooling, and rendering mode decision tree
|
|
648
|
-
- **[Methodology](docs/methodology.md)** — The recommended patterns for structuring Tasty components: root + sub-elements, styleProps, tokens, styles vs style, wrapping and extension
|
|
668
|
+
The [Docs Hub](docs/README.md) routes you by role, rendering mode, and task.
|
|
649
669
|
|
|
650
|
-
|
|
670
|
+
**Start here**
|
|
651
671
|
|
|
652
|
-
-
|
|
653
|
-
-
|
|
672
|
+
- [Getting Started](docs/getting-started.md) — Install, first component, shared configuration, ESLint, editor tooling, and choosing a rendering mode
|
|
673
|
+
- [Methodology](docs/methodology.md) — The recommended component model: root + sub-elements, `styleProps`, tokens, `styles` vs `style`, wrapping and extension
|
|
654
674
|
|
|
655
|
-
|
|
675
|
+
**Guides**
|
|
656
676
|
|
|
657
|
-
-
|
|
658
|
-
-
|
|
659
|
-
-
|
|
660
|
-
- **[Plugins & Extension Points](docs/plugins.md)** — Extending Tasty: choosing an extension point, authoring style handlers and props middleware, and packaging it as a plugin
|
|
661
|
-
- **[Style Properties](docs/styles.md)** — Complete reference for all enhanced style properties: syntax, values, modifiers, and recommendations
|
|
662
|
-
- **[Style Rules for AI Agents](docs/ai-agents.md)** — Condensed, rule-based brief for AI coding agents: correct value syntax, state maps, and property choices in one short page
|
|
677
|
+
- [Building a Design System](docs/design-system.md) — Token vocabulary, state aliases, recipes, primitives, compound components, and override contracts
|
|
678
|
+
- [Adoption Guide](docs/adoption.md) — Where Tasty fits, who should adopt it, and how to introduce it incrementally
|
|
679
|
+
- [Comparison](docs/comparison.md) — Tasty next to Tailwind, Panda CSS, vanilla-extract, StyleX, Stitches, and Emotion
|
|
663
680
|
|
|
664
|
-
|
|
681
|
+
**Reference**
|
|
665
682
|
|
|
666
|
-
-
|
|
683
|
+
- [Style DSL](docs/dsl.md) — State maps, tokens, units, colors, extending semantics, recipes, and at-rules
|
|
684
|
+
- [Style Properties](docs/styles.md) — Every enhanced style property: syntax, values, and modifiers
|
|
685
|
+
- [React API](docs/react-api.md) — `tasty()`, component props, variants, sub-elements, and style functions
|
|
686
|
+
- [Configuration](docs/configuration.md) — Everything `configure()` accepts
|
|
687
|
+
- [Plugins & Extension Points](docs/plugins.md) — Custom style handlers, props middleware, and typing your extension
|
|
688
|
+
- [Style Rules for AI Agents](docs/ai-agents.md) — A condensed brief for writing correct styles
|
|
667
689
|
|
|
668
|
-
|
|
690
|
+
**Rendering modes**
|
|
669
691
|
|
|
670
|
-
-
|
|
671
|
-
-
|
|
692
|
+
- [Server-Side Rendering](docs/ssr.md) — Next.js, Astro, and generic React SSR: streaming, cache hydration, and troubleshooting
|
|
693
|
+
- [Build-Time Extraction (`tastyStatic`)](docs/tasty-static.md) — Babel plugin setup, Next.js integration, and static style patterns
|
|
672
694
|
|
|
673
|
-
|
|
695
|
+
**Internals**
|
|
674
696
|
|
|
675
|
-
-
|
|
676
|
-
-
|
|
677
|
-
-
|
|
697
|
+
- [Style rendering pipeline](docs/pipeline.md) — How state maps become mutually exclusive CSS rules
|
|
698
|
+
- [Style Injector](docs/injector.md) — Deduplication, reference counting, cleanup, SSR, and Shadow DOM
|
|
699
|
+
- [Debug Utilities](docs/debug.md) — Inspecting CSS, elements, caches, and chunks at runtime
|
|
700
|
+
- [Runtime Benchmarks](docs/runtime-benchmarks.md) — Methodology and results
|
|
678
701
|
|
|
679
|
-
|
|
702
|
+
**Upgrading**
|
|
680
703
|
|
|
681
|
-
-
|
|
704
|
+
- [Migration Guide (v2 → v3)](docs/migration-v3.md) — Every breaking change in 3.0, with a search-and-replace cheat sheet
|
|
682
705
|
|
|
683
706
|
## License
|
|
684
707
|
|