@tenphi/tasty 0.0.0-snapshot.5776c4c → 0.0.0-snapshot.57effc3
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 +432 -394
- package/dist/babel-types-C_7kRP38.d.ts +18 -0
- package/dist/chunks/async-storage-CG5HnUT5.js +20 -0
- package/dist/chunks/async-storage-CG5HnUT5.js.map +1 -0
- package/dist/chunks/build-config-l2Ys-AJr.js +60 -0
- package/dist/chunks/build-config-l2Ys-AJr.js.map +1 -0
- package/dist/{collector-D1pex769.js → chunks/collector-CaNtsRtn.js} +25 -119
- package/dist/chunks/collector-CaNtsRtn.js.map +1 -0
- package/dist/chunks/config-engine-CpExZO_T.js +272 -0
- package/dist/chunks/config-engine-CpExZO_T.js.map +1 -0
- package/dist/chunks/css-definitions-DAIJxzFY.js +899 -0
- package/dist/chunks/css-definitions-DAIJxzFY.js.map +1 -0
- package/dist/chunks/css-resources-P7IBUUZs.js +142 -0
- package/dist/chunks/css-resources-P7IBUUZs.js.map +1 -0
- package/dist/chunks/debug-CKy49GEr.js +502 -0
- package/dist/chunks/debug-CKy49GEr.js.map +1 -0
- package/dist/chunks/dsl-DRhFWQzo.js +1378 -0
- package/dist/chunks/dsl-DRhFWQzo.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-oi6i3ELR.js +582 -0
- package/dist/chunks/react-runtime-oi6i3ELR.js.map +1 -0
- package/dist/chunks/runtime-engine-DoULyhPt.js +2415 -0
- package/dist/chunks/runtime-engine-DoULyhPt.js.map +1 -0
- package/dist/chunks/runtime-state-CZ2J5QiZ.js +141 -0
- package/dist/chunks/runtime-state-CZ2J5QiZ.js.map +1 -0
- package/dist/{merge-styles-BuJ9D2RR.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-CeKsjtIr.js +5406 -0
- package/dist/chunks/style-engine-CeKsjtIr.js.map +1 -0
- package/dist/{css-writer-DV8qqkcl.js → chunks/zero-engine-fxKu8Jbn.js} +51 -146
- package/dist/chunks/zero-engine-fxKu8Jbn.js.map +1 -0
- package/dist/{collector-D8o4Wdq-.d.ts → collector-w4mBj5gd.d.ts} +23 -4
- package/dist/{config-De8L9NWM.d.ts → config-CrZOfNJ5.d.ts} +248 -71
- package/dist/core/index.d.ts +5 -5
- package/dist/core/index.js +9 -6
- package/dist/{index-DzGxoeyN.d.ts → index-CYJtAI9a.d.ts} +315 -248
- package/dist/index.d.ts +5 -5
- package/dist/index.js +11 -867
- package/dist/{merge-styles-DLm4wdnb.d.ts → merge-styles-VXwJ0Frr.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 +10 -0
- package/dist/ssr/astro-middleware-extract-static.js +9 -0
- package/dist/ssr/astro-middleware-extract-static.js.map +1 -0
- package/dist/ssr/astro-middleware-extract.d.ts +10 -0
- package/dist/ssr/astro-middleware-extract.js +9 -0
- package/dist/ssr/astro-middleware-extract.js.map +1 -0
- package/dist/ssr/astro-middleware-static.d.ts +3 -2
- package/dist/ssr/astro-middleware-static.js +0 -11
- package/dist/ssr/astro-middleware-static.js.map +1 -1
- package/dist/ssr/astro-middleware.d.ts +3 -2
- package/dist/ssr/astro-middleware.js +0 -12
- package/dist/ssr/astro-middleware.js.map +1 -1
- package/dist/ssr/astro.d.ts +40 -6
- package/dist/ssr/astro.js +157 -93
- package/dist/ssr/astro.js.map +1 -1
- package/dist/ssr/index.d.ts +10 -11
- package/dist/ssr/index.js +4 -4
- package/dist/ssr/index.js.map +1 -1
- package/dist/ssr/next-config.d.ts +64 -0
- package/dist/ssr/next-config.js +134 -0
- package/dist/ssr/next-config.js.map +1 -0
- package/dist/ssr/next.d.ts +9 -8
- package/dist/ssr/next.js +29 -43
- 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-KUYya3x7.d.ts → types-JEY8PVYP.d.ts} +736 -585
- package/dist/zero/babel.d.ts +67 -2
- package/dist/zero/babel.js +57 -131
- package/dist/zero/babel.js.map +1 -1
- package/dist/zero/index.d.ts +44 -8
- package/dist/zero/index.js +24 -2
- package/dist/zero/index.js.map +1 -0
- package/dist/zero/next.d.ts +4 -5
- package/dist/zero/next.js +0 -31
- package/dist/zero/next.js.map +1 -1
- package/docs/README.md +16 -8
- package/docs/adoption.md +69 -36
- package/docs/ai-agents.md +115 -86
- package/docs/comparison.md +77 -47
- package/docs/configuration.md +420 -110
- package/docs/debug.md +21 -8
- package/docs/design-system.md +152 -31
- package/docs/dsl.md +384 -223
- package/docs/getting-started.md +130 -50
- package/docs/injector.md +115 -68
- package/docs/methodology.md +80 -49
- package/docs/migration-v3.md +51 -51
- package/docs/pipeline.md +53 -29
- package/docs/plugins.md +58 -74
- package/docs/react-api.md +95 -52
- package/docs/runtime-benchmarks.md +388 -0
- package/docs/ssr.md +277 -99
- package/docs/styles.md +117 -30
- package/docs/tasty-static.md +245 -135
- package/package.json +104 -33
- package/dist/async-storage-DKK-wTD4.js +0 -44
- package/dist/async-storage-DKK-wTD4.js.map +0 -1
- package/dist/babel-R2qT7yLN.d.ts +0 -83
- package/dist/collector-D1pex769.js.map +0 -1
- package/dist/config-CDJO8DN9.js +0 -12466
- package/dist/config-CDJO8DN9.js.map +0 -1
- package/dist/context-CA8YKeMn.js +0 -24
- package/dist/context-CA8YKeMn.js.map +0 -1
- package/dist/core-DmxNMb3R.js +0 -1552
- package/dist/core-DmxNMb3R.js.map +0 -1
- package/dist/css-writer-DV8qqkcl.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-BOGf3wUd.js +0 -145
- package/dist/format-rules-BOGf3wUd.js.map +0 -1
- package/dist/hydrate-D6mHoNz1.js +0 -37
- package/dist/hydrate-D6mHoNz1.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/keyframes-DKYnKtc3.js +0 -424
- package/dist/keyframes-DKYnKtc3.js.map +0 -1
- package/dist/merge-styles-BuJ9D2RR.js.map +0 -1
- package/dist/resolve-recipes-EQ5mpGEp.js +0 -144
- package/dist/resolve-recipes-EQ5mpGEp.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,60 +1,54 @@
|
|
|
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>
|
|
9
|
-
|
|
8
|
+
<strong>CSS-in-JS for React design systems.</strong><br />
|
|
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
|
-
Tasty is a styling engine for design
|
|
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
|
-
|
|
23
|
-
|
|
24
|
-
That is the core guarantee: component styling resolves from declared state logic, not from source-order accidents or specificity fights.
|
|
25
|
-
|
|
26
|
-
The practical payoff shows up later: adding states, variants, and overrides stays inside the state map instead of reopening selector logic by hand.
|
|
22
|
+
```tsx
|
|
23
|
+
import { tasty } from '@tenphi/tasty';
|
|
27
24
|
|
|
28
|
-
|
|
25
|
+
const Button = tasty({
|
|
26
|
+
as: 'button',
|
|
27
|
+
styles: {
|
|
28
|
+
fill: {
|
|
29
|
+
'': '#primary',
|
|
30
|
+
':hover': '#primary-hover',
|
|
31
|
+
':active': '#primary-pressed',
|
|
32
|
+
'[disabled]': '#surface',
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
```
|
|
29
37
|
|
|
30
|
-
|
|
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.
|
|
31
39
|
|
|
32
|
-
- **
|
|
33
|
-
- **
|
|
34
|
-
- **
|
|
35
|
-
- **Ready to build?** Go to [Getting Started](docs/getting-started.md).
|
|
40
|
+
- **Ready to try it?** Follow [Getting Started](docs/getting-started.md).
|
|
41
|
+
- **Evaluating fit?** Read [Comparison](docs/comparison.md) and the [Adoption Guide](docs/adoption.md).
|
|
42
|
+
- **Building a component library?** See [Methodology](docs/methodology.md) and [Building a Design System](docs/design-system.md).
|
|
36
43
|
|
|
37
44
|
## Why Tasty
|
|
38
45
|
|
|
39
|
-
- **
|
|
40
|
-
- **
|
|
41
|
-
- **
|
|
42
|
-
- **
|
|
43
|
-
- **
|
|
44
|
-
|
|
45
|
-
### Supporting capabilities
|
|
46
|
-
|
|
47
|
-
- **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).
|
|
48
|
-
- **Server-compatible by default, zero client JS in server-only contexts** — All `tasty()` components and style functions are hook-free. In server-only rendering (Next.js RSC, Astro without islands, SSG), they produce zero client JavaScript with the full feature set. Add SSR integration only when your app also has client-side hydration. Use `tastyStatic()` only when you need build-time extraction without React.
|
|
49
|
-
- **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.
|
|
50
|
-
- **Performance and caching** — Runtime mode injects CSS on demand, reuses chunks aggressively, and relies on multi-level caching so large component systems stay practical.
|
|
51
|
-
- **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.
|
|
52
|
-
|
|
53
|
-
## Why It Exists
|
|
54
|
-
|
|
55
|
-
Modern component styling becomes fragile when multiple selectors can still win for the same property. Hover, disabled, theme, breakpoint, parent state, and root state rules start competing through specificity and source order.
|
|
56
|
-
|
|
57
|
-
Tasty replaces that competition with explicit state-map resolution. Each property compiles into mutually exclusive branches, so component styling stays deterministic as systems grow. 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)
|
|
58
52
|
|
|
59
53
|
## Installation
|
|
60
54
|
|
|
@@ -62,33 +56,13 @@ Tasty replaces that competition with explicit state-map resolution. Each propert
|
|
|
62
56
|
pnpm add @tenphi/tasty
|
|
63
57
|
```
|
|
64
58
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
- Node.js 20+
|
|
68
|
-
- React 18+ (peer dependency for the React entry points)
|
|
69
|
-
- `pnpm`, `npm`, or `yarn`
|
|
70
|
-
|
|
71
|
-
Other package managers:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
npm add @tenphi/tasty
|
|
75
|
-
yarn add @tenphi/tasty
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## Start Here
|
|
79
|
-
|
|
80
|
-
For the fuller docs map beyond the quick routes above, start here:
|
|
81
|
-
|
|
82
|
-
- **[Comparison](docs/comparison.md)** — read this first if you are evaluating whether Tasty fits your team's styling model
|
|
83
|
-
- **[Adoption Guide](docs/adoption.md)** — understand who Tasty is for, where it fits, and how to introduce it incrementally
|
|
84
|
-
- **[Getting Started](docs/getting-started.md)** — the canonical onboarding path: install, first component, optional shared `configure()`, ESLint, editor tooling, and rendering mode selection
|
|
85
|
-
- **[Style rendering pipeline](docs/pipeline.md)** — see the selector model behind deterministic style resolution
|
|
86
|
-
- **[Docs Hub](docs/README.md)** — choose docs by role and task: runtime, zero-runtime, runtime SSR integration, design-system authoring, internals, and debugging
|
|
87
|
-
- **[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.
|
|
88
60
|
|
|
89
61
|
## Quick Start
|
|
90
62
|
|
|
91
|
-
###
|
|
63
|
+
### 1. Write a component
|
|
64
|
+
|
|
65
|
+
Plain CSS values work as-is, so a first component looks like CSS you already know:
|
|
92
66
|
|
|
93
67
|
```tsx
|
|
94
68
|
import { tasty } from '@tenphi/tasty';
|
|
@@ -97,140 +71,154 @@ const Card = tasty({
|
|
|
97
71
|
as: 'div',
|
|
98
72
|
styles: {
|
|
99
73
|
display: 'flex',
|
|
100
|
-
flow: 'column',
|
|
74
|
+
flow: 'column', // flex-flow
|
|
101
75
|
padding: '24px',
|
|
102
76
|
gap: '12px',
|
|
103
|
-
fill: 'white',
|
|
77
|
+
fill: 'white', // background-color
|
|
104
78
|
color: '#222',
|
|
105
79
|
border: '1px solid #ddd',
|
|
106
|
-
radius: '12px',
|
|
80
|
+
radius: '12px', // border-radius
|
|
107
81
|
},
|
|
108
82
|
});
|
|
109
83
|
|
|
110
|
-
|
|
111
|
-
<Card>Hello World</Card>
|
|
84
|
+
<Card>Hello World</Card>;
|
|
112
85
|
```
|
|
113
86
|
|
|
114
|
-
|
|
87
|
+
### 2. Bring in your design system
|
|
115
88
|
|
|
116
|
-
|
|
89
|
+
Call `configure()` once, before your app renders, to define the vocabulary every component shares:
|
|
117
90
|
|
|
118
|
-
|
|
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
|
+
```
|
|
119
109
|
|
|
120
|
-
|
|
110
|
+
The same card, written in that vocabulary:
|
|
111
|
+
|
|
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
|
+
```
|
|
126
|
+
|
|
127
|
+
The component never mentions dark mode, yet it follows the `@dark` tokens. Change a token or a unit once and every component follows.
|
|
128
|
+
|
|
129
|
+
### 3. Add states and a typed API
|
|
121
130
|
|
|
122
131
|
```tsx
|
|
123
132
|
const Button = tasty({
|
|
124
133
|
as: 'button',
|
|
134
|
+
modProps: { isLoading: Boolean, size: ['sm', 'md', 'lg'] as const },
|
|
125
135
|
styles: {
|
|
126
|
-
padding: '1.5x 3x',
|
|
136
|
+
padding: { '': '1.5x 3x', 'size=sm': '1x 2x', 'size=lg': '2x 4x' },
|
|
137
|
+
radius: '1r',
|
|
127
138
|
fill: {
|
|
128
139
|
'': '#primary',
|
|
129
140
|
':hover': '#primary-hover',
|
|
130
141
|
':active': '#primary-pressed',
|
|
131
|
-
|
|
132
|
-
},
|
|
133
|
-
color: {
|
|
134
|
-
'': '#on-primary',
|
|
135
|
-
'[disabled]': '#text.40',
|
|
136
|
-
},
|
|
137
|
-
cursor: {
|
|
138
|
-
'': 'pointer',
|
|
139
|
-
'[disabled]': 'not-allowed',
|
|
142
|
+
disabled: '#surface',
|
|
140
143
|
},
|
|
144
|
+
color: { '': '#on-primary', disabled: '#text.40' },
|
|
145
|
+
cursor: { '': 'pointer', isLoading: 'wait', disabled: 'not-allowed' },
|
|
141
146
|
transition: 'theme',
|
|
142
147
|
},
|
|
143
148
|
});
|
|
149
|
+
|
|
150
|
+
<Button size="lg" isLoading>
|
|
151
|
+
Save
|
|
152
|
+
</Button>;
|
|
153
|
+
// renders <button data-is-loading data-size="lg" class="…">
|
|
144
154
|
```
|
|
145
155
|
|
|
146
|
-
|
|
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.
|
|
147
157
|
|
|
148
|
-
### Extend
|
|
158
|
+
### 4. Extend a component
|
|
149
159
|
|
|
150
160
|
```tsx
|
|
151
|
-
import { Button } from 'my-ui-lib';
|
|
152
|
-
|
|
153
161
|
const DangerButton = tasty(Button, {
|
|
154
162
|
styles: {
|
|
155
163
|
fill: {
|
|
156
164
|
'': '#danger',
|
|
157
165
|
':hover': '#danger-hover',
|
|
166
|
+
':active': '#danger-pressed',
|
|
167
|
+
disabled: '@inherit', // keep the parent's disabled branch
|
|
158
168
|
},
|
|
159
169
|
},
|
|
160
170
|
});
|
|
161
171
|
```
|
|
162
172
|
|
|
163
|
-
|
|
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).
|
|
164
174
|
|
|
165
|
-
|
|
175
|
+
[Getting Started](docs/getting-started.md) continues from here with setup, linting, editor tooling, and choosing a rendering mode.
|
|
166
176
|
|
|
167
|
-
|
|
168
|
-
import { configure } from '@tenphi/tasty';
|
|
177
|
+
## How It Works
|
|
169
178
|
|
|
170
|
-
|
|
171
|
-
states: {
|
|
172
|
-
'@mobile': '@media(w < 768px)',
|
|
173
|
-
'@tablet': '@media(w < 1024px)',
|
|
174
|
-
'@dark': '@root(schema=dark) | (!@root(schema) & @media(prefers-color-scheme: dark))',
|
|
175
|
-
},
|
|
176
|
-
recipes: {
|
|
177
|
-
card: { padding: '4x', fill: '#surface', radius: '1r', border: true },
|
|
178
|
-
},
|
|
179
|
-
});
|
|
180
|
-
```
|
|
179
|
+
The cascade resolves conflicts by specificity, then by source order. Take two rules for a button's background:
|
|
181
180
|
|
|
182
|
-
|
|
181
|
+
```css
|
|
182
|
+
.btn:hover {
|
|
183
|
+
background: dodgerblue;
|
|
184
|
+
}
|
|
185
|
+
.btn[disabled] {
|
|
186
|
+
background: gray;
|
|
187
|
+
}
|
|
188
|
+
```
|
|
183
189
|
|
|
184
|
-
|
|
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.
|
|
185
191
|
|
|
186
|
-
|
|
192
|
+
Tasty removes the competition. For the same intent:
|
|
187
193
|
|
|
188
194
|
```tsx
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
195
|
+
fill: {
|
|
196
|
+
'': '#primary',
|
|
197
|
+
':hover': '#primary-hover',
|
|
198
|
+
'[disabled]': '#surface',
|
|
199
|
+
}
|
|
192
200
|
```
|
|
193
201
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
## Choose a Styling Approach
|
|
197
|
-
|
|
198
|
-
Once you understand the component model, pick the rendering mode that matches your app.
|
|
199
|
-
|
|
200
|
-
| Approach | Entry point | Best for | Trade-off |
|
|
201
|
-
|----------|-------------|----------|-----------|
|
|
202
|
-
| **Runtime (default)** | `tasty()` from `@tenphi/tasty` | All React apps — server-rendered by default, zero client JS until you need interactivity | Full feature set; CSS computed during React rendering (server or client) |
|
|
203
|
-
| **Runtime + SSR integration** | Add `@tenphi/tasty/ssr/*` | Apps with client-side hydration (Next.js client components, Astro islands) | Adds CSS deduplication, FOUC prevention, and client cache hydration |
|
|
204
|
-
| **Zero-runtime** | `tastyStatic()` from `@tenphi/tasty/static` | Non-React frameworks or when you need build-time extraction without React | Requires the Babel plugin; no component-level `styleProps` or runtime-only APIs |
|
|
205
|
-
|
|
206
|
-
All `tasty()` components are hook-free and work as React Server Components. In server-only contexts — Next.js RSC without `'use client'`, Astro without `client:*` directives, and other SSG setups — they produce the same end result as `tastyStatic()` (static HTML + CSS, zero client JavaScript) but with the full feature set including `styleProps`, sub-elements, and variants. SSR integration is only needed when your app also has client-side rendering. See [Getting Started](docs/getting-started.md#choosing-a-rendering-mode), [Zero Runtime](docs/tasty-static.md), and [Server-Side Rendering](docs/ssr.md).
|
|
207
|
-
|
|
208
|
-
## How It Actually Works
|
|
209
|
-
|
|
210
|
-
This is the core idea that makes everything else possible.
|
|
211
|
-
|
|
212
|
-
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)**.
|
|
213
|
-
|
|
214
|
-
### The structural problem with normal CSS
|
|
215
|
-
|
|
216
|
-
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.
|
|
217
|
-
|
|
218
|
-
A small example makes this tangible. Two rules for a button's background:
|
|
202
|
+
it generates:
|
|
219
203
|
|
|
220
204
|
```css
|
|
221
|
-
.
|
|
222
|
-
|
|
205
|
+
.t0.t0:where(:not([disabled]):not(:hover)) {
|
|
206
|
+
background-color: var(--primary-color);
|
|
207
|
+
}
|
|
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);
|
|
213
|
+
}
|
|
223
214
|
```
|
|
224
215
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
### Why real state logic is hard to author by hand
|
|
228
|
-
|
|
229
|
-
Authoring selectors that capture real-world state logic is fundamentally hard. A single state like "dark mode" may depend on a root attribute, an OS preference, or both — each branch needing its own selector, proper negation of competing branches, and correct `@media` nesting. The example below shows the CSS you'd write by hand for just *one* property with *one* state. Scale that across dozens of properties, then add breakpoints and container queries, and the selector logic quickly becomes unmanageable.
|
|
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.
|
|
230
217
|
|
|
231
|
-
|
|
218
|
+
<details>
|
|
219
|
+
<summary><strong>A harder case: dark mode from a root attribute or the OS preference</strong></summary>
|
|
232
220
|
|
|
233
|
-
|
|
221
|
+
Say `@dark` means "the root has `data-schema="dark"`, or no schema is set and the OS prefers dark":
|
|
234
222
|
|
|
235
223
|
```tsx
|
|
236
224
|
const Text = tasty({
|
|
@@ -239,371 +227,425 @@ const Text = tasty({
|
|
|
239
227
|
'': '#text',
|
|
240
228
|
'@dark': '#text-on-dark',
|
|
241
229
|
},
|
|
242
|
-
padding: {
|
|
243
|
-
'': '4x',
|
|
244
|
-
'@mobile': '2x',
|
|
245
|
-
},
|
|
246
230
|
},
|
|
247
231
|
});
|
|
248
232
|
```
|
|
249
233
|
|
|
250
|
-
|
|
234
|
+
A first attempt by hand:
|
|
251
235
|
|
|
252
236
|
```css
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
237
|
+
.t0 {
|
|
238
|
+
color: var(--text-color);
|
|
239
|
+
}
|
|
240
|
+
:root[data-schema='dark'] .t0 {
|
|
241
|
+
color: var(--text-on-dark-color);
|
|
258
242
|
}
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
The `@media` branch fires even when `data-schema="light"` is explicitly set. Fix that:
|
|
262
|
-
|
|
263
|
-
```css
|
|
264
|
-
/* Second attempt — @media is scoped, but the default is still too broad */
|
|
265
|
-
.t0 { color: var(--text-color); }
|
|
266
|
-
:root[data-schema="dark"] .t0 { color: var(--text-on-dark-color); }
|
|
267
243
|
@media (prefers-color-scheme: dark) {
|
|
268
|
-
|
|
244
|
+
.t0 {
|
|
245
|
+
color: var(--text-on-dark-color);
|
|
246
|
+
}
|
|
269
247
|
}
|
|
270
248
|
```
|
|
271
249
|
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
This is just *one* property with *one* state, and getting it right already takes multiple iterations. The correct selectors require negating every other branch — which is exactly what Tasty generates automatically:
|
|
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:
|
|
275
251
|
|
|
276
252
|
```css
|
|
277
|
-
/*
|
|
278
|
-
:root[data-schema=
|
|
253
|
+
/* Explicit dark schema */
|
|
254
|
+
:where(:root[data-schema='dark']) .t0.t0 {
|
|
279
255
|
color: var(--text-on-dark-color);
|
|
280
256
|
}
|
|
281
257
|
|
|
282
|
-
/*
|
|
258
|
+
/* No schema attribute, OS prefers dark */
|
|
283
259
|
@media (prefers-color-scheme: dark) {
|
|
284
|
-
:root:not([data-schema]) .t0.t0 {
|
|
260
|
+
:where(:root:not([data-schema])) .t0.t0 {
|
|
285
261
|
color: var(--text-on-dark-color);
|
|
286
262
|
}
|
|
287
263
|
}
|
|
288
264
|
|
|
289
|
-
/* Default:
|
|
265
|
+
/* Default: OS prefers light, schema is not dark */
|
|
290
266
|
@media (not (prefers-color-scheme: dark)) {
|
|
291
|
-
:root:not([data-schema=
|
|
267
|
+
:where(:root:not([data-schema='dark'])) .t0.t0 {
|
|
292
268
|
color: var(--text-color);
|
|
293
269
|
}
|
|
294
270
|
}
|
|
295
271
|
|
|
296
|
-
/* Default:
|
|
297
|
-
|
|
298
|
-
|
|
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
|
+
}
|
|
299
277
|
}
|
|
300
278
|
```
|
|
301
279
|
|
|
302
|
-
|
|
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.
|
|
303
281
|
|
|
304
|
-
|
|
282
|
+
</details>
|
|
305
283
|
|
|
306
|
-
|
|
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)
|
|
307
285
|
|
|
308
|
-
|
|
286
|
+
## Design-System Integration
|
|
309
287
|
|
|
310
|
-
|
|
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.
|
|
311
289
|
|
|
312
|
-
|
|
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 |
|
|
313
300
|
|
|
314
|
-
|
|
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).
|
|
315
302
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
```tsx
|
|
319
|
-
fill: '#surface', // → var(--surface-color)
|
|
320
|
-
color: '#text.80', // → 80% opacity text token
|
|
321
|
-
padding: '2x', // → calc(var(--gap) * 2)
|
|
322
|
-
radius: '1r', // → var(--radius)
|
|
323
|
-
border: '1bw solid #border',
|
|
324
|
-
```
|
|
303
|
+
### Built-in units
|
|
325
304
|
|
|
326
|
-
| Unit |
|
|
327
|
-
|
|
328
|
-
| `x`
|
|
329
|
-
| `r`
|
|
330
|
-
| `
|
|
331
|
-
| `
|
|
332
|
-
| `
|
|
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)` |
|
|
333
313
|
|
|
334
|
-
|
|
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)'`.
|
|
335
315
|
|
|
336
|
-
###
|
|
337
|
-
|
|
338
|
-
Every style property accepts a state mapping object. Keys can be combined with boolean logic:
|
|
339
|
-
|
|
340
|
-
| State type | Syntax | CSS output |
|
|
341
|
-
|------------|--------|------------|
|
|
342
|
-
| Data attribute (boolean modifier) | `disabled` | `[data-disabled]` |
|
|
343
|
-
| Data attribute (value modifier) | `theme=danger` | `[data-theme="danger"]` |
|
|
344
|
-
| Pseudo-class | `:hover` | `:hover` |
|
|
345
|
-
| Attribute selector | `[role="tab"]` | `[role="tab"]` |
|
|
346
|
-
| Class selector (supported) | `.is-active` | `.is-active` |
|
|
347
|
-
| Media query | `@media(w < 768px)` | `@media (width < 768px)` |
|
|
348
|
-
| Container query | `@(panel, w >= 300px)` | `@container panel (width >= 300px)` |
|
|
349
|
-
| Root state | `@root(schema=dark)` | `:root[data-schema="dark"]` |
|
|
350
|
-
| Parent state | `@parent(theme=danger)` | `:is([data-theme="danger"] *)` |
|
|
351
|
-
| Feature query | `@supports(display: grid)` | `@supports (display: grid)` |
|
|
352
|
-
| Entry animation | `@starting` | `@starting-style` |
|
|
316
|
+
### Recipes
|
|
353
317
|
|
|
354
|
-
|
|
318
|
+
Recipes are reusable style bundles, state maps included:
|
|
355
319
|
|
|
356
320
|
```tsx
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
}
|
|
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' } });
|
|
362
329
|
```
|
|
363
330
|
|
|
364
|
-
|
|
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
|
-
### Style
|
|
339
|
+
### Style props
|
|
373
340
|
|
|
374
|
-
`styleProps`
|
|
341
|
+
`styleProps` turns selected style properties into props. They accept state maps, so responsive values use the same syntax:
|
|
375
342
|
|
|
376
343
|
```tsx
|
|
344
|
+
import { tasty, FLOW_STYLES } from '@tenphi/tasty';
|
|
345
|
+
|
|
377
346
|
const Space = tasty({
|
|
378
347
|
styles: { display: 'flex', flow: 'column', gap: '1x' },
|
|
379
348
|
styleProps: FLOW_STYLES,
|
|
380
349
|
});
|
|
381
350
|
|
|
382
|
-
<Space flow="row" gap={{ '': '2x', '@
|
|
351
|
+
<Space flow="row" gap={{ '': '2x', '@mobile': '1x' }} />;
|
|
383
352
|
```
|
|
384
353
|
|
|
385
|
-
|
|
354
|
+
### Mod props
|
|
386
355
|
|
|
387
|
-
|
|
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.
|
|
388
357
|
|
|
389
|
-
|
|
358
|
+
### Token props
|
|
359
|
+
|
|
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:
|
|
390
361
|
|
|
391
362
|
```tsx
|
|
392
|
-
const
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
363
|
+
const Progress = tasty({
|
|
364
|
+
tokenProps: ['progress', 'accentColor'] as const,
|
|
365
|
+
styles: { width: '$progress', fill: '#accent' },
|
|
366
|
+
});
|
|
367
|
+
|
|
368
|
+
<Progress progress="75%" accentColor="#purple" />;
|
|
369
|
+
// style="--progress:75%;--accent-color:var(--purple-color)"
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Variants
|
|
373
|
+
|
|
374
|
+
Variants are named style sets. `variant` is typed from their keys, `default` 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' },
|
|
398
382
|
},
|
|
399
383
|
});
|
|
400
384
|
|
|
401
|
-
<
|
|
385
|
+
<Badge variant="danger">Failed</Badge>;
|
|
402
386
|
```
|
|
403
387
|
|
|
404
|
-
|
|
388
|
+
### Sub-elements
|
|
405
389
|
|
|
406
|
-
|
|
390
|
+
Compound components style their inner parts from one definition. `elements` produces typed sub-components:
|
|
407
391
|
|
|
408
|
-
|
|
392
|
+
```tsx
|
|
393
|
+
const Card = tasty({
|
|
394
|
+
styles: {
|
|
395
|
+
padding: '4x',
|
|
396
|
+
Title: { preset: 'h3', color: { '': '#text', ':hover': '#primary' } },
|
|
397
|
+
Content: { color: '#text' },
|
|
398
|
+
},
|
|
399
|
+
elements: { Title: 'h3', Content: 'div' },
|
|
400
|
+
});
|
|
409
401
|
|
|
410
|
-
|
|
402
|
+
<Card>
|
|
403
|
+
<Card.Title>Revenue</Card.Title>
|
|
404
|
+
<Card.Content>Up 12% this week</Card.Content>
|
|
405
|
+
</Card>;
|
|
406
|
+
```
|
|
411
407
|
|
|
412
|
-
|
|
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.
|
|
413
409
|
|
|
414
|
-
|
|
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).
|
|
415
411
|
|
|
416
|
-
|
|
412
|
+
## Types and Linting
|
|
417
413
|
|
|
418
|
-
|
|
414
|
+
### TypeScript
|
|
419
415
|
|
|
420
|
-
|
|
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:
|
|
421
417
|
|
|
422
|
-
|
|
418
|
+
```ts
|
|
419
|
+
// tasty.d.ts
|
|
420
|
+
import '@tenphi/tasty';
|
|
423
421
|
|
|
424
|
-
|
|
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
|
+
```
|
|
425
439
|
|
|
426
|
-
See [
|
|
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).
|
|
427
441
|
|
|
428
|
-
###
|
|
442
|
+
### ESLint and oxlint
|
|
429
443
|
|
|
430
|
-
|
|
444
|
+
[`@tenphi/eslint-plugin-tasty`](https://github.com/tenphi/eslint-plugin-tasty) validates style objects and JSX style props at lint time:
|
|
431
445
|
|
|
432
|
-
|
|
446
|
+
```bash
|
|
447
|
+
pnpm add -D @tenphi/eslint-plugin-tasty
|
|
448
|
+
```
|
|
433
449
|
|
|
434
|
-
|
|
450
|
+
```js
|
|
451
|
+
// eslint.config.js
|
|
452
|
+
import tasty from '@tenphi/eslint-plugin-tasty';
|
|
435
453
|
|
|
436
|
-
|
|
454
|
+
export default [tasty.configs.recommended]; // or tasty.configs.strict
|
|
455
|
+
```
|
|
437
456
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
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
|
+
};
|
|
447
468
|
```
|
|
448
469
|
|
|
449
|
-
|
|
470
|
+
With that in place, `recommended` catches:
|
|
450
471
|
|
|
451
|
-
|
|
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" />`
|
|
452
478
|
|
|
453
|
-
|
|
479
|
+
The same rule sets run under oxlint. See the [plugin README](https://github.com/tenphi/eslint-plugin-tasty) for every rule and option.
|
|
454
480
|
|
|
455
|
-
|
|
481
|
+
## CSS Coverage
|
|
456
482
|
|
|
457
|
-
|
|
483
|
+
Every style property accepts a state map, and every kind of condition is a state key:
|
|
458
484
|
|
|
459
|
-
|
|
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` |
|
|
460
499
|
|
|
461
|
-
|
|
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).
|
|
462
501
|
|
|
463
|
-
|
|
502
|
+
At-rules live next to the styles that use them:
|
|
464
503
|
|
|
465
|
-
|
|
504
|
+
```tsx
|
|
505
|
+
const Spinner = tasty({
|
|
506
|
+
styles: {
|
|
507
|
+
'@keyframes': { spin: { to: { transform: 'rotate(360deg)' } } },
|
|
508
|
+
animation: 'spin 1s linear infinite',
|
|
509
|
+
},
|
|
510
|
+
});
|
|
511
|
+
```
|
|
466
512
|
|
|
467
|
-
|
|
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.
|
|
468
517
|
|
|
469
|
-
|
|
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.
|
|
470
519
|
|
|
471
|
-
###
|
|
520
|
+
### Style functions
|
|
472
521
|
|
|
473
|
-
|
|
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`. Apart from `useStyles`, which reads React context, they are plain functions despite the `use` prefix, so they work in React Server Components and outside React; `computeStyles` is the hook-free equivalent of `useStyles`. See [React API — Style Functions](docs/react-api.md#style-functions).
|
|
474
523
|
|
|
475
|
-
|
|
524
|
+
## Rendering Modes
|
|
476
525
|
|
|
477
|
-
|
|
478
|
-
- `@tenphi/tasty/ssr/astro` for Astro (with or without islands)
|
|
479
|
-
- The core SSR API for other React SSR setups
|
|
526
|
+
The DSL, tokens, units, state maps, and recipes are the same everywhere. What changes is where CSS is generated:
|
|
480
527
|
|
|
481
|
-
|
|
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 |
|
|
482
533
|
|
|
483
|
-
|
|
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 and global styles are not emitted, so use one for anything that relies on `configure()`.
|
|
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.
|
|
484
537
|
|
|
485
|
-
|
|
486
|
-
|--------|-------------|----------|
|
|
487
|
-
| `@tenphi/tasty` | Runtime style engine (`tasty`, style functions, `configure`) | Browser |
|
|
488
|
-
| `@tenphi/tasty/static` | Zero-runtime static styles (`tastyStatic`) | Browser |
|
|
489
|
-
| `@tenphi/tasty/static/inject` | Runtime helper the Babel plugin rewrites `tastyStatic` imports to in inject mode | Browser |
|
|
490
|
-
| `@tenphi/tasty/core` | Lower-level internals (config, parser, pipeline, injector, style handlers) for tooling and advanced use | Browser / Node |
|
|
491
|
-
| `@tenphi/tasty/babel-plugin` | Babel plugin for zero-runtime CSS extraction | Node |
|
|
492
|
-
| `@tenphi/tasty/zero` | Programmatic extraction API | Node |
|
|
493
|
-
| `@tenphi/tasty/zero/next` | Next.js integration wrapper | Node |
|
|
494
|
-
| `@tenphi/tasty/ssr` | Core SSR API (collector, context, hydration) | Node |
|
|
495
|
-
| `@tenphi/tasty/ssr/next` | Next.js App Router SSR integration | Node |
|
|
496
|
-
| `@tenphi/tasty/ssr/astro` | Astro integration + middleware | Node |
|
|
497
|
-
| `@tenphi/tasty/ssr/astro-client` | Astro client-side cache hydration | Browser |
|
|
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).
|
|
498
539
|
|
|
499
|
-
##
|
|
540
|
+
## Tooling
|
|
500
541
|
|
|
501
|
-
|
|
542
|
+
### ESLint plugin
|
|
502
543
|
|
|
503
|
-
|
|
504
|
-
- **Level-4 `:not()` with selector lists** — Chrome/Edge 88+, Firefox 84+, Safari 9+, Opera 75+.
|
|
505
|
-
- **Not supported:** IE 11.
|
|
544
|
+
Covered in [Types and Linting](#eslint-and-oxlint): 40+ rules for ESLint 9+ and oxlint, configured from `tasty.config.ts`.
|
|
506
545
|
|
|
507
|
-
|
|
546
|
+
### VS Code extension
|
|
508
547
|
|
|
509
|
-
|
|
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).
|
|
510
549
|
|
|
511
|
-
|
|
550
|
+
<p align="center">
|
|
551
|
+
<img src="assets/tasty-vscode-highlight.png" width="512" alt="Tasty VS Code syntax highlighting example" />
|
|
552
|
+
</p>
|
|
512
553
|
|
|
513
|
-
|
|
514
|
-
|-------------|------|
|
|
515
|
-
| `@tenphi/tasty` (runtime + SSR) | 50.19 kB |
|
|
516
|
-
| `@tenphi/tasty/core` (runtime, no SSR) | 47.76 kB |
|
|
517
|
-
| `@tenphi/tasty/static` (zero-runtime) | 16.43 kB |
|
|
518
|
-
| `@tenphi/tasty/zero` (programmatic extraction) | 29.6 kB |
|
|
519
|
-
| `@tenphi/tasty/babel-plugin` (Babel plugin entry) | 43.7 kB |
|
|
554
|
+
### Glaze
|
|
520
555
|
|
|
521
|
-
|
|
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):
|
|
522
557
|
|
|
523
|
-
|
|
558
|
+
```ts
|
|
559
|
+
import { glaze } from '@tenphi/glaze';
|
|
560
|
+
import { configure } from '@tenphi/tasty';
|
|
524
561
|
|
|
525
|
-
|
|
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
|
+
});
|
|
526
567
|
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
| `renderStyles` — 5 flat properties (cold) | ~60,000 | ~17 us |
|
|
530
|
-
| `renderStyles` — state map with media/hover/modifier (cold) | ~18,500 | ~54 us |
|
|
531
|
-
| `renderStyles` — same styles (cached) | ~5,800,000 | ~0.17 us |
|
|
532
|
-
| `parseStateKey` — simple key like `:hover` (cold) | ~790,000 | ~1.3 us |
|
|
533
|
-
| `parseStateKey` — complex OR/AND/NOT key (cold) | ~140,000 | ~7 us |
|
|
534
|
-
| `parseStateKey` — any key (cached) | ~3,400,000–8,300,000 | ~0.1–0.3 us |
|
|
535
|
-
| `parseStyle` — value tokens like `2x 4x` (cold) | ~344,000 | ~2.9 us |
|
|
536
|
-
| `parseStyle` — color tokens (cold) | ~567,000 | ~1.8 us |
|
|
537
|
-
| `parseStyle` — any value (cached) | ~15,250,000 | ~0.07 us |
|
|
568
|
+
configure({ tokens: theme.tasty() }); // #surface and #text, light and dark
|
|
569
|
+
```
|
|
538
570
|
|
|
539
|
-
|
|
571
|
+
### Debugging
|
|
540
572
|
|
|
541
|
-
|
|
573
|
+
`tastyDebug` inspects what Tasty injected, straight from the browser console:
|
|
542
574
|
|
|
543
|
-
|
|
575
|
+
```ts
|
|
576
|
+
import { tastyDebug } from '@tenphi/tasty';
|
|
544
577
|
|
|
545
|
-
|
|
546
|
-
-
|
|
547
|
-
|
|
548
|
-
- **Comparable to lighter systems.** Emotion's `css()` is typically 5–20 us for simple styles; Tasty's cold `renderStyles` at ~17 us for 5 properties is in the same range despite doing significantly more work (state maps, design tokens, sub-elements, chunking).
|
|
549
|
-
- **On slower devices.** The benchmarks above are from an M1 Max (Geekbench 6 SC ~2,400). A mid-range consumer laptop (~1,800 SC) is roughly 1.3x slower; a mid-range phone (~1,200 SC) is roughly 2x slower; a budget phone (~700 SC) is roughly 3–4x slower. Even at 4x, the heaviest cold operation stays under 250 us and 100 unique components under 25 ms — still well within a single frame budget. The cached path remains sub-microsecond on all devices.
|
|
578
|
+
tastyDebug.install(); // exposes window.tastyDebug
|
|
579
|
+
tastyDebug.inspect('.my-button'); // classes, chunks, and the CSS that applies
|
|
580
|
+
```
|
|
550
581
|
|
|
551
|
-
|
|
582
|
+
See [Debug Utilities](docs/debug.md).
|
|
552
583
|
|
|
553
|
-
|
|
554
|
-
- Multi-level caching avoids repeated parsing and style recomputation.
|
|
555
|
-
- Styles are split into reusable chunks and applied as multiple class names, so matching chunks can be reused across components instead of re-injected.
|
|
556
|
-
- Style normalization guarantees equivalent style input resolves to the same chunks, improving deduplication hit rates.
|
|
557
|
-
- A style garbage collector removes unused styles/chunks over time.
|
|
558
|
-
- A dedicated style injector minimizes DOM/style-tag overhead.
|
|
559
|
-
- This approach is validated in enterprise-scale apps where runtime styling overhead is not noticeable in normal UI flows.
|
|
584
|
+
### AI coding agents
|
|
560
585
|
|
|
561
|
-
|
|
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.
|
|
562
587
|
|
|
563
|
-
|
|
588
|
+
## Performance
|
|
564
589
|
|
|
565
|
-
###
|
|
590
|
+
### Bundle size
|
|
566
591
|
|
|
567
|
-
|
|
592
|
+
Measured with [size-limit](https://github.com/ai/size-limit): minified and brotli-compressed, including all dependencies.
|
|
568
593
|
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
594
|
+
| Entry point | Size |
|
|
595
|
+
| ------------------------------------------------- | -------- |
|
|
596
|
+
| `@tenphi/tasty`, importing `tasty` | 50.79 kB |
|
|
597
|
+
| `@tenphi/tasty`, everything | 57.54 kB |
|
|
598
|
+
| `@tenphi/tasty/core`, everything (no SSR) | 54.45 kB |
|
|
599
|
+
| `@tenphi/tasty/static` (build-time authoring API) | 920 B |
|
|
600
|
+
| `@tenphi/tasty/ssr/astro-client` | 283 B |
|
|
601
|
+
| `@tenphi/tasty/zero` (Node, build time) | 37.57 kB |
|
|
602
|
+
| `@tenphi/tasty/babel-plugin` (Node, build time) | 41.65 kB |
|
|
572
603
|
|
|
573
|
-
|
|
574
|
-
import tasty from '@tenphi/eslint-plugin-tasty';
|
|
575
|
-
export default [tasty.configs.recommended];
|
|
576
|
-
```
|
|
604
|
+
Run `pnpm size` to reproduce; numbers shift slightly between releases.
|
|
577
605
|
|
|
578
|
-
###
|
|
606
|
+
### Runtime
|
|
579
607
|
|
|
580
|
-
|
|
608
|
+
When styles are generated in the browser:
|
|
581
609
|
|
|
582
|
-
|
|
583
|
-
|
|
610
|
+
- CSS is generated and injected only for styles that are actually rendered.
|
|
611
|
+
- Styles are split into chunks and normalized, so equivalent styles resolve to the same classes and are reused across components instead of re-injected.
|
|
612
|
+
- Multi-level caching avoids re-parsing and recomputation.
|
|
613
|
+
- Unused styles can be garbage-collected over time with `configure({ gc })`, or on demand with `gc()` and `cleanup()`.
|
|
614
|
+
- Optional [batched injection](docs/configuration.md#batched-injection) groups stylesheet writes before layout reads.
|
|
615
|
+
- The approach runs in enterprise-scale apps where runtime styling overhead is not noticeable in normal UI flows.
|
|
584
616
|
|
|
585
|
-
|
|
586
|
-
theme.colors({
|
|
587
|
-
surface: { lightness: 97 },
|
|
588
|
-
text: { base: 'surface', lightness: '-52', contrast: 'AAA' },
|
|
589
|
-
});
|
|
617
|
+
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.
|
|
590
618
|
|
|
591
|
-
|
|
592
|
-
```
|
|
619
|
+
## Browser Support
|
|
593
620
|
|
|
594
|
-
|
|
621
|
+
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.
|
|
595
622
|
|
|
596
|
-
|
|
623
|
+
## Entry Points
|
|
597
624
|
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
625
|
+
| Import | Description | Platform |
|
|
626
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------- |
|
|
627
|
+
| `@tenphi/tasty` | React style engine (`tasty`, style functions, `configure`) | Browser / Node |
|
|
628
|
+
| `@tenphi/tasty/core` | Lower-level internals (config, parser, pipeline, injector, style handlers) for tooling and advanced use | Browser / Node |
|
|
629
|
+
| `@tenphi/tasty/static` | Build-time extraction authoring API (`tastyStatic`) | Build time |
|
|
630
|
+
| `@tenphi/tasty/static/inject` | Runtime helper the Babel plugin rewrites `tastyStatic` imports to in inject mode | Browser |
|
|
631
|
+
| `@tenphi/tasty/babel-plugin` | Babel plugin for build-time CSS extraction | Node |
|
|
632
|
+
| `@tenphi/tasty/zero` | Programmatic extraction API | Node |
|
|
633
|
+
| `@tenphi/tasty/zero/next` | Next.js wrapper for build-time extraction | Node |
|
|
634
|
+
| `@tenphi/tasty/ssr` | Core SSR API (collector, context, hydration) | Node |
|
|
635
|
+
| `@tenphi/tasty/ssr/next` | Next.js App Router SSR integration (`TastyRegistry`) | Node |
|
|
636
|
+
| `@tenphi/tasty/ssr/next-config` | Next.js config wrapper for a shared global stylesheet (`withTastyNext`) | Node |
|
|
637
|
+
| `@tenphi/tasty/ssr/astro` | Astro integration and middleware | Node |
|
|
638
|
+
| `@tenphi/tasty/ssr/astro-client` | Astro client-side cache hydration | Browser |
|
|
601
639
|
|
|
602
640
|
## Built with Tasty
|
|
603
641
|
|
|
604
642
|
### [tasty.style](https://tasty.style) ([source](https://github.com/tenphi/tasty.style))
|
|
605
643
|
|
|
606
|
-
The official Tasty documentation and landing page — itself built entirely with
|
|
644
|
+
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.
|
|
645
|
+
|
|
646
|
+
### [Cookbook](https://cookbook.tenphi.me) ([source](https://github.com/tenphi/cookbook))
|
|
647
|
+
|
|
648
|
+
`@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.
|
|
607
649
|
|
|
608
650
|
### [Cube Cloud](https://cube.dev/)
|
|
609
651
|
|
|
@@ -619,47 +661,43 @@ Open-source React UI kit built on Tasty + React Aria. 100+ production components
|
|
|
619
661
|
|
|
620
662
|
## Documentation
|
|
621
663
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
- **[Docs Hub](docs/README.md)** — audience-based navigation across onboarding, design-system authoring, runtime, zero-runtime, runtime SSR integration, debugging, and internals
|
|
625
|
-
|
|
626
|
-
### Start here
|
|
627
|
-
|
|
628
|
-
- **[Getting Started](docs/getting-started.md)** — Installation, first component, optional shared configuration, ESLint plugin setup, editor tooling, and rendering mode decision tree
|
|
629
|
-
- **[Methodology](docs/methodology.md)** — The recommended patterns for structuring Tasty components: root + sub-elements, styleProps, tokens, styles vs style, wrapping and extension
|
|
664
|
+
The [Docs Hub](docs/README.md) routes you by role, rendering mode, and task.
|
|
630
665
|
|
|
631
|
-
|
|
666
|
+
**Start here**
|
|
632
667
|
|
|
633
|
-
-
|
|
634
|
-
-
|
|
668
|
+
- [Getting Started](docs/getting-started.md) — Install, first component, shared configuration, ESLint, editor tooling, and choosing a rendering mode
|
|
669
|
+
- [Methodology](docs/methodology.md) — The recommended component model: root + sub-elements, `styleProps`, tokens, `styles` vs `style`, wrapping and extension
|
|
635
670
|
|
|
636
|
-
|
|
671
|
+
**Guides**
|
|
637
672
|
|
|
638
|
-
-
|
|
639
|
-
-
|
|
640
|
-
-
|
|
641
|
-
- **[Plugins & Extension Points](docs/plugins.md)** — Extending Tasty: choosing an extension point, authoring style handlers and props middleware, and packaging it as a plugin
|
|
642
|
-
- **[Style Properties](docs/styles.md)** — Complete reference for all enhanced style properties: syntax, values, modifiers, and recommendations
|
|
643
|
-
- **[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
|
|
673
|
+
- [Building a Design System](docs/design-system.md) — Token vocabulary, state aliases, recipes, primitives, compound components, and override contracts
|
|
674
|
+
- [Adoption Guide](docs/adoption.md) — Where Tasty fits, who should adopt it, and how to introduce it incrementally
|
|
675
|
+
- [Comparison](docs/comparison.md) — Tasty next to Tailwind, Panda CSS, vanilla-extract, StyleX, Stitches, and Emotion
|
|
644
676
|
|
|
645
|
-
|
|
677
|
+
**Reference**
|
|
646
678
|
|
|
647
|
-
-
|
|
679
|
+
- [Style DSL](docs/dsl.md) — State maps, tokens, units, colors, extending semantics, recipes, and at-rules
|
|
680
|
+
- [Style Properties](docs/styles.md) — Every enhanced style property: syntax, values, and modifiers
|
|
681
|
+
- [React API](docs/react-api.md) — `tasty()`, component props, variants, sub-elements, and style functions
|
|
682
|
+
- [Configuration](docs/configuration.md) — Everything `configure()` accepts
|
|
683
|
+
- [Plugins & Extension Points](docs/plugins.md) — Custom style handlers, props middleware, and typing your extension
|
|
684
|
+
- [Style Rules for AI Agents](docs/ai-agents.md) — A condensed brief for writing correct styles
|
|
648
685
|
|
|
649
|
-
|
|
686
|
+
**Rendering modes**
|
|
650
687
|
|
|
651
|
-
-
|
|
652
|
-
-
|
|
688
|
+
- [Server-Side Rendering](docs/ssr.md) — Next.js, Astro, and generic React SSR: streaming, cache hydration, and troubleshooting
|
|
689
|
+
- [Build-Time Extraction (`tastyStatic`)](docs/tasty-static.md) — Babel plugin setup, Next.js integration, and static style patterns
|
|
653
690
|
|
|
654
|
-
|
|
691
|
+
**Internals**
|
|
655
692
|
|
|
656
|
-
-
|
|
657
|
-
-
|
|
658
|
-
-
|
|
693
|
+
- [Style rendering pipeline](docs/pipeline.md) — How state maps become mutually exclusive CSS rules
|
|
694
|
+
- [Style Injector](docs/injector.md) — Deduplication, reference counting, cleanup, SSR, and Shadow DOM
|
|
695
|
+
- [Debug Utilities](docs/debug.md) — Inspecting CSS, elements, caches, and chunks at runtime
|
|
696
|
+
- [Runtime Benchmarks](docs/runtime-benchmarks.md) — Methodology and results
|
|
659
697
|
|
|
660
|
-
|
|
698
|
+
**Upgrading**
|
|
661
699
|
|
|
662
|
-
-
|
|
700
|
+
- [Migration Guide (v2 → v3)](docs/migration-v3.md) — Every breaking change in 3.0, with a search-and-replace cheat sheet
|
|
663
701
|
|
|
664
702
|
## License
|
|
665
703
|
|