@motion-proto/live-tokens 0.66.0 → 0.67.0

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.
Files changed (38) hide show
  1. package/CHANGELOG.md +132 -0
  2. package/dist-plugin/{chunk-NRONZ3T5.js → chunk-T4PMCFJN.js} +220 -114
  3. package/dist-plugin/index.cjs +253 -129
  4. package/dist-plugin/index.js +27 -9
  5. package/dist-plugin/migrateData/index.cjs +220 -114
  6. package/dist-plugin/migrateData/index.js +1 -1
  7. package/package.json +8 -1
  8. package/src/editor/bootstrap.ts +12 -0
  9. package/src/editor/core/productionPulse.ts +1 -1
  10. package/src/editor/core/sketch/index.ts +23 -27
  11. package/src/editor/core/sketch/maskField.ts +200 -62
  12. package/src/editor/core/sketch/sketchLayer.ts +10 -4
  13. package/src/editor/core/sketch/sketchRegistry.ts +98 -0
  14. package/src/editor/core/sketch/sketchStore.ts +64 -33
  15. package/src/editor/core/sketch/sketchStyleService.ts +3 -0
  16. package/src/editor/core/sketch/sketchStyles.ts +57 -96
  17. package/src/editor/docs/content/sketch-mode.md +56 -14
  18. package/src/editor/docs/content.generated.ts +1 -1
  19. package/src/editor/ui/sketch/SketchTab.svelte +219 -74
  20. package/src/live-tokens/data/sketch-styles/dashed.json +47 -0
  21. package/src/live-tokens/data/sketch-styles/dry.json +47 -0
  22. package/src/live-tokens/data/sketch-styles/hatched.json +47 -0
  23. package/src/live-tokens/data/sketch-styles/marker.json +47 -0
  24. package/src/live-tokens/data/sketch-styles/napkin.json +47 -0
  25. package/src/live-tokens/data/sketch-styles/pencil.json +47 -0
  26. package/src/live-tokens/data/sketch-styles/whiteboard.json +47 -0
  27. package/src/live-tokens/data/themes/autumn.json +4 -4
  28. package/src/live-tokens/data/themes/halloween.json +4 -4
  29. package/src/live-tokens/data/themes/midnight-study.json +4 -4
  30. package/src/live-tokens/data/themes/ocean.json +4 -4
  31. package/src/live-tokens/data/themes/royal-velvet.json +4 -4
  32. package/src/live-tokens/data/themes/sketchy.json +4 -4
  33. package/src/live-tokens/data/themes/spring-meadow.json +4 -4
  34. package/src/live-tokens/data/themes/sunset.json +4 -4
  35. package/src/system/components/Button.svelte +2 -2
  36. package/src/system/components/IconButton.svelte +2 -2
  37. package/src/system/styles/fonts.css +6 -6
  38. package/template/src/main.ts +14 -1
@@ -6,6 +6,7 @@ import {
6
6
  hydrateSketchStyle,
7
7
  type SketchStyle,
8
8
  } from './sketchStyles';
9
+ import { lookById, replaceRegisteredLooks, sketchLooks } from './sketchRegistry';
9
10
  import {
10
11
  applySketchLayer,
11
12
  hostRoot,
@@ -102,18 +103,21 @@ function readBaseline(): SketchStyle | null {
102
103
  return null;
103
104
  }
104
105
 
105
- /** Marks a saved sketchstyle in `sketchStyleName`, so a user file named `pencil`
106
- and the shipped `pencil` stay distinguishable in one string. */
107
- export const USER_STYLE_PREFIX = 'user:';
106
+ /** Retired. Saved sketchstyles and shipped ones share one id namespace now, so
107
+ a file named `pencil` replaces the shipped Pencil rather than sitting beside
108
+ it. Stripped on read below; delete a release after that ships. */
109
+ const RETIRED_USER_PREFIX = 'user:';
108
110
 
111
+ /** Deliberately unvalidated. Looks are registered after this module is
112
+ imported, so an id it has never heard of is the normal case rather than a
113
+ fault: `selectSketchStyle` no-ops on one, and `sketchPick` already reports
114
+ a look nothing names as `adjusted`. Only a browser that has stored nothing
115
+ falls back. */
109
116
  function readStyleName(): string {
110
117
  try {
111
118
  const name = localStorage.getItem(STYLE_NAME_KEY);
112
- if (
113
- name === '' ||
114
- (name && (name in SKETCH_STYLES || name === THEME_SKETCH_ID || name.startsWith(USER_STYLE_PREFIX)))
115
- ) {
116
- return name;
119
+ if (name !== null) {
120
+ return name.startsWith(RETIRED_USER_PREFIX) ? name.slice(RETIRED_USER_PREFIX.length) : name;
117
121
  }
118
122
  } catch {
119
123
  // fall through
@@ -126,9 +130,9 @@ function readStyleName(): string {
126
130
  export const sketchEnabled = writable<boolean>(readEnabled());
127
131
  export const sketchSettings = writable<SketchStyle>(readSettings());
128
132
  /** The sketchstyle the dials started from. It survives dial moves, so the grid
129
- keeps showing what the current look is closest to. A shipped id, a `user:`
130
- file, or `THEME_SKETCH_ID` for the look the open theme carries; empty only
131
- when nothing was picked, or the picked file was deleted. */
133
+ keeps showing what the current look is closest to. Any id in the pool, or
134
+ `THEME_SKETCH_ID` for the look the open theme carries; empty only when
135
+ nothing was picked, or the picked file was deleted. */
132
136
  export const sketchStyleName = writable<string>(readStyleName());
133
137
 
134
138
  /** The settings as the selected sketchstyle defined them. Kept beside the live
@@ -175,9 +179,9 @@ export const themeSketchStyle = writable<SketchStyle | undefined>(undefined);
175
179
 
176
180
  /** Open a theme's sketchstyle: the dials, the on/off state, and the name
177
181
  recovered by comparison (RJC 3). Overwrites the live buffer, which
178
- is what opening a theme means everywhere else (RJC 6). Never writes a
179
- `user:` name here: a saved sketchstyle is a file this look may not have come
180
- from, and the only thing that can name one is picking it. */
182
+ is what opening a theme means everywhere else (RJC 6). The name is recovered
183
+ over the whole pool, so a theme carrying a look a saved file also holds is
184
+ named by that file rather than falling back to `THEME_SKETCH_ID`. */
181
185
  export function openThemeSketchStyle(sketchStyle: SketchStyle | undefined): void {
182
186
  themeSketchStyle.set(sketchStyle);
183
187
  if (!sketchStyle) {
@@ -186,7 +190,7 @@ export function openThemeSketchStyle(sketchStyle: SketchStyle | undefined): void
186
190
  sketchStyleName.set('');
187
191
  return;
188
192
  }
189
- const matched = (Object.keys(SKETCH_STYLES) as string[]).find((name) => sameLook(SKETCH_STYLES[name], sketchStyle));
193
+ const matched = get(sketchLooks).find((look) => sameLook(look.settings, sketchStyle))?.id;
190
194
  sketchSettings.set({ ...sketchStyle });
191
195
  sketchBaseline.set({ ...sketchStyle });
192
196
  sketchStyleName.set(matched ?? THEME_SKETCH_ID);
@@ -249,14 +253,17 @@ export const sketchOffLook = derived(
249
253
  },
250
254
  );
251
255
 
252
- export function selectSketchStyle(name: string): void {
253
- const style = SKETCH_STYLES[name];
254
- if (!style) return;
256
+ /** Takes any id in the pool: shipped, or registered from a file or a consumer.
257
+ Silent for an id nothing knows, the way it has always been for an unknown
258
+ shipped name. */
259
+ export function selectSketchStyle(id: string): void {
260
+ const look = lookById(id);
261
+ if (!look) return;
255
262
  markSketchTouched();
256
263
  if (get(sketchEnabled)) liveMovedSinceBake.set(true);
257
- sketchStyleName.set(name);
258
- sketchBaseline.set({ ...style });
259
- sketchSettings.set({ ...style });
264
+ sketchStyleName.set(id);
265
+ sketchBaseline.set({ ...look.settings });
266
+ sketchSettings.set({ ...look.settings });
260
267
  }
261
268
 
262
269
  /** Saved sketchstyles, listed from the data tree. Empty until
@@ -264,17 +271,22 @@ export function selectSketchStyle(name: string): void {
264
271
  the network. */
265
272
  export const savedSketchStyles = writable<SketchStyleMeta[]>([]);
266
273
 
274
+ /** Lists the files and registers them in one gesture, so the editor's grid and
275
+ a built site's picker read the same pool. Loading every file to list them is
276
+ affordable: a sketchstyle is a few dozen numbers, and the alternative is a
277
+ grid that cannot paint a row until it is picked. */
267
278
  export async function refreshSavedSketchStyles(): Promise<void> {
268
- savedSketchStyles.set(await listSketchStyles());
269
- }
270
-
271
- export async function selectSavedSketchStyle(fileName: string): Promise<void> {
272
- const file = await loadSketchStyle(fileName);
273
- markSketchTouched();
274
- if (get(sketchEnabled)) liveMovedSinceBake.set(true);
275
- sketchStyleName.set(USER_STYLE_PREFIX + fileName);
276
- sketchBaseline.set({ ...file.settings });
277
- sketchSettings.set(file.settings);
279
+ const files = await listSketchStyles();
280
+ const loaded = await Promise.all(files.map((f) => loadSketchStyle(f.fileName)));
281
+ savedSketchStyles.set(files);
282
+ replaceRegisteredLooks(
283
+ files.map((file, i) => ({
284
+ id: file.fileName,
285
+ label: file.name || file.fileName,
286
+ settings: loaded[i].settings,
287
+ source: file.isPackage ? ('shipped' as const) : ('file' as const),
288
+ })),
289
+ );
278
290
  }
279
291
 
280
292
  /** Writes whatever the dials currently say to a named file and selects it, so
@@ -291,15 +303,34 @@ export async function saveCurrentSketchStyle(name: string): Promise<string> {
291
303
  await refreshSavedSketchStyles();
292
304
  sketchSettings.set(settings);
293
305
  sketchBaseline.set({ ...settings });
294
- sketchStyleName.set(USER_STYLE_PREFIX + fileName);
306
+ sketchStyleName.set(fileName);
295
307
  return fileName;
296
308
  }
297
309
 
310
+ /** Overwrite the selected saved sketchstyle. The file name comes from the
311
+ selection rather than from re-slugifying the label, because the two can
312
+ disagree: a file hand-edited to a new display name would otherwise be saved
313
+ beside itself under a fresh slug instead of over itself. The label comes
314
+ from the look for the same reason, so the name the grid shows survives.
315
+
316
+ No `markSketchTouched`: the button only lights once a dial has moved, and
317
+ every dial goes through `updateSketchSettings`, which marks it. */
318
+ export async function saveSelectedSketchStyle(): Promise<void> {
319
+ const look = lookById(get(sketchStyleName));
320
+ if (look?.source !== 'file') throw new Error('No saved sketchstyle is selected');
321
+ const settings = { ...get(sketchSettings) };
322
+ await saveSketchStyle(look.id, look.label, settings);
323
+ await refreshSavedSketchStyles();
324
+ // Re-baselining is what disables the button again and returns the readout
325
+ // from "Modified from X" to the saved blurb.
326
+ sketchBaseline.set(settings);
327
+ }
328
+
298
329
  export async function deleteSavedSketchStyle(fileName: string): Promise<void> {
299
330
  await deleteSketchStyle(fileName);
300
331
  await refreshSavedSketchStyles();
301
332
  // The dials keep their values; only the name stops naming a file that exists.
302
- if (get(sketchStyleName) === USER_STYLE_PREFIX + fileName) {
333
+ if (get(sketchStyleName) === fileName) {
303
334
  sketchStyleName.set('');
304
335
  sketchBaseline.set(null);
305
336
  }
@@ -12,6 +12,9 @@ export interface SketchStyleMeta {
12
12
  name: string;
13
13
  fileName: string;
14
14
  updatedAt: string;
15
+ /** Served from the package rather than this project, so there is no local
16
+ file to write over or delete. Saving over one creates that file. */
17
+ isPackage: boolean;
15
18
  }
16
19
 
17
20
  const BASE = `${API_BASE}/sketch-styles`;
@@ -1,3 +1,11 @@
1
+ import pencil from '../../../live-tokens/data/sketch-styles/pencil.json';
2
+ import marker from '../../../live-tokens/data/sketch-styles/marker.json';
3
+ import whiteboard from '../../../live-tokens/data/sketch-styles/whiteboard.json';
4
+ import hatched from '../../../live-tokens/data/sketch-styles/hatched.json';
5
+ import dashed from '../../../live-tokens/data/sketch-styles/dashed.json';
6
+ import napkin from '../../../live-tokens/data/sketch-styles/napkin.json';
7
+ import dry from '../../../live-tokens/data/sketch-styles/dry.json';
8
+
1
9
  export interface SketchStyle {
2
10
  label: string;
3
11
  blurb: string;
@@ -59,8 +67,22 @@ export interface SketchStyle {
59
67
  hatchInk: number;
60
68
  strokeStyle: 'solid' | 'dashed';
61
69
  maskOn: boolean;
62
- /** Wavelength of the coverage noise, in page px. Small gives speckle, large gives broad patches. */
63
- maskBlob: number;
70
+ /** Blob size of the coverage noise, in page px, across and down. Small gives
71
+ speckle, large gives broad patches. */
72
+ maskBlobX: number;
73
+ maskBlobY: number;
74
+ /** Which way the stretch runs, in degrees clockwise from level. Nothing at
75
+ all while the two blob sizes match, since a field the same in every
76
+ direction is the same field turned. The tile only meets itself at the
77
+ angles that land the page's axes back on whole cells, so the dial is
78
+ answered with the nearest of those. */
79
+ maskAngle: number;
80
+ /** Whether the two move together. Unlinked they part, and the field comes out
81
+ stretched: blobs wider than they are tall read as a wash dragged sideways,
82
+ the way ink pulled across a page does. Stored rather than inferred from
83
+ the pair matching, so a look that stretches to exactly square keeps its
84
+ dials apart. */
85
+ maskBlobLinked: boolean;
64
86
  /** Output levels on the coverage field, 0 to 1: the palest the fill gets and
65
87
  the densest. The whole field is squeezed into the gap, never cut at it, so
66
88
  0.4 to 1 is a fill that is never thinner than 40% ink and 0 to 0.8 one
@@ -119,100 +141,25 @@ export interface SketchStyle {
119
141
  iconMaskScale: number;
120
142
  }
121
143
 
122
- const base: SketchStyle = {
123
- label: '', blurb: '',
124
- fillTravel: 1.5, strokeTravel: 1.5, wobble: 45, roughness: 3,
125
- borderWavelength: 1, waveform: 1,
126
- strokeWidth: 1.5, doubleStroke: false, retraceOffset: 1.2, retracePass: 'copy',
127
- fillStyle: 'solid', hatchInk: 0.4, strokeStyle: 'solid',
128
- pressure: 0.25, pressureMod: 0.35, pooling: 1.2, strokeInk: 1,
129
- maskOn: true, maskBlob: 100, maskOutputMin: 0.45, maskOutputMax: 1,
130
- maskOctaves: 2, maskGrain: 'fractal', maskPosterize: 1, maskSoftness: 1.5,
131
- jitterX: 2.5, jitterY: 2.5, jitterRot: 0.6, jitterScale: 0.035,
132
- cornerSpread: 10, cornerTravel: 8,
133
- iconTravel: 1.25, iconWavelength: 0.625, iconMaskOn: true, iconMaskScale: 1,
134
- };
135
-
136
- export const SKETCH_STYLES: Record<string, SketchStyle> = {
137
- pencil: {
138
- ...base, label: 'Pencil',
139
- blurb: 'Two graphite passes on their own seeds, so the outline disagrees with itself the way a hand coming back round does. Tight grain, little else.',
140
- fillTravel: 0.75, strokeTravel: 1.25, wobble: 30, roughness: 3, waveform: 1,
141
- strokeWidth: 1.25, doubleStroke: true, retracePass: 'reseeded', retraceOffset: 1.5, strokeInk: 0.85,
142
- maskBlob: 40, maskOutputMin: 0.62, maskOutputMax: 1, maskOctaves: 3, maskPosterize: 1, maskSoftness: 0,
143
- jitterX: 1.5, jitterY: 1.5, jitterRot: 0.35, jitterScale: 0.022,
144
- cornerSpread: 6, cornerTravel: 4.5,
145
- pressure: 0.15, pressureMod: 0.3, pooling: 0, iconTravel: 0.75,
146
- },
147
-
148
- marker: {
149
- ...base, label: 'Marker',
150
- blurb: 'Broad translucent nib gone round twice on the same line, so the overlap darkens and the ink pools where it slows.',
151
- fillTravel: 2, strokeTravel: 1.5, wobble: 56, waveform: 1.4, borderWavelength: 1.3,
152
- strokeWidth: 4, doubleStroke: true, retracePass: 'copy', strokeInk: 0.52, retraceOffset: 2.2,
153
- maskBlob: 115, maskOutputMin: 0.42, maskOutputMax: 1, maskOctaves: 3, maskPosterize: 4, maskSoftness: 4,
154
- jitterX: 3, jitterY: 3, jitterRot: 0.8, jitterScale: 0.045,
155
- cornerSpread: 10, cornerTravel: 8,
156
- pressure: 0.2, pressureMod: 0.25, pooling: 2, iconTravel: 1.25, iconMaskScale: 4,
157
- },
158
-
159
- whiteboard: {
160
- ...base, label: 'Whiteboard',
161
- blurb: 'The fattest nib on glass. One long smooth undulation, and a veined mask that streaks the fill like a half-wiped board.',
162
- fillTravel: 2.5, strokeTravel: 2.5, wobble: 90, roughness: 1, waveform: 1, borderWavelength: 1.5,
163
- strokeWidth: 5.5, doubleStroke: true, retracePass: 'copy', strokeInk: 0.66, retraceOffset: 3,
164
- maskGrain: 'turbulence', maskBlob: 180, maskOutputMin: 0.42, maskOutputMax: 1,
165
- maskOctaves: 1, maskPosterize: 3, maskSoftness: 8,
166
- jitterX: 4.5, jitterY: 4.5, jitterRot: 1.2, jitterScale: 0.07,
167
- cornerSpread: 14, cornerTravel: 11,
168
- pressure: 0.15, pressureMod: 0.15, pooling: 3.5, iconTravel: 1.75, iconMaskScale: 1.5,
169
- },
170
-
171
- hatched: {
172
- ...base, label: 'Hatched',
173
- blurb: 'An etching. The fill is angled shading, the outline a single hard-edged scratch that chatters along its length. No mask: the hatch is the texture.',
174
- fillTravel: 1.25, strokeTravel: 1.5, wobble: 24, roughness: 3, waveform: 3,
175
- strokeWidth: 1.5, fillStyle: 'hatched', hatchInk: 0.5, doubleStroke: false,
176
- maskOn: false, iconMaskOn: false,
177
- jitterX: 1.5, jitterY: 1.5, jitterRot: 0.4, jitterScale: 0.03,
178
- cornerSpread: 6, cornerTravel: 6,
179
- pressure: 0.3, pressureMod: 0.45, pooling: 0.8, iconTravel: 1.25, iconWavelength: 0.5,
180
- },
181
-
182
- dashed: {
183
- ...base, label: 'Dashed',
184
- blurb: 'A drafting outline. One slow drift along the ruler, broken into strokes, with jitter, mask and pressure all off. The clean pole.',
185
- strokeStyle: 'dashed', strokeTravel: 1, fillTravel: 0.5, wobble: 120, roughness: 1, waveform: 1,
186
- strokeWidth: 1.5, doubleStroke: false,
187
- maskOn: false, iconMaskOn: false,
188
- jitterX: 0, jitterY: 0, jitterRot: 0, jitterScale: 0,
189
- cornerSpread: 4, cornerTravel: 3,
190
- pressure: 0, pressureMod: 0, pooling: 0, iconTravel: 0,
191
- },
192
-
193
- napkin: {
194
- ...base, label: 'Napkin',
195
- blurb: 'Ballpoint in a hurry. Everything loose at once: a square wave sends every edge to full travel, and the second pass lands wherever it lands.',
196
- fillTravel: 3, strokeTravel: 2.25, wobble: 50, roughness: 3, waveform: 2.5,
197
- strokeWidth: 2.25, doubleStroke: true, retracePass: 'reseeded', retraceOffset: 4, strokeInk: 1,
198
- maskBlob: 150, maskOutputMin: 0.43, maskOutputMax: 0.95, maskOctaves: 2, maskPosterize: 2, maskSoftness: 10,
199
- jitterX: 6, jitterY: 6, jitterRot: 1.8, jitterScale: 0.1,
200
- cornerSpread: 20, cornerTravel: 17,
201
- pressure: 0.45, pressureMod: 0.6, pooling: 2.5, iconTravel: 2.25, iconMaskScale: 3.6,
202
- },
144
+ /**
145
+ * The shipped sketchstyles, read from the files the package distributes. The
146
+ * files are the source: a project shadows one by saving a sketchstyle under the
147
+ * same id, the editor restores a shipped look by deleting that file, and
148
+ * `themeFileApi` serves these as the read-only fallback behind the project's own
149
+ * directory. Editing a look here means editing its JSON, which is what the
150
+ * Sketchstyle view already writes.
151
+ *
152
+ * Each file carries every dial, so there is nothing to merge a default into.
153
+ * `sketchStyles.test.ts` pins that: the seven key sets have to match, and a dial
154
+ * added to `SketchStyle` has to reach all seven before the suite goes green.
155
+ *
156
+ * Order is picker order.
157
+ */
158
+ const SHIPPED_FILES = { pencil, marker, whiteboard, hatched, dashed, napkin, dry };
203
159
 
204
- dry: {
205
- ...base, label: 'Dry marker',
206
- blurb: 'Ink that ran out. One scratchy pass that breaks up along its length, over a fill the mask has worn nearly through in patches.',
207
- fillTravel: 2.25, strokeTravel: 1.75, wobble: 50, waveform: 2, borderWavelength: 0.5,
208
- strokeWidth: 3.5, doubleStroke: false, strokeInk: 0.4,
209
- maskBlob: 150, maskOutputMin: 0.24, maskOutputMax: 0.91,
210
- maskOctaves: 2, maskPosterize: 4, maskSoftness: 1.75,
211
- jitterX: 5, jitterY: 5, jitterRot: 1.4, jitterScale: 0.08,
212
- cornerSpread: 16, cornerTravel: 13,
213
- pressure: 0.4, pressureMod: 0.8, pooling: 1.5, iconTravel: 1.75, iconMaskScale: 3.8,
214
- },
215
- };
160
+ export const SKETCH_STYLES: Record<string, SketchStyle> = Object.fromEntries(
161
+ Object.entries(SHIPPED_FILES).map(([id, file]) => [id, file.settings as unknown as SketchStyle]),
162
+ );
216
163
 
217
164
  export const DEFAULT_SKETCH_STYLE = 'marker';
218
165
 
@@ -239,6 +186,7 @@ export function hydrateSketchStyle(raw: unknown): SketchStyle {
239
186
  convertCutToLevels(stored as Record<string, unknown>, out);
240
187
  carryLevelsToOutput(stored as Record<string, unknown>, out);
241
188
  halveSwingDials(stored as Record<string, unknown>, out);
189
+ splitBlobAxes(stored as Record<string, unknown>, out);
242
190
  convertCyclesToWavelength(stored as Record<string, unknown>, out);
243
191
  convertIconTileToScale(stored as Record<string, unknown>, out);
244
192
  restoreDerivedRetrace(stored as Record<string, unknown>, out);
@@ -286,6 +234,16 @@ function convertCyclesToWavelength(stored: Record<string, unknown>, out: SketchS
286
234
  if (typeof layers === 'number') out.roughness = Math.min(3, Math.max(1, layers));
287
235
  }
288
236
 
237
+ /** The blob size was one number for both axes. A look stored before the split
238
+ comes back square, with the two dials linked, which is the look it had. */
239
+ function splitBlobAxes(stored: Record<string, unknown>, out: SketchStyle): void {
240
+ const blob = stored.maskBlob;
241
+ if (typeof blob !== 'number') return;
242
+ out.maskBlobX = blob;
243
+ out.maskBlobY = blob;
244
+ out.maskBlobLinked = true;
245
+ }
246
+
289
247
  /** The icon mask tile used to be a px size, which is a unit the glyph it covers
290
248
  has no say in: 90px against a 16px icon put a whole glyph inside one patch
291
249
  of the field, so it came out either untouched or gone. It is a share of the
@@ -311,7 +269,10 @@ function convertTiledMask(stored: Record<string, unknown>, out: SketchStyle): vo
311
269
  const scale = stored.maskScale;
312
270
  if (typeof scale !== 'number') return;
313
271
  const freq = stored.maskFrequency;
314
- if (typeof freq === 'number') out.maskBlob = Math.round(scale / (freq * LEGACY_TILE));
272
+ if (typeof freq === 'number') {
273
+ out.maskBlobX = Math.round(scale / (freq * LEGACY_TILE));
274
+ out.maskBlobY = out.maskBlobX;
275
+ }
315
276
  const soft = stored.maskSoftness;
316
277
  if (typeof soft === 'number') out.maskSoftness = Number(((soft * scale) / LEGACY_TILE).toFixed(1));
317
278
  }
@@ -38,10 +38,22 @@ than just a name:
38
38
  - **Napkin.** Ballpoint in a hurry. Everything loose at once.
39
39
  - **Dry marker.** Ink that ran out. One scratchy pass over a mostly eaten fill.
40
40
 
41
- Pick one, then move whatever you like. **Save as sketchstyle…** keeps your
42
- dials under a name of your own, alongside the shipped seven, as a file under
43
- `src/live-tokens/data/sketch-styles/`. That is a different gesture from
44
- saving a theme; see "Where the settings live" below.
41
+ All seven ship as files, one per look, under
42
+ `src/live-tokens/data/sketch-styles/` in the package. There is no look that
43
+ exists only as code, so every one of them can be read, copied and edited.
44
+
45
+ Pick one, then move whatever you like. **Save As** keeps your dials under a name
46
+ of your own, alongside the shipped seven, as a file under
47
+ `src/live-tokens/data/sketch-styles/` in your project. **Save** writes them back
48
+ over the sketchstyle you have selected, and lights as soon as the dials leave
49
+ it. On one of your own it writes that file. On a shipped one it writes your
50
+ project's own copy under the same name, which takes its place in the list;
51
+ delete that copy and the shipped file behind it comes back. Both are a
52
+ different gesture from saving a theme; see "Where the settings live" below.
53
+
54
+ Your sketchstyles and the shipped ones are one list. A sketchstyle named after
55
+ a shipped one replaces it, keeping its place in the list, so a project that
56
+ wants its own Pencil saves one and every picker shows that one instead.
45
57
 
46
58
  ## The dials
47
59
 
@@ -50,8 +62,11 @@ saving a theme; see "Where the settings live" below.
50
62
  few pixels off or runs it through the pen again on its own seed.
51
63
  - **Fill.** Solid or hatched, how far the fill's edge travels, and how far each
52
64
  instance is offset, rotated and scaled from its neighbours. **Ink coverage**
53
- thins the fill with a field of blotches: set their size and how many levels of
54
- detail, then work the field as a levels control. The field always runs black
65
+ thins the fill with a field of blotches: set their size across and down and
66
+ how many levels of detail, then work the field as a levels control. The two
67
+ sizes move together under a chain; break it and the blotches stretch, which
68
+ reads as ink dragged along the axis you widened, and a **Rotation** dial joins
69
+ them to point that stretch anywhere you like. The field always runs black
55
70
  to white whatever the noise underneath. Steps flattens it into tones, and
56
71
  Output squeezes the whole of it into the range the ink covers, from how pale
57
72
  it gets at its thinnest to how dense at its fullest. Menus and tooltips are
@@ -81,9 +96,9 @@ change. The built-in **Motion Proto** theme is read-only, so Save
81
96
  is disabled there; use **Save As** to fold the dials into a theme of your
82
97
  own.
83
98
 
84
- **Save as sketchstyle…** in the **Sketchstyle** view is a different gesture. It
85
- writes a named sketchstyle to `src/live-tokens/data/sketch-styles/`, a look you
86
- can pick from any theme. It never touches the open theme, and it never marks
99
+ **Save** and **Save As** in the **Sketchstyle** view are a different gesture.
100
+ They write a named sketchstyle to `src/live-tokens/data/sketch-styles/`, a look
101
+ you can pick from any theme. Neither touches the open theme, and neither marks
87
102
  the look off the theme.
88
103
 
89
104
  ## Shipping the layer
@@ -111,11 +126,38 @@ A visitor who has picked a look of their own keeps it, None included. The theme
111
126
  seeds a browser that has decided nothing and never overwrites one that has, so
112
127
  calling this on every boot is safe.
113
128
 
114
- If your site offers a sketch picker, `themeSketchLook` is the theme's own look
115
- as one more row. It is null when the theme carries none, and null when what it
116
- carries is one of the shipped seven, since that row already names it. Give the
117
- row `setSketch(look.id)` like any other, and a visitor who wanders off the
118
- theme's look can come back to it.
129
+ ### Your own sketchstyles
130
+
131
+ The dev server lists the files in `sketch-styles/`. A built site has no server
132
+ to ask, so it hands them over at boot, the way it hands over components:
133
+
134
+ ```ts
135
+ const files = import.meta.glob<{ name?: string; settings: unknown }>(
136
+ './live-tokens/data/sketch-styles/*.json',
137
+ { eager: true, import: 'default' },
138
+ );
139
+
140
+ await bootLiveTokens(App, '#app', {
141
+ sketchLooks: Object.entries(files).map(([path, file]) => {
142
+ const id = path.split('/').pop()!.replace('.json', '');
143
+ return { id, label: file.name || id, settings: file.settings };
144
+ }),
145
+ });
146
+ ```
147
+
148
+ Projects made with `create` ship this already. The file's slug is the look's
149
+ id, so a sketchstyle picked in the editor keeps working once the site is built.
150
+
151
+ ### Building a picker
152
+
153
+ `sketchLooks` is every look on offer, shipped and your own, as a store. Give
154
+ each row `setSketch(look.id)`, and add your own **None** row: off is a state of
155
+ the effect rather than one of the looks.
156
+
157
+ `themeSketchLook` is the theme's own look as one more row. It is null when the
158
+ theme carries none, and null when what it carries is a look already in
159
+ `sketchLooks`, since that row names it. Its id goes to `setSketch` like any
160
+ other, so a visitor who wanders off the theme's look can come back to it.
119
161
 
120
162
  ## Drawing your own elements
121
163
 
@@ -7,7 +7,7 @@ export const docContent: Record<string, string> = {
7
7
  "editing-tokens": "# Editing tokens\n\nA tour of the editor. The page behind it repaints on every change; saving\nwrites a theme file you can reload later.\n\nThe editor has four views:\n\n- **Tokens**: the design-system primitives (colour, type, spacing, and so on).\n They apply everywhere your site uses them.\n- **Color Wheel**: the harmony wheel, the palette curves, and the story your colours\n tell across a page.\n- **Components**: per-component editors. Re-Assign what tokens a component uses\n without changing the underlying system.\n- **Sketchstyle**: an effect layer that redraws the page by hand. See\n [Sketch mode](sketch-mode.md).\n\nThis page covers **Tokens**. For components, see\n[Creating components](creating-components.md).\n\n## Palettes\n\nMost colour work happens here. Each palette (Brand, Accent, Neutral, Canvas,\nSuccess, Warning, Info, Danger, and a few more) has:\n\n- **Base colour.** Pick a hex; the palette derives an 11-step ramp (100 to 950)\n from it.\n- **Curves.** Three curves shape the ramp, in stack order: Hue, Saturation,\n Lightness. Drag the handles to bias it warmer or cooler, more or less\n saturated, darker or lighter. Hue drifts the ramp's temperature without\n moving contrast, because OKLCH hue rotation is close to lightness-preserving.\n It holds ±45 degrees; a bigger shift belongs on the base colour or the\n harmony axis.\n- **Overrides.** Lock a single step to a hand-picked hex when the curve doesn't\n land where you want.\n\nEditing a palette base ripples through every colour that depends on it, in real\ntime. Colours use OKLCH, so the ramp stays perceptually even across hues\nwithout muddy mid-tones.\n\n## Type\n\n- **Fonts.** Add sources from Google Fonts, Adobe (Typekit), a CSS URL, or an\n inline `@font-face`. The font loads in the page as soon as you add it.\n- **Stacks.** Named font cascades you reference by token, such as a display\n stack and a body stack.\n- **Sizes and weights.** A t-shirt scale (xs, sm, md, lg, xl, 2xl…) for size and\n a numeric scale (100 to 900) for weight.\n\n## Spacing, radius, shadow\n\nNumeric scales with a slider per step.\n\n- **Spacing**: the padding, gap, and margin scale.\n- **Radius**: none through full.\n- **Shadow**: colour, offset, blur, spread, and opacity per step, with stacked\n shadows supported.\n\nChange a step and every element using it repaints.\n\n## Overlays and gradients\n\n- **Overlays** are translucent tints layered over surfaces, like the subtle\n tint a card gets on hover. Set a colour and opacity per state.\n- **Gradients** are reusable gradient tokens with a stop list and direction, for\n hero panels and accent backgrounds.\n\n## Columns\n\nThe page-grid overlay. Set column count, gutter, and outer margin, and toggle\nthe visual guide with `Cmd/Ctrl+G`. Pages built on the column system reflow\nlive.\n\n## Saving\n\nThe editor saves to your browser continuously, so work survives a reload\nmid-edit. Writing a file is a separate step: the **Theme** panel at the foot of\nthe sidebar has **Save**, **Save As**, and **Load**, and each theme is one JSON\nfile under `src/live-tokens/data/themes/`.\n\nThe header gives you undo/redo (`Cmd/Ctrl+Z`, `Cmd/Ctrl+Shift+Z`). You can keep\nmany themes side by side; one is open at a time, and only **Adopt** publishes\none. See [Themes](themes-workflow.md) for the full lifecycle.\n",
8
8
  "getting-started": "# Getting started\n\nScaffold a live token site in a moments. You need Node 20 or later, a\npackage manager (npm, pnpm, or yarn), and a browser. Open claude code in your repo and start building.\n\n## Scaffold a new app\n\n```bash\nnpm create @motion-proto/live-tokens@latest my-app\ncd my-app\nnpm install\nnpm run dev\n```\n\nOpen the URL Vite prints (usually `http://localhost:5173`). You get a\none-page Svelte + Vite app that depends on the published package, with the\neditor wired up and the full component set ready to import.\n\n`npx @motion-proto/live-tokens create my-app` runs the same scaffold without\nthe initialiser package.\n\n### What the scaffold gives you\n\nEvery editable file lives under `src/` and is committed, so `npm install` and\nversion upgrades never touch your styles. The package code stays in\n`node_modules`.\n\n| Path | What it is |\n|------|------------|\n| `src/pages/Home.svelte` | The starter page. Replace it with your own content. |\n| `src/App.svelte` | Your routes. `<LiveTokensRouter>` adds dev-only routes under a reserved `/live-tokens/*` namespace: `/live-tokens/editor`, `/live-tokens/components`, and `/live-tokens/docs`. |\n| `src/system/styles/tokens.css` | Your base token vocabulary, hand-authored. |\n| `src/styles/site.css` | Themed page typography, yours to edit. |\n\n## Your first edit\n\n1. Run `npm run dev` and open the home page.\n2. Click **Open Token Editor**, or visit `/live-tokens/editor`. The editor opens beside\n the page.\n3. Open **Palettes**, pick **Brand**, and change the base hex. The page\n repaints as you type.\n4. In the **Theme** panel at the foot of the sidebar, choose **Save As**. Your\n theme appears as JSON under `src/live-tokens/data/themes/`.\n5. Reload. The editor reopens on your theme, so the page returns as you left\n it.\n\n## What you just changed\n\nEvery edit sets a CSS custom property on `:root`. Your components read those\nproperties through `var(--...)`. There is no token build step and no\npreprocessor rewriting your code: the page renders against plain CSS variables\nthe editor swaps live.\n\nTo ship, click **Adopt** in the Theme panel. That saves the open theme and bakes\nit into `src/live-tokens/data/tokens.generated.css`, which your build bundles\nalongside `tokens.css`. Adopt is the only action that changes what your site\nships, so try any look you like first. The editor itself never reaches\nproduction.\n\nAlready have a Svelte 5 + Vite app? The\n[README](https://github.com/motionproto/live-tokens#readme) covers installing\ninto an existing project.\n\n## Where to go next\n\n- **[Editing tokens](editing-tokens.md)**: a tour of the editor.\n- **[Themes](themes-workflow.md)**: save, switch, and ship.\n- **[Creating components](creating-components.md)**: make your own component\n editable.\n",
9
9
  "light-and-dark": "# Light and dark\n\nSome things on a page cannot be written as a token. A wordmark drawn in white\ndisappears on a pale theme. Ink that multiplies onto paper vanishes on a dark\none. A photograph behind a headline is dark no matter what the palette says.\n\nEach of those needs the same fact first: which way does the surface behind this\nthing lean? One attribute carries it.\n\n## The attribute\n\n`data-backdrop` is either `light` or `dark`, and it does two things at once: it\nselects, so a rule can key on it, and it sets `color-scheme`, so every\n`light-dark()` under it resolves the half that reads.\n\n```css\n.title {\n color: light-dark(var(--color-black), var(--color-white));\n}\n```\n\nThat line is right on both sides of the theme, and it is right inside a dark\nband on a pale page, because the nearest `color-scheme` wins.\n\n## Stating it\n\nPut it in the markup when the surface knows its own tone — a hero over a\nphotograph, a plate that stays pale in every theme:\n\n```svelte\n<div class=\"hero-panel\" data-backdrop=\"dark\">\n```\n\nA stated tone beats any measurement, and it inherits, so everything inside the\npanel resolves against it.\n\n## Measuring it\n\nWhere the tone is a property of the theme rather than of the markup, let it be\nmeasured:\n\n```svelte\n<script>\n import { backdrop } from '@motion-proto/live-tokens/backdrop';\n</script>\n\n<section use:backdrop>\n```\n\nThe action reads whatever actually paints behind the element — the nearest\nancestor with an opaque fill, averaged across its gradient stops, falling back\nto the theme's `--page-bg` — and stamps the answer. It re-reads when the theme\nchanges, which the editor does by rewriting custom properties with no reload,\nso the stamp follows a live edit.\n\nThe page itself is stamped for you: the build bakes the production theme's\npolarity into `tokens.generated.css`, so the first paint is already right, and\n`syncDocumentBackdrop()` keeps `<html>` current as themes switch.\n\n```ts\nimport { syncDocumentBackdrop } from '@motion-proto/live-tokens/backdrop';\n\nsyncDocumentBackdrop();\n```\n\n## Reading it from JavaScript\n\nAnything that paints outside CSS — a canvas, a WebGL uniform, an `<img>` that\ncomes in two versions — asks the same question through the same module:\n\n```ts\nimport { isLightBackdrop, watchBackdrop, cssColorToHex } from '@motion-proto/live-tokens/backdrop';\n\nconst stop = watchBackdrop(logoEl, {\n stamp: false,\n onChange: (polarity) => (src = polarity === 'light' ? darkMark : lightMark),\n});\n```\n\n`isLightBackdrop(el)` answers once. `watchBackdrop` keeps answering and returns\na stop function. `cssColorToHex` resolves any CSS colour — including the\n`oklch()` a token holds — to a hex a non-CSS consumer can take.\n\n## What it does not do\n\nPolarity is a property of a surface, not of a component, so nothing is stamped\nfor you below `<html>`: a section that needs an answer either states one or asks\nfor one. And a measurement reads the paint at the moment it runs — an element\nthat scrolls from a pale band onto a dark one keeps the answer it was given.\nState the tone on each band instead.\n",
10
- "sketch-mode": "# Sketch mode\n\nSketch mode redraws your whole page as if it had been drawn by hand. Every\ncomponent keeps its own colours, spacing and corners; what changes is the line\nthey are drawn with.\n\nIt is an effect layer, not a set of token values. It never touches a token\nitself, so turning it off returns every component to exactly what its tokens\nalready say.\n\nOpen the **Sketchstyle** view in the editor and switch **Sketch mode** on. The effect\napplies to the page behind the editor as well as to the preview, so what you see\nin context is what it does.\n\n## What it draws\n\nEach component's fill and outline are repainted from the tokens that component\nalready owns. The real background and border are hidden behind them, then both\nare pushed around one shared field of noise. Because every component samples the\nsame field, the whole page reads as one drawing rather than as a set of\nseparately wobbled boxes.\n\n## The sketchstyles\n\nSeven looks ship with the package, and each is a complete set of dials rather\nthan just a name:\n\n- **Pencil.** Two graphite passes on their own seeds, so the outline disagrees\n with itself the way a hand coming back round does.\n- **Marker.** A broad translucent nib gone round twice on the same line, so the\n overlap darkens and the ink pools where it slows.\n- **Whiteboard.** The fattest nib on glass, with a mask that streaks the fill\n like a half-wiped board.\n- **Hatched.** An etching. The fill is angled shading and the outline a single\n hard-edged scratch.\n- **Dashed.** A drafting outline: one slow drift along the ruler, broken into\n strokes. The clean pole.\n- **Napkin.** Ballpoint in a hurry. Everything loose at once.\n- **Dry marker.** Ink that ran out. One scratchy pass over a mostly eaten fill.\n\nPick one, then move whatever you like. **Save as sketchstyle…** keeps your\ndials under a name of your own, alongside the shipped seven, as a file under\n`src/live-tokens/data/sketch-styles/`. That is a different gesture from\nsaving a theme; see \"Where the settings live\" below.\n\n## The dials\n\n- **Border.** How far the outline travels and how long its wave is, then its\n width, ink, pressure and pooling. A second pass either copies the first line a\n few pixels off or runs it through the pen again on its own seed.\n- **Fill.** Solid or hatched, how far the fill's edge travels, and how far each\n instance is offset, rotated and scaled from its neighbours. **Ink coverage**\n thins the fill with a field of blotches: set their size and how many levels of\n detail, then work the field as a levels control. The field always runs black\n to white whatever the noise underneath. Steps flattens it into tones, and\n Output squeezes the whole of it into the range the ink covers, from how pale\n it gets at its thinnest to how dense at its fullest. Menus and tooltips are\n drawn solid whatever the coverage dials say: they float over the page, and a\n fill worn through in patches lets the page show through them.\n- **Shape.** **Corner spread** rounds each corner by its own share of the dial,\n so no two match. **Corner travel** leans the drawn box into a quadrilateral\n with no two sides parallel. This is the dial that stops a component reading as\n a rectangle.\n- **Icons and SVG.** Glyph travel and wavelength on their own scale. A glyph is\n all curves already, so it needs more travel than a card's long straight edge\n before the wobble reads at all.\n- **Noise.** The shared field itself: its wavelength, how many layers of detail\n sit on it, and the shape of its wave. A square wave sends nearly every edge to\n full travel, which is what makes the effect stronger rather than bigger.\n\n## Where the settings live\n\nThe sketch layer is part of the theme, the same way colors and type are.\n**Save** in the Theme panel folds your dials into the open theme; **Load**\napplies whatever a theme carries, and turns the effect off for a theme that\ncarries none.\n\nUntil you save, the dials sit in your browser only. The Theme panel calls\nthat state off the theme, the same word it uses for an unsaved component\nchange. The built-in **Motion Proto** theme is read-only, so Save\nis disabled there; use **Save As** to fold the dials into a theme of your\nown.\n\n**Save as sketchstyle…** in the **Sketchstyle** view is a different gesture. It\nwrites a named sketchstyle to `src/live-tokens/data/sketch-styles/`, a look you\ncan pick from any theme. It never touches the open theme, and it never marks\nthe look off the theme.\n\n## Shipping the layer\n\nThe dev server reads the open theme and paints whatever it carries. A built site\nhas no server to ask, so it hands the field over itself:\n\n```ts\nimport { seedSketchFromTheme } from '@motion-proto/live-tokens/sketch';\nimport theme from './live-tokens/data/themes/sketchy.json';\n\nseedSketchFromTheme(theme.sketchStyle);\nawait bootLiveTokens(App, '#app');\n```\n\nCall it before mounting, so the look is up on the first frame. Pass the field\nraw. A theme written against older dial names is carried forward on the way in,\nthe same reconciliation the dev server runs on every theme it reads.\n\nNothing is baked. `tokens.generated.css` still holds token values only, and the\nlayer stays JavaScript the page runs, because it builds an SVG filter bank\nrather than a set of custom properties.\n\nA visitor who has picked a look of their own keeps it, None included. The theme\nseeds a browser that has decided nothing and never overwrites one that has, so\ncalling this on every boot is safe.\n\nIf your site offers a sketch picker, `themeSketchLook` is the theme's own look\nas one more row. It is null when the theme carries none, and null when what it\ncarries is one of the shipped seven, since that row already names it. Give the\nrow `setSketch(look.id)` like any other, and a visitor who wanders off the\ntheme's look can come back to it.\n\n## Drawing your own elements\n\nThe layer draws a fixed set of parts: the shipped components, and four classes\nit reserves for you. Nothing else is touched, so a page element or a\nconsumer-authored component is left crisp until it carries one of them.\n\n| Class | For |\n|---------------------|-----------------------------------------------------------|\n| `sketch-surface` | A box. The default treatment. |\n| `sketch-container` | A large box. Tilts less, so the type inside stays readable. |\n| `sketch-chip` | A small box. Finer fill mask, more rotation, less travel. |\n| `sketch-rule` | A line rather than a box. No rotation, no rounded ends. |\n\nPick by size, not by kind: a card and a modal both take `sketch-container`, a\nbadge and a pill both take `sketch-chip`.\n\nThe class opts the element in; it names no colours, so the element states its\nown. `--sketch-fill`, `--sketch-stroke`, `--sketch-hatch-color`,\n`--sketch-radius` and `--sketch-shadow` name the fill, the outline, the hatching\nink, the corners and the shadow for one element and everything inside it. The\nlayer blanks the real background and border, so an element whose fill matters\nunder Sketch mode has to name it here as well as paint it.\n\nThe layer also paints on the element's `::before` and `::after`, forces its\n`overflow` visible, and gives it a stacking context of its own. Keep the class\noff anything that owns a pseudo-element, clips its content, or is positioned\nabsolutely, and put it on a wrapper instead.\n\n```css\n.my-callout {\n background: var(--surface-brand-lowest);\n border: var(--border-width-1) solid var(--border-brand);\n border-radius: var(--radius-xl);\n\n --sketch-fill: var(--surface-brand-lowest);\n --sketch-stroke: var(--border-brand);\n --sketch-radius: var(--radius-xl);\n}\n```\n\nA gradient is a valid fill: the shorthand's last layer takes a colour or an\nimage, so `--sketch-fill` accepts either. States work the same way, since\nnothing is competing with you for the value:\n\n```css\n.my-callout:hover { --sketch-stroke: var(--border-brand-strong); }\n```\n\n## Images inside a drawn part\n\nA drawn part's `overflow` is forced visible, because the fill and outline are\npainted on pseudo-elements that travel past the box and would otherwise be cut\noff at its edge. A background that bleeds is the effect working. An image that\nbleeds is not: it keeps its square corners while the card around it turns.\n\nMedia that runs to a part's edge therefore has to carry that part's corners\nitself. `--sketch-radius` is the radius the layer drew, and it inherits, so a\nchild can read it and fall back to its own value when Sketch mode is off:\n\n```css\n.cover {\n overflow: hidden;\n border-top-left-radius: var(--sketch-radius, var(--card-default-radius));\n border-top-right-radius: var(--sketch-radius, var(--card-default-radius));\n}\n```\n\nCorner spread is per-corner and per-instance, so at high spread the crop is the\nmean rather than an exact trace of the drawn edge.\n\nA rule made from a `border` is not a box and cannot be displaced. Make it an\nelement, give it `sketch-rule`, and name its ink:\n\n```html\n<div class=\"rule sketch-rule\"></div>\n```\n```css\n.rule {\n height: var(--border-width-2);\n background: var(--border-brand);\n --sketch-fill: var(--border-brand);\n}\n```\n\nIcons and inline SVG take the wobble directly, since a glyph has no box to\nredraw. Body type is left alone: an icon is a shape and survives a wobble, a\nparagraph is not.\n\n`--sketch-icon-off` names what a subtree's glyphs are drawn with instead. It\ninherits, so one declaration covers everything under it, and it takes the ink\nmask off as well as the wobble:\n\n```css\n/* Crisp. Chrome, a logo, anything that has to stay exact. */\n.app-bar { --sketch-icon-off: none; }\n\n/* Drawn back rather than off, at a third of the travel. Small artwork, and\n type set as an SVG, which the layer reads as one large glyph. */\n.wordmark { --sketch-icon-off: var(--sketch-icon-soft); }\n```\n\nThe **Blotch size** dial under Icons and SVG is a share of the glyph rather than\na px size, because no px size is right for both a 16px icon and a page-wide\ndrawing. At 100% every glyph gets one period of the field across it whatever its\nsize. Below that the field repeats inside the glyph and the blotches get finer.\nAbove it a glyph reads part of one blotch, so the mask thins the whole glyph\nunevenly instead of breaking it up. The fill's blotches stay in px, since a\ncomponent does have a size to state one against.\n",
10
+ "sketch-mode": "# Sketch mode\n\nSketch mode redraws your whole page as if it had been drawn by hand. Every\ncomponent keeps its own colours, spacing and corners; what changes is the line\nthey are drawn with.\n\nIt is an effect layer, not a set of token values. It never touches a token\nitself, so turning it off returns every component to exactly what its tokens\nalready say.\n\nOpen the **Sketchstyle** view in the editor and switch **Sketch mode** on. The effect\napplies to the page behind the editor as well as to the preview, so what you see\nin context is what it does.\n\n## What it draws\n\nEach component's fill and outline are repainted from the tokens that component\nalready owns. The real background and border are hidden behind them, then both\nare pushed around one shared field of noise. Because every component samples the\nsame field, the whole page reads as one drawing rather than as a set of\nseparately wobbled boxes.\n\n## The sketchstyles\n\nSeven looks ship with the package, and each is a complete set of dials rather\nthan just a name:\n\n- **Pencil.** Two graphite passes on their own seeds, so the outline disagrees\n with itself the way a hand coming back round does.\n- **Marker.** A broad translucent nib gone round twice on the same line, so the\n overlap darkens and the ink pools where it slows.\n- **Whiteboard.** The fattest nib on glass, with a mask that streaks the fill\n like a half-wiped board.\n- **Hatched.** An etching. The fill is angled shading and the outline a single\n hard-edged scratch.\n- **Dashed.** A drafting outline: one slow drift along the ruler, broken into\n strokes. The clean pole.\n- **Napkin.** Ballpoint in a hurry. Everything loose at once.\n- **Dry marker.** Ink that ran out. One scratchy pass over a mostly eaten fill.\n\nAll seven ship as files, one per look, under\n`src/live-tokens/data/sketch-styles/` in the package. There is no look that\nexists only as code, so every one of them can be read, copied and edited.\n\nPick one, then move whatever you like. **Save As** keeps your dials under a name\nof your own, alongside the shipped seven, as a file under\n`src/live-tokens/data/sketch-styles/` in your project. **Save** writes them back\nover the sketchstyle you have selected, and lights as soon as the dials leave\nit. On one of your own it writes that file. On a shipped one it writes your\nproject's own copy under the same name, which takes its place in the list;\ndelete that copy and the shipped file behind it comes back. Both are a\ndifferent gesture from saving a theme; see \"Where the settings live\" below.\n\nYour sketchstyles and the shipped ones are one list. A sketchstyle named after\na shipped one replaces it, keeping its place in the list, so a project that\nwants its own Pencil saves one and every picker shows that one instead.\n\n## The dials\n\n- **Border.** How far the outline travels and how long its wave is, then its\n width, ink, pressure and pooling. A second pass either copies the first line a\n few pixels off or runs it through the pen again on its own seed.\n- **Fill.** Solid or hatched, how far the fill's edge travels, and how far each\n instance is offset, rotated and scaled from its neighbours. **Ink coverage**\n thins the fill with a field of blotches: set their size across and down and\n how many levels of detail, then work the field as a levels control. The two\n sizes move together under a chain; break it and the blotches stretch, which\n reads as ink dragged along the axis you widened, and a **Rotation** dial joins\n them to point that stretch anywhere you like. The field always runs black\n to white whatever the noise underneath. Steps flattens it into tones, and\n Output squeezes the whole of it into the range the ink covers, from how pale\n it gets at its thinnest to how dense at its fullest. Menus and tooltips are\n drawn solid whatever the coverage dials say: they float over the page, and a\n fill worn through in patches lets the page show through them.\n- **Shape.** **Corner spread** rounds each corner by its own share of the dial,\n so no two match. **Corner travel** leans the drawn box into a quadrilateral\n with no two sides parallel. This is the dial that stops a component reading as\n a rectangle.\n- **Icons and SVG.** Glyph travel and wavelength on their own scale. A glyph is\n all curves already, so it needs more travel than a card's long straight edge\n before the wobble reads at all.\n- **Noise.** The shared field itself: its wavelength, how many layers of detail\n sit on it, and the shape of its wave. A square wave sends nearly every edge to\n full travel, which is what makes the effect stronger rather than bigger.\n\n## Where the settings live\n\nThe sketch layer is part of the theme, the same way colors and type are.\n**Save** in the Theme panel folds your dials into the open theme; **Load**\napplies whatever a theme carries, and turns the effect off for a theme that\ncarries none.\n\nUntil you save, the dials sit in your browser only. The Theme panel calls\nthat state off the theme, the same word it uses for an unsaved component\nchange. The built-in **Motion Proto** theme is read-only, so Save\nis disabled there; use **Save As** to fold the dials into a theme of your\nown.\n\n**Save** and **Save As** in the **Sketchstyle** view are a different gesture.\nThey write a named sketchstyle to `src/live-tokens/data/sketch-styles/`, a look\nyou can pick from any theme. Neither touches the open theme, and neither marks\nthe look off the theme.\n\n## Shipping the layer\n\nThe dev server reads the open theme and paints whatever it carries. A built site\nhas no server to ask, so it hands the field over itself:\n\n```ts\nimport { seedSketchFromTheme } from '@motion-proto/live-tokens/sketch';\nimport theme from './live-tokens/data/themes/sketchy.json';\n\nseedSketchFromTheme(theme.sketchStyle);\nawait bootLiveTokens(App, '#app');\n```\n\nCall it before mounting, so the look is up on the first frame. Pass the field\nraw. A theme written against older dial names is carried forward on the way in,\nthe same reconciliation the dev server runs on every theme it reads.\n\nNothing is baked. `tokens.generated.css` still holds token values only, and the\nlayer stays JavaScript the page runs, because it builds an SVG filter bank\nrather than a set of custom properties.\n\nA visitor who has picked a look of their own keeps it, None included. The theme\nseeds a browser that has decided nothing and never overwrites one that has, so\ncalling this on every boot is safe.\n\n### Your own sketchstyles\n\nThe dev server lists the files in `sketch-styles/`. A built site has no server\nto ask, so it hands them over at boot, the way it hands over components:\n\n```ts\nconst files = import.meta.glob<{ name?: string; settings: unknown }>(\n './live-tokens/data/sketch-styles/*.json',\n { eager: true, import: 'default' },\n);\n\nawait bootLiveTokens(App, '#app', {\n sketchLooks: Object.entries(files).map(([path, file]) => {\n const id = path.split('/').pop()!.replace('.json', '');\n return { id, label: file.name || id, settings: file.settings };\n }),\n});\n```\n\nProjects made with `create` ship this already. The file's slug is the look's\nid, so a sketchstyle picked in the editor keeps working once the site is built.\n\n### Building a picker\n\n`sketchLooks` is every look on offer, shipped and your own, as a store. Give\neach row `setSketch(look.id)`, and add your own **None** row: off is a state of\nthe effect rather than one of the looks.\n\n`themeSketchLook` is the theme's own look as one more row. It is null when the\ntheme carries none, and null when what it carries is a look already in\n`sketchLooks`, since that row names it. Its id goes to `setSketch` like any\nother, so a visitor who wanders off the theme's look can come back to it.\n\n## Drawing your own elements\n\nThe layer draws a fixed set of parts: the shipped components, and four classes\nit reserves for you. Nothing else is touched, so a page element or a\nconsumer-authored component is left crisp until it carries one of them.\n\n| Class | For |\n|---------------------|-----------------------------------------------------------|\n| `sketch-surface` | A box. The default treatment. |\n| `sketch-container` | A large box. Tilts less, so the type inside stays readable. |\n| `sketch-chip` | A small box. Finer fill mask, more rotation, less travel. |\n| `sketch-rule` | A line rather than a box. No rotation, no rounded ends. |\n\nPick by size, not by kind: a card and a modal both take `sketch-container`, a\nbadge and a pill both take `sketch-chip`.\n\nThe class opts the element in; it names no colours, so the element states its\nown. `--sketch-fill`, `--sketch-stroke`, `--sketch-hatch-color`,\n`--sketch-radius` and `--sketch-shadow` name the fill, the outline, the hatching\nink, the corners and the shadow for one element and everything inside it. The\nlayer blanks the real background and border, so an element whose fill matters\nunder Sketch mode has to name it here as well as paint it.\n\nThe layer also paints on the element's `::before` and `::after`, forces its\n`overflow` visible, and gives it a stacking context of its own. Keep the class\noff anything that owns a pseudo-element, clips its content, or is positioned\nabsolutely, and put it on a wrapper instead.\n\n```css\n.my-callout {\n background: var(--surface-brand-lowest);\n border: var(--border-width-1) solid var(--border-brand);\n border-radius: var(--radius-xl);\n\n --sketch-fill: var(--surface-brand-lowest);\n --sketch-stroke: var(--border-brand);\n --sketch-radius: var(--radius-xl);\n}\n```\n\nA gradient is a valid fill: the shorthand's last layer takes a colour or an\nimage, so `--sketch-fill` accepts either. States work the same way, since\nnothing is competing with you for the value:\n\n```css\n.my-callout:hover { --sketch-stroke: var(--border-brand-strong); }\n```\n\n## Images inside a drawn part\n\nA drawn part's `overflow` is forced visible, because the fill and outline are\npainted on pseudo-elements that travel past the box and would otherwise be cut\noff at its edge. A background that bleeds is the effect working. An image that\nbleeds is not: it keeps its square corners while the card around it turns.\n\nMedia that runs to a part's edge therefore has to carry that part's corners\nitself. `--sketch-radius` is the radius the layer drew, and it inherits, so a\nchild can read it and fall back to its own value when Sketch mode is off:\n\n```css\n.cover {\n overflow: hidden;\n border-top-left-radius: var(--sketch-radius, var(--card-default-radius));\n border-top-right-radius: var(--sketch-radius, var(--card-default-radius));\n}\n```\n\nCorner spread is per-corner and per-instance, so at high spread the crop is the\nmean rather than an exact trace of the drawn edge.\n\nA rule made from a `border` is not a box and cannot be displaced. Make it an\nelement, give it `sketch-rule`, and name its ink:\n\n```html\n<div class=\"rule sketch-rule\"></div>\n```\n```css\n.rule {\n height: var(--border-width-2);\n background: var(--border-brand);\n --sketch-fill: var(--border-brand);\n}\n```\n\nIcons and inline SVG take the wobble directly, since a glyph has no box to\nredraw. Body type is left alone: an icon is a shape and survives a wobble, a\nparagraph is not.\n\n`--sketch-icon-off` names what a subtree's glyphs are drawn with instead. It\ninherits, so one declaration covers everything under it, and it takes the ink\nmask off as well as the wobble:\n\n```css\n/* Crisp. Chrome, a logo, anything that has to stay exact. */\n.app-bar { --sketch-icon-off: none; }\n\n/* Drawn back rather than off, at a third of the travel. Small artwork, and\n type set as an SVG, which the layer reads as one large glyph. */\n.wordmark { --sketch-icon-off: var(--sketch-icon-soft); }\n```\n\nThe **Blotch size** dial under Icons and SVG is a share of the glyph rather than\na px size, because no px size is right for both a 16px icon and a page-wide\ndrawing. At 100% every glyph gets one period of the field across it whatever its\nsize. Below that the field repeats inside the glyph and the blotches get finer.\nAbove it a glyph reads part of one blotch, so the mask thins the whole glyph\nunevenly instead of breaking it up. The fill's blotches stay in px, since a\ncomponent does have a size to state one against.\n",
11
11
  "themes-workflow": "# Themes\n\nSave your work, switch between looks, and ship one to production.\n\n## The Theme panel\n\nThe **Theme** panel at the foot of the editor sidebar holds the whole look:\ncolors, type, a setting for every component, and the sketch layer, in one\nfile. It carries the name the look ships under, whether production is running\nit, and **Adopt**. Three parts sit under it, each a read-out rather than a\nfile to manage.\n\n- **Colors & Type** holds the design tokens. Components read those tokens to\n define their appearance. It names the two faces the page is showing.\n- **Components** counts how many components have an unsaved edit that has not\n been saved into the theme, and opens the component editors.\n- **Sketchstyle** names the look the theme's sketch layer carries: its label, or\n off the theme when what's on screen no longer matches what was saved, or\n none when the theme carries no sketch layer. It travels with the theme\n like colors and type do, but never reaches a production build.\n\nA theme holds its own copy of every part, so one theme can never break another.\n\n## How themes work\n\nA theme is a document, and the editor works the way any editor does.\n\n- **A theme** is a named JSON file in `src/live-tokens/data/themes/`. It carries\n the whole look: the colors and type, a setting for every component, and the\n sketch layer.\n- **The open theme** is the one the editor is working on, named in\n `themes/_active.json`. One at a time.\n- **Your unsaved edits** are what the page shows right now. The editor keeps\n them in your browser as you work, writing most parts to a buffer,\n `_working.json`, one slot each; the sketch layer has no buffer and stays\n live in the browser until you save. **Save** captures all of it into the\n open theme.\n- **The production theme** is the one your site ships, named in\n `themes/_production.json`. **Adopt** changes it; saving a preset in the Theme\n Picker performs that Adopt for you.\n\nAbsence is the answer for anything untouched: a buffer exists only where the\nlive look diverges from the active theme, so a newly opened theme has none.\n\n## Fonts\n\nType is part of the look, so it saves, loads and ships with the theme rather\nthan on its own. Four named stacks carry it:\n\n| Stack | Used by |\n|---|---|\n| `--font-display` | headings |\n| `--font-sans` | body text and most UI |\n| `--font-serif` | anywhere you ask for it |\n| `--font-mono` | code |\n\nEach stack is a family followed by its fallbacks, so a page still reads while a\nweb font loads, and still reads if it never does. **Project fonts**, in the\nColors and type editor, is where families come from: type a Google Fonts family\nname and the editor checks it, or paste a fonts URL, an embed tag, or your own\n`@font-face` rules. Removing a family puts the stack back on its fallbacks.\n\nYou can also set both faces at once from the command line:\n\n```bash\nnpx live-tokens set-fonts fonts.json\n```\n\nwith a brief naming the families:\n\n```json\n{ \"display\": \"Fraunces\", \"body\": \"Nunito Sans\" }\n```\n\nIt checks each family against Google Fonts, works out the weights that family\nactually has, and binds it to its stack. Like every other edit, the result lands\nin the buffer, so **Save** keeps it. In Claude Code, asking for a font pairing in\nplain English runs the same command.\n\nA font is only requested by the browser once something on the page uses it, so\ncarrying a family you no longer reference costs nothing at load. Adopting is\nwhat writes the font imports your site ships, into `fonts.css`.\n\n## Saving\n\nIn the Theme panel:\n\n- **Save** captures the look on screen into the open theme. Your colors and type\n go in as part of it, so there is nothing to save first.\n- **Save As** names a new theme. Use it for your first save and for forking.\n\nComponent editors keep their own unsaved state. If one or more components are\nwaiting when you use **Save**, **Save As**, or **Adopt**, the Theme panel offers\nto save all of them before continuing. You can accept once instead of visiting\neach component, or cancel to review them individually. A component editor's\n**Save As** creates a reusable component preset.\n\nNames are tidied to lowercase with hyphens, so \"My Brand!\" becomes `my-brand`,\nand a leading underscore is dropped: those names are reserved for the buffer.\n**Motion Proto** is the built-in theme and is read-only. You can always return\nto it, and the editor never overwrites it, so start your own with **Save As**.\n\n## Switching\n\n**Load**—or clicking the active theme's name—opens the Theme Picker. Picking a\ntheme shows it on the page as a preview with nothing written to disk, sketch\nlayer included, so you can try each look and compare. **Save** in that window\nopens and adopts the previewed theme in one step: the active pointer changes,\nthe buffers clear, the editor works on it, and production ships it. **Cancel**\nreturns you to where you were, unsaved sketch dials included. Previewing alone\nnever changes what your site ships.\n\n**Colors and type only. Keep my shapes.** narrows the load to the palette and\nthe fonts: your component settings and your sketch layer stay as they are, and\nthe theme you have open stays open. Saved colors and type files are listed\nthere too, marked *colors & type*, and picking one is always that narrower\nload.\n\n## Shipping\n\n**Adopt**, in the Theme panel, is the \"ship it\" step. It saves the open theme,\nthen bakes the colors and type plus every component the theme carries into\n`src/live-tokens/data/tokens.generated.css`, which your build bundles alongside\n`tokens.css`. The sketch layer is the one part of the theme Adopt never bakes:\nit stays a preview. Fonts regenerate to match. The line under the theme name\nsays whether production is running this theme.\n\nProduction is one saved theme, so nothing else publishes. Trying a look, moving\na token, saving a theme: all of it leaves the generated CSS alone until you\nAdopt. A component editor's Adopt runs the same save-then-bake step, because a\ncomponent never ships alone. Adopting while Motion Proto is open saves your look\nas a theme of your own first, since the built-in one is read-only.\n\nProduction builds (`npm run build`) ship only that plain CSS and your\ncomponents. No editor, no JSON loading, no runtime indirection.\n\n## Keeping your work safe\n\nEverything under `src/live-tokens/data/` is plain JSON, so commit it. Themes show\nup as readable diffs you can review per branch, and the buffer shows up as the\nwork you have not saved into a theme yet. Nothing is backed up anywhere else:\ngit is your safety net. To experiment freely, **Save As** a new name first, then\nedit.\n\n## Where to go next\n\n- **[Where themes live](where-themes-live.md)**: the files behind all of this,\n and what writes each one.\n- **[Creating components](creating-components.md)**: make your own components\n editable in the same editor.\n",
12
12
  "where-themes-live": "# Where themes live\n\nEverything the editor writes is plain JSON and CSS inside your project. There\nis no database and no hidden state: the files are the storage, and git is the\nhistory.\n\n## The data tree\n\n```\nsrc/live-tokens/data/\n themes/\n _active.json names the theme the editor has open\n _production.json names the theme your site ships\n default.json Motion Proto, the built-in look, rewritten at boot\n my-brand.json a saved theme: the whole look in one file\n colors-and-type/\n _working.json unsaved colors and type edits\n component-configs/\n button/\n default.json Button's shipped settings, derived at boot\n _working.json unsaved Button edits\n my-button.json a preset you saved from the Button editor\n sketch-styles/\n my-look.json a sketchstyle saved from the Sketchstyle view\n tokens.generated.css the baked CSS your production build ships\nsrc/system/styles/\n tokens.css your token vocabulary, hand-authored, never written\n fonts.css font imports, rewritten when you Adopt\n```\n\nA saved theme carries the whole look by value: the colors and type, a\nsetting for every component, and the sketch layer. It depends on no other\nfile, so deleting anything else never breaks it.\n\n## What writes when\n\n- **Editing** changes the page through CSS variables. The editor keeps your\n edits in the browser as you work and writes them to the `_working.json`\n buffers when you save a component. When the Theme panel finds several dirty\n components, **Save all** writes those buffers together.\n- **Save** captures the buffers into the open theme's file, along with the\n sketch layer, which has no buffer of its own and lives only in the browser\n until Save writes it. That file is the durable copy of your look; matching\n buffers are then removed.\n- **Load** clears the buffers and points `themes/_active.json` at the theme you\n picked. Live reads fall through to that file. Nothing else changes, so trying\n looks is free and ordinary switching changes only the pointer.\n- **Adopt** points `themes/_production.json` at the open theme, bakes it into\n `tokens.generated.css`, and rewrites `fonts.css` to match. It is the only\n action that changes what your site ships.\n\nThe `default.json` files are the shipped baseline. The editor derives them at\nboot and refreshes them when the package updates; it never saves your work\nover them.\n\nProjects upgraded from 0.48 may initially contain working files copied from the\nactive theme. On the first dev-server boot, exact copies are removed\nautomatically. Any file that differs is kept as unsaved work, so no migration\ncommand is required.\n\n## What to commit\n\nAll of it. The data tree is designed to live in git: themes diff readably, the\ntwo pointers say what is open and what ships, and a `_working.json` in a diff\nis exactly the work you have not yet saved into a theme. Nothing is backed up\nanywhere else.\n\n## Where to go next\n\n- **[Themes](themes-workflow.md)**: the workflow built on these files: saving,\n loading, and shipping.\n",
13
13
  };