@usesketchbook/cli 0.2.1 → 0.4.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.
- package/.agents/skills/component-builder/SKILL.md +16 -0
- package/.agents/skills/contract-author/SKILL.md +16 -0
- package/.claude/commands/add.md +1 -5
- package/.claude/skills/component-builder/SKILL.md +15 -101
- package/.claude/skills/contract-author/SKILL.md +14 -132
- package/README.md +14 -30
- package/docs/agent-compatibility.md +43 -9
- package/docs/cli.md +31 -31
- package/harness/catalog/kits/dashboard/files/{63cde4f28d1c141c401d → 09d34e607ea6836480d1} +1 -1
- package/harness/catalog/kits/dashboard/files/{11a5797c4c9189b59fbe → 2239c4e4f1d873b03305} +1 -1
- package/harness/catalog/kits/dashboard/files/{864acc7ce20f541cf67c → 567a658f80560e3945c6} +1 -1
- package/harness/catalog/kits/dashboard/manifest.json +4 -4
- package/harness/catalog/kits/data-table/files/{b5d5d7f18347734138e0 → 35c832acd45c642705b1} +1 -1
- package/harness/catalog/kits/data-table/files/{36bac8f8e53119768b2e → aaf2d576ed0b53013ac3} +1 -1
- package/harness/catalog/kits/data-table/files/{1786ba4d3e0dba1d6a1f → ac8792b3aa3a43002c5e} +1 -1
- package/harness/catalog/kits/data-table/manifest.json +4 -4
- package/harness/catalog/kits/docs-article/files/{dbc2840f315f672e1d74 → 3c554edf05e9c8bb52c7} +1 -1
- package/harness/catalog/kits/docs-article/files/{7f36cb5f0d4f5e103bde → 9d0bb5a1be919431e8ce} +1 -1
- package/harness/catalog/kits/docs-article/files/{c2018b502a8094818d8f → e80ea70679e0065026d0} +1 -1
- package/harness/catalog/kits/docs-article/manifest.json +4 -4
- package/harness/catalog/kits/form-states/files/{b52fb2fc480f0c6352bd → 55a0558891d66e11c216} +1 -1
- package/harness/catalog/kits/form-states/files/{88252259f19ed675a0dc → 64566f1a9cb16592d296} +1 -1
- package/harness/catalog/kits/form-states/files/{b0b51ebf587b21fd89a1 → f086df13cb85411108a1} +1 -1
- package/harness/catalog/kits/form-states/manifest.json +4 -4
- package/harness/catalog/kits/onboarding/files/{e669d75a65f4d15d8289 → 738531c9cf4c8bfb9e28} +1 -1
- package/harness/catalog/kits/onboarding/files/{ce466020247ecf1ff5fe → b72445926f9763db6c4f} +1 -1
- package/harness/catalog/kits/onboarding/files/{322cf4dfc2ee0a035d85 → c969943667ca18e8b0d3} +1 -1
- package/harness/catalog/kits/onboarding/manifest.json +4 -4
- package/harness/catalog/kits/profile/files/{4aeca453e4792abf29de → 38a6ccd576aca5c96612} +1 -1
- package/harness/catalog/kits/profile/files/{0fdd3c14afbdadcf1969 → adccaa2829c56d7fa215} +1 -1
- package/harness/catalog/kits/profile/files/{5b58bb5f93ecf12d69ff → de99237cdcfb4ddef8dd} +1 -1
- package/harness/catalog/kits/profile/manifest.json +4 -4
- package/harness/catalog/kits/settings/files/{d2ebbd6e94570b2c6434 → 08c4411e3c8dbc9e614f} +1 -1
- package/harness/catalog/kits/settings/files/{b4a7a4ccdc59465b8de5 → d1cd9cf4acd3416e3f63} +1 -1
- package/harness/catalog/kits/settings/files/{1a5d639c6803e7d03acc → f325b6c93ce84d356228} +1 -1
- package/harness/catalog/kits/settings/manifest.json +4 -4
- package/harness/catalog/kits/sign-in/files/{ca224349b746c530f922 → 0ac413f342ed59e8f3d9} +1 -1
- package/harness/catalog/kits/sign-in/files/{552bdad5ce7559849e81 → 796309acee1d478d2692} +1 -1
- package/harness/catalog/kits/sign-in/files/{361745a3ed43c753c615 → a106d6104e40b13d7e82} +1 -1
- package/harness/catalog/kits/sign-in/manifest.json +4 -4
- package/harness/checks/run.mjs +1 -2
- package/harness/cli/commands/add.mjs +5 -3
- package/harness/cli/commands/api.d.mts +4 -4
- package/harness/cli/commands/api.mjs +1 -1
- package/harness/cli/commands/audit-css.mjs +1 -1
- package/harness/cli/commands/audit-decisions.mjs +1 -1
- package/harness/cli/commands/audit-page.mjs +1 -1
- package/harness/cli/commands/brand.mjs +1 -1
- package/harness/cli/commands/check.d.mts +1 -1
- package/harness/cli/commands/check.mjs +1 -1
- package/harness/cli/commands/docs.mjs +2 -2
- package/harness/cli/commands/doctor.d.mts +2 -2
- package/harness/cli/commands/doctor.mjs +7 -5
- package/harness/cli/commands/explain.mjs +1 -1
- package/harness/cli/commands/generate.mjs +1 -1
- package/harness/cli/commands/help.mjs +5 -5
- package/harness/cli/commands/icons.mjs +1 -1
- package/harness/cli/commands/init.d.mts +1 -1
- package/harness/cli/commands/init.mjs +4 -4
- package/harness/cli/commands/kits.mjs +3 -1
- package/harness/cli/commands/list.mjs +1 -1
- package/harness/cli/commands/prefix.mjs +1 -1
- package/harness/cli/commands/presets.mjs +1 -1
- package/harness/cli/commands/propagate.mjs +1 -1
- package/harness/cli/commands/remove.mjs +4 -2
- package/harness/cli/commands/selftest.mjs +1 -1
- package/harness/cli/commands/status.mjs +6 -4
- package/harness/cli/commands/swap.mjs +1 -1
- package/harness/cli/commands/sync.mjs +3 -3
- package/harness/cli/commands/tokens.mjs +9 -8
- package/harness/cli/commands/upgrade.mjs +7 -3
- package/harness/cli/docs.mjs +2 -2
- package/harness/cli/interactive.mjs +10 -10
- package/harness/cli/known-commands.json +26 -26
- package/harness/cli/presentation.d.mts +1 -1
- package/harness/cli/presentation.mjs +1 -1
- package/harness/cli/run.d.mts +3 -3
- package/harness/cli/run.mjs +5 -5
- package/harness/cli.mjs +0 -0
- package/harness/commands/add.mjs +1 -1
- package/harness/commands/bootstrap.mjs +4 -3
- package/harness/kits/index.json +8 -8
- package/harness/lib/agent-config.d.mts +1 -0
- package/harness/lib/agent-config.mjs +7 -6
- package/harness/lib/design/docs.mjs +2 -2
- package/harness/lib/design/sync.d.mts +1 -1
- package/harness/lib/installed.mjs +3 -1
- package/harness/lib/propagation.mjs +2 -2
- package/harness/manifest.json +3 -1
- package/harness/starters/blank.json +1 -1
- package/harness/starters/foundations.json +1 -1
- package/harness/starters/from-codebase.json +1 -1
- package/harness/starters/import.json +1 -1
- package/harness/starters/library+kits.json +1 -1
- package/harness/starters/library.json +1 -1
- package/harness/starters/pick.json +1 -1
- package/harness/templates/CLAUDE.md +1 -1
- package/harness/templates/project/.agents/skills/sketchbook/SKILL.md +1 -1
- package/harness/templates/project/AGENT-WORKFLOWS.md +2 -2
- package/harness/templates/project/docs/getting-started.md +17 -20
- package/harness/templates/project/package-lock.json +2 -2
- package/harness/templates/project/src/stories/contract.ts +4 -1
- package/harness/templates/project/src/stories/foundations/BorderWidth.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Color.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Density.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Elevation.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/IconSizes.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/LayoutGrid.stories.ts +2 -2
- package/harness/templates/project/src/stories/foundations/Motion.stories.ts +1 -2
- package/harness/templates/project/src/stories/foundations/Opacity.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Radius.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Spacing.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/Typography.stories.ts +1 -1
- package/harness/templates/project/src/stories/foundations/ZIndex.stories.ts +1 -1
- package/harness/test/agent-config.test.mjs +21 -1
- package/harness/test/agent-guidance.test.mjs +16 -0
- package/harness/test/bootstrap.test.mjs +84 -15
- package/harness/test/checks.test.mjs +4 -1
- package/harness/test/claude-live.test.mjs +8 -3
- package/harness/test/cli.test.mjs +25 -5
- package/harness/test/copilot-live.test.mjs +12 -13
- package/harness/test/docs-reference.test.mjs +17 -0
- package/harness/test/opencode-live.test.mjs +25 -10
- package/harness/test/package.test.mjs +1 -0
- package/package.json +3 -1
package/docs/cli.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- GENERATED from harness/cli/commands by npm run build:cli-docs. Do not edit; change the command module. -->
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Use the Sketchbook CLI to set up your project, change its sources, and verify the outputs. Run `sketchbook help <command> --details` for the full terminal reference.
|
|
6
6
|
|
|
7
7
|
## Conventions
|
|
8
8
|
|
|
@@ -10,21 +10,21 @@ Deterministic half of the harness. Run `sketchbook <command>` (or `node harness/
|
|
|
10
10
|
- `--details` shows full human-readable output where a terminal view is abbreviated.
|
|
11
11
|
- `--json` on every command prints one envelope: `{ ok, command, changed[], warnings[], errors[{file, msg, fix}], next, data? }`.
|
|
12
12
|
- Exit codes: 0 ok, 1 failed, 2 ok with flags (for example overrides kept in spec/tokens/overrides.json).
|
|
13
|
-
-
|
|
13
|
+
- Use `--dry-run` on commands marked as supporting it to review the paths and values that would change.
|
|
14
14
|
- Conventions (one registry, introspect before mutate, JSON envelope) are adapted from CLI-Anything (HKUDS, Apache-2.0, https://github.com/HKUDS/CLI-Anything); no code is used.
|
|
15
15
|
|
|
16
16
|
| Global option | Meaning |
|
|
17
17
|
| --- | --- |
|
|
18
|
-
| `--json` | Print
|
|
19
|
-
| `--dry-run` |
|
|
18
|
+
| `--json` | Print a structured JSON result |
|
|
19
|
+
| `--dry-run` | Preview file changes on supported commands |
|
|
20
20
|
| `--help` | Show help for the command |
|
|
21
|
-
| `--details` | Show the full
|
|
21
|
+
| `--details` | Show the full terminal output |
|
|
22
22
|
|
|
23
23
|
## Project
|
|
24
24
|
|
|
25
25
|
### init
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
Set up a design system from a starter, or update the setup in an existing project. Choose --agent to add guidance for your coding tools.
|
|
28
28
|
|
|
29
29
|
```
|
|
30
30
|
sketchbook init [--name <value>] [--primary <value>] [--font <value>] [--radius <value>] [--density <value>] [--danger <value>] [--design <value>] [--file <value>] [--prefix <value>] [--start <starter>] [--components <a,b>] [--from <file>] [--yes] [--dir <folder>] [--adopt] [--engine <spec>] [--no-install] [--agent <profiles>] [--with <groups>] [--detach-catalog] [--dry-run] [--json]
|
|
@@ -71,7 +71,7 @@ Examples:
|
|
|
71
71
|
|
|
72
72
|
### status
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
See your active brand, component counts, token overrides, and design sync status.
|
|
75
75
|
|
|
76
76
|
```
|
|
77
77
|
sketchbook status [--json]
|
|
@@ -86,7 +86,7 @@ Examples:
|
|
|
86
86
|
|
|
87
87
|
### doctor
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
See what needs attention in your project. Review checks, installed files, agent profiles, and design sync. Uses the same exit codes as sketchbook check.
|
|
90
90
|
|
|
91
91
|
```
|
|
92
92
|
sketchbook doctor [--json]
|
|
@@ -101,7 +101,7 @@ Examples:
|
|
|
101
101
|
|
|
102
102
|
### upgrade
|
|
103
103
|
|
|
104
|
-
Update harness-owned files
|
|
104
|
+
Update harness-owned files from the installed engine or a newer Sketchbook source. Preview the files with --dry-run. For a folder or Git URL, use --from. Updating from that source requires --yes when files would change.
|
|
105
105
|
|
|
106
106
|
```
|
|
107
107
|
sketchbook upgrade [--from <path|git-url>] [--yes] [--dry-run] [--json]
|
|
@@ -122,7 +122,7 @@ Examples:
|
|
|
122
122
|
|
|
123
123
|
### propagate
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Rebuild outputs after a source change and record the build. Use --maintainer to include Storybook and the Docs site. Run the generated design scripts to carry the change into Figma.
|
|
126
126
|
|
|
127
127
|
```
|
|
128
128
|
sketchbook propagate [--maintainer] [--json]
|
|
@@ -141,7 +141,7 @@ Examples:
|
|
|
141
141
|
|
|
142
142
|
### generate
|
|
143
143
|
|
|
144
|
-
Rebuild
|
|
144
|
+
Rebuild tokens, styles, and other generated outputs from your project sources. Run npm run generate in an initialized project for the same build.
|
|
145
145
|
|
|
146
146
|
```
|
|
147
147
|
sketchbook generate [--json]
|
|
@@ -156,7 +156,7 @@ Examples:
|
|
|
156
156
|
|
|
157
157
|
### prefix
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
Change the element and CSS prefix across your project, then rebuild and check the outputs.
|
|
160
160
|
|
|
161
161
|
```
|
|
162
162
|
sketchbook prefix <new> [--dry-run] [--json]
|
|
@@ -175,7 +175,7 @@ Examples:
|
|
|
175
175
|
|
|
176
176
|
### swap
|
|
177
177
|
|
|
178
|
-
|
|
178
|
+
Change the tool that builds tokens or syncs your design file, then rebuild and check.
|
|
179
179
|
|
|
180
180
|
```
|
|
181
181
|
sketchbook swap <output> <adapter> [--file <id>] [--dry-run] [--json]
|
|
@@ -201,7 +201,7 @@ Examples:
|
|
|
201
201
|
|
|
202
202
|
### add
|
|
203
203
|
|
|
204
|
-
Install a
|
|
204
|
+
Install a catalog component with its dependencies, or start a new contract with --blank.
|
|
205
205
|
|
|
206
206
|
```
|
|
207
207
|
sketchbook add <Component Name...> [--blank] [--dry-run] [--json]
|
|
@@ -225,7 +225,7 @@ Examples:
|
|
|
225
225
|
|
|
226
226
|
### remove
|
|
227
227
|
|
|
228
|
-
|
|
228
|
+
Remove a component you no longer use. Review dependencies and local edits before removing it.
|
|
229
229
|
|
|
230
230
|
```
|
|
231
231
|
sketchbook remove <Component Name...> [--yes] [--dry-run] [--json]
|
|
@@ -249,7 +249,7 @@ Examples:
|
|
|
249
249
|
|
|
250
250
|
### list
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
Browse installed and available components and see which dependencies they need.
|
|
253
253
|
|
|
254
254
|
```
|
|
255
255
|
sketchbook list [--installed] [--available] [--json]
|
|
@@ -270,7 +270,7 @@ Examples:
|
|
|
270
270
|
|
|
271
271
|
### kits
|
|
272
272
|
|
|
273
|
-
|
|
273
|
+
Browse template kits, install a kit with its components, or remove one.
|
|
274
274
|
|
|
275
275
|
```
|
|
276
276
|
sketchbook kits [action] [kit...] [--yes] [--dry-run] [--json]
|
|
@@ -302,7 +302,7 @@ Examples:
|
|
|
302
302
|
|
|
303
303
|
### api
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Look up component property, event, and state names in the shared API vocabulary.
|
|
306
306
|
|
|
307
307
|
```
|
|
308
308
|
sketchbook api [action] [name] [--json]
|
|
@@ -334,7 +334,7 @@ Examples:
|
|
|
334
334
|
|
|
335
335
|
### tokens
|
|
336
336
|
|
|
337
|
-
|
|
337
|
+
Set foundation values, manage semantic tokens, or trace the impact of a change.
|
|
338
338
|
|
|
339
339
|
```
|
|
340
340
|
sketchbook tokens <subcommand> [args...] [--value <v>] [--light <v>] [--dark <v>] [--type <type>] [--pair <fg:bg>] [--kind <text|large-text|ui>] [--against <ref>] [--from <dtcg|css>] [--name <n>] [--only <semantic|foundation|mapped>] [--min-confidence <0.6>] [--answers <file.json>] [--all] [--yes] [--verbose] [--no-record] [--dry-run] [--json]
|
|
@@ -416,7 +416,7 @@ Examples:
|
|
|
416
416
|
|
|
417
417
|
### presets
|
|
418
418
|
|
|
419
|
-
|
|
419
|
+
Browse foundation presets by family, with their values and sources.
|
|
420
420
|
|
|
421
421
|
```
|
|
422
422
|
sketchbook presets [family] [--json]
|
|
@@ -435,7 +435,7 @@ Examples:
|
|
|
435
435
|
|
|
436
436
|
### brand
|
|
437
437
|
|
|
438
|
-
|
|
438
|
+
Add, list, or switch brands that share the same semantic token names.
|
|
439
439
|
|
|
440
440
|
```
|
|
441
441
|
sketchbook brand [action] [name] [--from <current|brand>] [--yes] [--dry-run] [--json]
|
|
@@ -469,7 +469,7 @@ Examples:
|
|
|
469
469
|
|
|
470
470
|
### audit-css
|
|
471
471
|
|
|
472
|
-
|
|
472
|
+
Inspect an existing stylesheet to find recurring values and draft foundation choices.
|
|
473
473
|
|
|
474
474
|
```
|
|
475
475
|
sketchbook audit-css <paths...> [--dry-run] [--json]
|
|
@@ -490,7 +490,7 @@ Examples:
|
|
|
490
490
|
|
|
491
491
|
### icons
|
|
492
492
|
|
|
493
|
-
|
|
493
|
+
List the icons in your project or add icons from Lucide.
|
|
494
494
|
|
|
495
495
|
```
|
|
496
496
|
sketchbook icons [action] [names...] [--category <category>] [--dry-run] [--json]
|
|
@@ -521,7 +521,7 @@ Examples:
|
|
|
521
521
|
|
|
522
522
|
### sync
|
|
523
523
|
|
|
524
|
-
|
|
524
|
+
Prepare scripts to update or verify your Figma file. Record sync progress after you run the scripts. Use verify to compare a read-back with the spec, stamp to record a push or stage, and realize to write design realizations.
|
|
525
525
|
|
|
526
526
|
```
|
|
527
527
|
sketchbook sync [what] [names...] [--verify] [--full] [--detail <combination>] [--url <http://localhost:6006>] [--ingest <file.json>] [--dry-run] [--json]
|
|
@@ -575,7 +575,7 @@ Examples:
|
|
|
575
575
|
|
|
576
576
|
### docs
|
|
577
577
|
|
|
578
|
-
|
|
578
|
+
Read a component or kit’s variants, tokens, and accessibility guidance. Use --json for the design blueprint.
|
|
579
579
|
|
|
580
580
|
```
|
|
581
581
|
sketchbook docs <name> [--json]
|
|
@@ -597,7 +597,7 @@ Examples:
|
|
|
597
597
|
|
|
598
598
|
### audit-page
|
|
599
599
|
|
|
600
|
-
Check a
|
|
600
|
+
Check a page for a level-one heading and a main landmark. This checks page structure only.
|
|
601
601
|
|
|
602
602
|
```
|
|
603
603
|
sketchbook audit-page <file> [--json]
|
|
@@ -616,7 +616,7 @@ Examples:
|
|
|
616
616
|
|
|
617
617
|
### audit-decisions
|
|
618
618
|
|
|
619
|
-
Compare
|
|
619
|
+
Compare settled decisions with a trusted earlier copy or Git revision. Run sketchbook check to validate the log.
|
|
620
620
|
|
|
621
621
|
```
|
|
622
622
|
sketchbook audit-decisions [baseline] [--git-ref <ref>] [--json]
|
|
@@ -639,7 +639,7 @@ Examples:
|
|
|
639
639
|
|
|
640
640
|
### check
|
|
641
641
|
|
|
642
|
-
|
|
642
|
+
Check that your sources and outputs agree. Exit 0 means pass, 1 means a failure, and 2 means pass with flagged overrides.
|
|
643
643
|
|
|
644
644
|
```
|
|
645
645
|
sketchbook check [--only <T1,T6>] [--fix] [--verbose] [--maintainer] [--json]
|
|
@@ -663,7 +663,7 @@ Examples:
|
|
|
663
663
|
|
|
664
664
|
### selftest
|
|
665
665
|
|
|
666
|
-
Run the harness
|
|
666
|
+
Run the harness test suite to verify the tools that build and check your project.
|
|
667
667
|
|
|
668
668
|
```
|
|
669
669
|
sketchbook selftest [--json]
|
|
@@ -677,7 +677,7 @@ Examples:
|
|
|
677
677
|
|
|
678
678
|
### explain
|
|
679
679
|
|
|
680
|
-
|
|
680
|
+
Trace a token to its source, find a component’s files, or look up a decision.
|
|
681
681
|
|
|
682
682
|
```
|
|
683
683
|
sketchbook explain <thing...> [--json]
|
|
@@ -699,7 +699,7 @@ Examples:
|
|
|
699
699
|
|
|
700
700
|
### help
|
|
701
701
|
|
|
702
|
-
|
|
702
|
+
Find a command or look up its usage, options, and examples.
|
|
703
703
|
|
|
704
704
|
```
|
|
705
705
|
sketchbook help [command] [--json]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Dashboard",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Give your team one place to check progress, review recent activity, and act on orders.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-aspect-ratio",
|
|
6
6
|
"sb-avatar",
|
|
@@ -122,7 +122,7 @@ const dashboard = (loading = false) => html`<div class="dashboard">
|
|
|
122
122
|
|
|
123
123
|
const meta: Meta = {
|
|
124
124
|
title: 'Patterns/Dashboard',
|
|
125
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
125
|
+
parameters: { docs: { description: { component: 'Give your team one place to check progress, review recent activity, and act on orders.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
126
126
|
render: () => dashboard(),
|
|
127
127
|
};
|
|
128
128
|
export default meta;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Dashboard
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Give your team one place to check progress, review recent activity, and act on orders.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
The landing page of an app or workspace that summarizes what changed. Not a place for editing: link to the list or detail pages instead.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "dashboard",
|
|
3
3
|
"title": "Dashboard",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Give your team one place to check progress, review recent activity, and act on orders.",
|
|
5
5
|
"path": "src/patterns/dashboard",
|
|
6
6
|
"components": [
|
|
7
7
|
"aspect-ratio",
|
|
@@ -34,11 +34,11 @@
|
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"path": "src/patterns/dashboard/Dashboard.stories.ts",
|
|
37
|
-
"hash": "
|
|
37
|
+
"hash": "2239c4e4f1d873b03305"
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
"path": "src/patterns/dashboard/README.md",
|
|
41
|
-
"hash": "
|
|
41
|
+
"hash": "567a658f80560e3945c6"
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"path": "src/patterns/dashboard/dashboard.css",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"path": "src/patterns/dashboard/pattern.json",
|
|
49
|
-
"hash": "
|
|
49
|
+
"hash": "09d34e607ea6836480d1"
|
|
50
50
|
}
|
|
51
51
|
]
|
|
52
52
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Data table",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Help people find orders, narrow the list by status, and select the rows they want to act on.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-avatar",
|
|
6
6
|
"sb-avatar-fallback",
|
|
@@ -128,7 +128,7 @@ const page = (body: unknown) => html`<main class="data-table" @keydown=${slash}>
|
|
|
128
128
|
|
|
129
129
|
const meta: Meta = {
|
|
130
130
|
title: 'Patterns/Data Table',
|
|
131
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
131
|
+
parameters: { docs: { description: { component: 'Help people find orders, narrow the list by status, and select the rows they want to act on.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
132
132
|
render: () => page(html`<p role="status" class="data-table__hint">${shown(customers.length)}</p>${table(false)}${pages}`),
|
|
133
133
|
};
|
|
134
134
|
export default meta;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Data table
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Help people find orders, narrow the list by status, and select the rows they want to act on.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
Any collection people search, filter and act on in bulk: customers, orders, files. For a handful of items use the Item list from the profile kit instead.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "data-table",
|
|
3
3
|
"title": "Data table",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Help people find orders, narrow the list by status, and select the rows they want to act on.",
|
|
5
5
|
"path": "src/patterns/data-table",
|
|
6
6
|
"components": [
|
|
7
7
|
"avatar",
|
|
@@ -38,11 +38,11 @@
|
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
"path": "src/patterns/data-table/DataTable.stories.ts",
|
|
41
|
-
"hash": "
|
|
41
|
+
"hash": "aaf2d576ed0b53013ac3"
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"path": "src/patterns/data-table/README.md",
|
|
45
|
-
"hash": "
|
|
45
|
+
"hash": "ac8792b3aa3a43002c5e"
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"path": "src/patterns/data-table/data-table.css",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
},
|
|
51
51
|
{
|
|
52
52
|
"path": "src/patterns/data-table/pattern.json",
|
|
53
|
-
"hash": "
|
|
53
|
+
"hash": "35c832acd45c642705b1"
|
|
54
54
|
}
|
|
55
55
|
]
|
|
56
56
|
}
|
package/harness/catalog/kits/docs-article/files/{dbc2840f315f672e1d74 → 3c554edf05e9c8bb52c7}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Docs article",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Help readers follow a guide with a contents sidebar, diagram, code sample, and links to what comes next.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-accordion",
|
|
6
6
|
"sb-accordion-content",
|
package/harness/catalog/kits/docs-article/files/{7f36cb5f0d4f5e103bde → 9d0bb5a1be919431e8ce}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Docs article
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Help readers follow a guide with a contents sidebar, diagram, code sample, and links to what comes next.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
Guides, help articles and any page that is mostly reading. Use it to check line length, line height and the heading scale with your brand.
|
package/harness/catalog/kits/docs-article/files/{c2018b502a8094818d8f → e80ea70679e0065026d0}
RENAMED
|
@@ -101,7 +101,7 @@ const article = html`<div class="docs">
|
|
|
101
101
|
|
|
102
102
|
const meta: Meta = {
|
|
103
103
|
title: 'Patterns/Docs Article',
|
|
104
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
104
|
+
parameters: { docs: { description: { component: 'Help readers follow a guide with a contents sidebar, diagram, code sample, and links to what comes next.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
105
105
|
render: () => article,
|
|
106
106
|
};
|
|
107
107
|
export default meta;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "docs-article",
|
|
3
3
|
"title": "Docs article",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Help readers follow a guide with a contents sidebar, diagram, code sample, and links to what comes next.",
|
|
5
5
|
"path": "src/patterns/docs-article",
|
|
6
6
|
"components": [
|
|
7
7
|
"accordion",
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
34
|
"path": "src/patterns/docs-article/DocsArticle.stories.ts",
|
|
35
|
-
"hash": "
|
|
35
|
+
"hash": "e80ea70679e0065026d0"
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"path": "src/patterns/docs-article/README.md",
|
|
39
|
-
"hash": "
|
|
39
|
+
"hash": "9d0bb5a1be919431e8ce"
|
|
40
40
|
},
|
|
41
41
|
{
|
|
42
42
|
"path": "src/patterns/docs-article/docs-article.css",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
"path": "src/patterns/docs-article/pattern.json",
|
|
47
|
-
"hash": "
|
|
47
|
+
"hash": "3c554edf05e9c8bb52c7"
|
|
48
48
|
}
|
|
49
49
|
]
|
|
50
50
|
}
|
package/harness/catalog/kits/form-states/files/{b52fb2fc480f0c6352bd → 55a0558891d66e11c216}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Form states
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Compare default, disabled, invalid, and read-only controls to check tokens, focus, and right-to-left layout.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
To review a brand or token change: focus rings, border widths, contrast and spacing for all controls at once. It is a review page, not a product screen.
|
package/harness/catalog/kits/form-states/files/{88252259f19ed675a0dc → 64566f1a9cb16592d296}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Form states",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Compare default, disabled, invalid, and read-only controls to check tokens, focus, and right-to-left layout.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-checkbox",
|
|
6
6
|
"sb-direction",
|
package/harness/catalog/kits/form-states/files/{b0b51ebf587b21fd89a1 → f086df13cb85411108a1}
RENAMED
|
@@ -125,7 +125,7 @@ const gallery = html`<main class="form-states">
|
|
|
125
125
|
|
|
126
126
|
const meta: Meta = {
|
|
127
127
|
title: 'Patterns/Form States',
|
|
128
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
128
|
+
parameters: { docs: { description: { component: 'Compare default, disabled, invalid, and read-only controls to check tokens, focus, and right-to-left layout.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
129
129
|
render: () => gallery,
|
|
130
130
|
};
|
|
131
131
|
export default meta;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "form-states",
|
|
3
3
|
"title": "Form states",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Compare default, disabled, invalid, and read-only controls to check tokens, focus, and right-to-left layout.",
|
|
5
5
|
"path": "src/patterns/form-states",
|
|
6
6
|
"components": [
|
|
7
7
|
"checkbox",
|
|
@@ -34,11 +34,11 @@
|
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"path": "src/patterns/form-states/FormStates.stories.ts",
|
|
37
|
-
"hash": "
|
|
37
|
+
"hash": "f086df13cb85411108a1"
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
"path": "src/patterns/form-states/README.md",
|
|
41
|
-
"hash": "
|
|
41
|
+
"hash": "55a0558891d66e11c216"
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"path": "src/patterns/form-states/form-states.css",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"path": "src/patterns/form-states/pattern.json",
|
|
49
|
-
"hash": "
|
|
49
|
+
"hash": "64566f1a9cb16592d296"
|
|
50
50
|
}
|
|
51
51
|
]
|
|
52
52
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Onboarding",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Guide someone through their first setup, then show what to do in an empty workspace.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-button",
|
|
6
6
|
"sb-card",
|
|
@@ -105,7 +105,7 @@ const settingUp = html`<main class="onboarding">
|
|
|
105
105
|
|
|
106
106
|
const meta: Meta = {
|
|
107
107
|
title: 'Patterns/Onboarding',
|
|
108
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
108
|
+
parameters: { docs: { description: { component: 'Guide someone through their first setup, then show what to do in an empty workspace.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
109
109
|
render: () => step,
|
|
110
110
|
};
|
|
111
111
|
export default meta;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Onboarding
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Guide someone through their first setup, then show what to do in an empty workspace.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
The first minutes after sign-up, and any empty area that needs to explain what goes there and how to fill it.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "onboarding",
|
|
3
3
|
"title": "Onboarding",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Guide someone through their first setup, then show what to do in an empty workspace.",
|
|
5
5
|
"path": "src/patterns/onboarding",
|
|
6
6
|
"components": [
|
|
7
7
|
"button",
|
|
@@ -35,11 +35,11 @@
|
|
|
35
35
|
},
|
|
36
36
|
{
|
|
37
37
|
"path": "src/patterns/onboarding/Onboarding.stories.ts",
|
|
38
|
-
"hash": "
|
|
38
|
+
"hash": "b72445926f9763db6c4f"
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
41
|
"path": "src/patterns/onboarding/README.md",
|
|
42
|
-
"hash": "
|
|
42
|
+
"hash": "c969943667ca18e8b0d3"
|
|
43
43
|
},
|
|
44
44
|
{
|
|
45
45
|
"path": "src/patterns/onboarding/onboarding.css",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
},
|
|
48
48
|
{
|
|
49
49
|
"path": "src/patterns/onboarding/pattern.json",
|
|
50
|
-
"hash": "
|
|
50
|
+
"hash": "738531c9cf4c8bfb9e28"
|
|
51
51
|
}
|
|
52
52
|
]
|
|
53
53
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "Profile",
|
|
3
|
-
"summary": "
|
|
3
|
+
"summary": "Let people update their public profile and see which services are connected.",
|
|
4
4
|
"components": [
|
|
5
5
|
"sb-avatar",
|
|
6
6
|
"sb-avatar-fallback",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Profile
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Let people update their public profile and see which services are connected.
|
|
4
4
|
|
|
5
5
|
## When to use
|
|
6
6
|
A page about one person or one record with a short form and a list of related things. For many fields, split them into cards like the settings kit.
|
|
@@ -84,7 +84,7 @@ const profile = (errors = false) => html`<div class="profile">
|
|
|
84
84
|
|
|
85
85
|
const meta: Meta = {
|
|
86
86
|
title: 'Patterns/Profile',
|
|
87
|
-
parameters: { layout: 'fullscreen', controls: { disable: true } },
|
|
87
|
+
parameters: { docs: { description: { component: 'Let people update their public profile and see which services are connected.' } }, layout: 'fullscreen', controls: { disable: true } },
|
|
88
88
|
render: () => profile(),
|
|
89
89
|
};
|
|
90
90
|
export default meta;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "profile",
|
|
3
3
|
"title": "Profile",
|
|
4
|
-
"summary": "
|
|
4
|
+
"summary": "Let people update their public profile and see which services are connected.",
|
|
5
5
|
"path": "src/patterns/profile",
|
|
6
6
|
"components": [
|
|
7
7
|
"avatar",
|
|
@@ -30,15 +30,15 @@
|
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
32
|
"path": "src/patterns/profile/Profile.stories.ts",
|
|
33
|
-
"hash": "
|
|
33
|
+
"hash": "de99237cdcfb4ddef8dd"
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"path": "src/patterns/profile/README.md",
|
|
37
|
-
"hash": "
|
|
37
|
+
"hash": "adccaa2829c56d7fa215"
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
"path": "src/patterns/profile/pattern.json",
|
|
41
|
-
"hash": "
|
|
41
|
+
"hash": "38a6ccd576aca5c96612"
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"path": "src/patterns/profile/profile.css",
|