banhaten 0.1.2 → 0.2.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/CHANGELOG.md +45 -0
- package/CONTRIBUTING.md +44 -0
- package/README.md +145 -328
- package/SECURITY.md +15 -0
- package/banhaten.config.example.json +1 -3
- package/docs/design-system/README.md +20 -0
- package/docs/design-system/adoption-quality-remediation.md +87 -0
- package/docs/design-system/agent-usage.md +13 -0
- package/docs/design-system/appearance-presets.md +189 -0
- package/docs/design-system/appearances/default.md +94 -0
- package/docs/design-system/appearances/rounded.md +95 -0
- package/docs/design-system/appearances/sharp.md +95 -0
- package/docs/design-system/component-docs-pattern.md +81 -0
- package/docs/design-system/component-showcase-consistency-report.md +217 -0
- package/docs/design-system/component-token-consistency-audit.md +173 -0
- package/docs/design-system/components/README.md +75 -0
- package/docs/design-system/components/accordion.md +67 -0
- package/docs/design-system/components/activity-feed.md +106 -0
- package/docs/design-system/components/alert-dialog.md +87 -0
- package/docs/design-system/components/alert.md +111 -0
- package/docs/design-system/components/aspect-ratio.md +59 -0
- package/docs/design-system/components/attribute.md +103 -0
- package/docs/design-system/components/autocomplete.md +93 -0
- package/docs/design-system/components/avatar.md +70 -0
- package/docs/design-system/components/badge.md +72 -0
- package/docs/design-system/components/banner.md +99 -0
- package/docs/design-system/components/breadcrumbs.md +188 -0
- package/docs/design-system/components/button-group.md +117 -0
- package/docs/design-system/components/button.md +95 -0
- package/docs/design-system/components/card.md +95 -0
- package/docs/design-system/components/carousel.md +61 -0
- package/docs/design-system/components/catalog-components.md +59 -0
- package/docs/design-system/components/chart.md +58 -0
- package/docs/design-system/components/checkbox.md +68 -0
- package/docs/design-system/components/collapsible.md +63 -0
- package/docs/design-system/components/command.md +75 -0
- package/docs/design-system/components/context-menu.md +59 -0
- package/docs/design-system/components/date-picker.md +97 -0
- package/docs/design-system/components/divider.md +117 -0
- package/docs/design-system/components/empty-state.md +72 -0
- package/docs/design-system/components/field.md +86 -0
- package/docs/design-system/components/file-upload.md +199 -0
- package/docs/design-system/components/hover-card.md +61 -0
- package/docs/design-system/components/icons.md +48 -0
- package/docs/design-system/components/input-group.md +73 -0
- package/docs/design-system/components/input-otp.md +73 -0
- package/docs/design-system/components/input.md +84 -0
- package/docs/design-system/components/item.md +72 -0
- package/docs/design-system/components/kbd.md +62 -0
- package/docs/design-system/components/label.md +64 -0
- package/docs/design-system/components/menu.md +76 -0
- package/docs/design-system/components/menubar.md +60 -0
- package/docs/design-system/components/modal.md +119 -0
- package/docs/design-system/components/native-select.md +70 -0
- package/docs/design-system/components/navigation-menu.md +63 -0
- package/docs/design-system/components/onboarding-step-list-item.md +94 -0
- package/docs/design-system/components/page-header.md +98 -0
- package/docs/design-system/components/pagination.md +71 -0
- package/docs/design-system/components/popover.md +77 -0
- package/docs/design-system/components/progress-slider.md +66 -0
- package/docs/design-system/components/progress.md +92 -0
- package/docs/design-system/components/radio-card.md +65 -0
- package/docs/design-system/components/radio-group.md +72 -0
- package/docs/design-system/components/resizable.md +57 -0
- package/docs/design-system/components/scroll-area.md +60 -0
- package/docs/design-system/components/segmented-control.md +71 -0
- package/docs/design-system/components/select.md +87 -0
- package/docs/design-system/components/sheet.md +82 -0
- package/docs/design-system/components/sidebar.md +83 -0
- package/docs/design-system/components/skeleton.md +91 -0
- package/docs/design-system/components/slideout.md +77 -0
- package/docs/design-system/components/slider.md +81 -0
- package/docs/design-system/components/social-button.md +65 -0
- package/docs/design-system/components/spinner.md +77 -0
- package/docs/design-system/components/steps.md +77 -0
- package/docs/design-system/components/table.md +411 -0
- package/docs/design-system/components/tabs.md +69 -0
- package/docs/design-system/components/tag.md +95 -0
- package/docs/design-system/components/textarea.md +64 -0
- package/docs/design-system/components/timeline.md +95 -0
- package/docs/design-system/components/toast.md +73 -0
- package/docs/design-system/components/toggle.md +96 -0
- package/docs/design-system/components/toolbar.md +105 -0
- package/docs/design-system/components/tooltip.md +107 -0
- package/docs/design-system/components/typography.md +18 -0
- package/docs/design-system/density-and-elevation.md +44 -0
- package/docs/design-system/design-system-test-missing-items.md +368 -0
- package/docs/design-system/direction-and-localization.md +23 -0
- package/docs/design-system/form-recipes.md +73 -0
- package/docs/design-system/gap-promotion-policy.md +21 -0
- package/docs/design-system/gap-promotion-report.md +166 -0
- package/docs/design-system/icons.md +69 -0
- package/docs/design-system/installation.md +68 -0
- package/docs/design-system/launch-comparison-shadcn.md +98 -0
- package/docs/design-system/registry-and-cli.md +64 -0
- package/docs/design-system/release-policy.md +30 -0
- package/docs/design-system/roadmap.md +14 -0
- package/docs/design-system/support-matrix.md +23 -0
- package/docs/design-system/tabs.md +53 -0
- package/docs/design-system/token-governance.md +60 -0
- package/package.json +97 -65
- package/registry/component-contract.json +40 -0
- package/registry/components/alert-dialog.tsx +297 -0
- package/registry/components/alert.tsx +86 -65
- package/registry/components/aspect-ratio.tsx +30 -0
- package/registry/components/autocomplete.tsx +23 -9
- package/registry/components/avatar.tsx +7 -7
- package/registry/components/badge.tsx +1 -1
- package/registry/components/button-group.tsx +321 -4
- package/registry/components/button.tsx +38 -17
- package/registry/components/card.tsx +68 -59
- package/registry/components/carousel.tsx +282 -0
- package/registry/components/chart.tsx +203 -0
- package/registry/components/checkbox.tsx +3 -3
- package/registry/components/collapsible.tsx +69 -0
- package/registry/components/command.tsx +174 -0
- package/registry/components/context-menu.tsx +236 -0
- package/registry/components/date-picker.tsx +246 -105
- package/registry/components/expanded/ActivityFeed.tsx +6 -15
- package/registry/components/expanded/Banner.tsx +3 -3
- package/registry/components/expanded/Breadcrumbs.tsx +5 -5
- package/registry/components/expanded/CatalogComponentsShowcase.tsx +13 -13
- package/registry/components/expanded/CatalogDivider.tsx +1 -1
- package/registry/components/expanded/EmptyState.tsx +1 -1
- package/registry/components/expanded/FileUpload.tsx +9 -2
- package/registry/components/expanded/OnboardingStepListItem.tsx +2 -4
- package/registry/components/expanded/PageHeader.tsx +14 -14
- package/registry/components/expanded/Slideout.tsx +15 -415
- package/registry/components/expanded/Steps.tsx +4 -4
- package/registry/components/expanded/Table.tsx +116 -69
- package/registry/components/expanded/Timeline.tsx +3 -3
- package/registry/components/expanded/activityFeed.css +1 -1
- package/registry/components/expanded/breadcrumbs.css +139 -139
- package/registry/components/expanded/catalogComponentsShowcase.css +83 -83
- package/registry/components/expanded/divider.css +1 -1
- package/registry/components/expanded/emptyState.css +1 -1
- package/registry/components/expanded/fileUpload.css +6 -6
- package/registry/components/expanded/slideout.css +9 -685
- package/registry/components/expanded/steps.css +274 -274
- package/registry/components/expanded/table.css +2 -2
- package/registry/components/expanded/timeline.css +264 -264
- package/registry/components/field.tsx +230 -0
- package/registry/components/hover-card.tsx +48 -0
- package/registry/components/input-content.ts +1 -0
- package/registry/components/input-group.tsx +130 -0
- package/registry/components/input-otp.tsx +13 -3
- package/registry/components/input.tsx +70 -45
- package/registry/components/item.tsx +189 -0
- package/registry/components/kbd.tsx +151 -0
- package/registry/components/label.tsx +78 -0
- package/registry/components/menu.tsx +34 -246
- package/registry/components/menubar.tsx +226 -0
- package/registry/components/modal.tsx +216 -143
- package/registry/components/native-select.tsx +205 -0
- package/registry/components/navigation-menu.tsx +171 -0
- package/registry/components/pagination.tsx +80 -58
- package/registry/components/popover.tsx +162 -664
- package/registry/components/radio-card.tsx +116 -87
- package/registry/components/radio-group.tsx +1 -1
- package/registry/components/resizable.tsx +74 -0
- package/registry/components/scroll-area.tsx +67 -0
- package/registry/components/segmented-control.tsx +87 -0
- package/registry/components/select-content.tsx +2 -2
- package/registry/components/select.tsx +54 -20
- package/registry/components/sheet.tsx +305 -0
- package/registry/components/sidebar.tsx +352 -0
- package/registry/components/skeleton.css +0 -3
- package/registry/components/social-button.tsx +116 -30
- package/registry/components/spinner.tsx +18 -55
- package/registry/components/{expanded/tabs.css → tabs.css} +127 -106
- package/registry/components/tabs.tsx +246 -0
- package/registry/components/tag.tsx +2 -2
- package/registry/components/textarea.tsx +4 -4
- package/registry/components/toast.tsx +136 -0
- package/registry/components/toggle.tsx +2 -2
- package/registry/components/toolbar.tsx +89 -17
- package/registry/components/tooltip.tsx +1 -1
- package/registry/examples/alert-demo.tsx +25 -5
- package/registry/examples/alert-dialog-demo.tsx +42 -0
- package/registry/examples/aspect-ratio-demo.tsx +11 -0
- package/registry/examples/attribute-demo.tsx +1 -1
- package/registry/examples/autocomplete-demo.tsx +3 -3
- package/registry/examples/avatar-demo.tsx +7 -7
- package/registry/examples/badge-demo.tsx +1 -1
- package/registry/examples/button-demo.tsx +6 -6
- package/registry/examples/button-group-demo.tsx +23 -2
- package/registry/examples/card-demo.tsx +46 -8
- package/registry/examples/carousel-demo.tsx +43 -0
- package/registry/examples/chart-demo.tsx +33 -0
- package/registry/examples/checkbox-demo.tsx +5 -5
- package/registry/examples/collapsible-demo.tsx +16 -0
- package/registry/examples/collection-filter-bar-demo.tsx +135 -0
- package/registry/examples/command-demo.tsx +42 -0
- package/registry/examples/{expanded/command-bar-demo.tsx → command-palette-demo.tsx} +5 -15
- package/registry/examples/context-menu-demo.tsx +29 -0
- package/registry/examples/control-density-contract-demo.tsx +61 -0
- package/registry/examples/date-picker-demo.tsx +12 -12
- package/registry/examples/divider-demo.tsx +3 -3
- package/registry/examples/expanded/banner-demo.tsx +1 -1
- package/registry/examples/expanded/breadcrumbs-demo.tsx +1 -1
- package/registry/examples/expanded/empty-state-demo.tsx +1 -1
- package/registry/examples/expanded/file-upload-demo.tsx +1 -1
- package/registry/examples/expanded/onboarding-step-demo.tsx +1 -1
- package/registry/examples/expanded/slideout-demo.tsx +2 -2
- package/registry/examples/expanded/steps-demo.tsx +1 -1
- package/registry/examples/expanded/tabs-demo.tsx +2 -2
- package/registry/examples/expanded/timeline-demo.tsx +1 -1
- package/registry/examples/field-demo.tsx +51 -0
- package/registry/examples/hover-card-demo.tsx +23 -0
- package/registry/examples/input-demo.tsx +6 -6
- package/registry/examples/input-group-demo.tsx +16 -0
- package/registry/examples/input-otp-demo.tsx +4 -4
- package/registry/examples/item-demo.tsx +46 -0
- package/registry/examples/kbd-demo.tsx +11 -0
- package/registry/examples/label-demo.tsx +20 -0
- package/registry/examples/menu-demo.tsx +1 -1
- package/registry/examples/menubar-demo.tsx +34 -0
- package/registry/examples/modal-demo.tsx +67 -9
- package/registry/examples/native-select-demo.tsx +16 -0
- package/registry/examples/navigation-menu-demo.tsx +29 -0
- package/registry/examples/pagination-demo.tsx +6 -3
- package/registry/examples/popover-demo.tsx +19 -19
- package/registry/examples/progress-demo.tsx +1 -1
- package/registry/examples/progress-slider-demo.tsx +1 -1
- package/registry/examples/radio-card-demo.tsx +4 -4
- package/registry/examples/radio-group-demo.tsx +2 -2
- package/registry/examples/resizable-demo.tsx +22 -0
- package/registry/examples/results-toolbar-demo.tsx +44 -0
- package/registry/examples/scroll-area-demo.tsx +15 -0
- package/registry/examples/segmented-control-demo.tsx +39 -0
- package/registry/examples/select-demo.tsx +1 -1
- package/registry/examples/sheet-demo.tsx +47 -0
- package/registry/examples/sidebar-demo.tsx +55 -0
- package/registry/examples/slider-demo.tsx +3 -3
- package/registry/examples/social-button-demo.tsx +18 -8
- package/registry/examples/spinner-demo.tsx +13 -13
- package/registry/examples/tabs-demo.tsx +13 -0
- package/registry/examples/tag-demo.tsx +1 -1
- package/registry/examples/textarea-demo.tsx +4 -4
- package/registry/examples/toast-demo.tsx +35 -0
- package/registry/examples/toggle-demo.tsx +6 -6
- package/registry/examples/tooltip-demo.tsx +4 -4
- package/registry/guidance/USAGE.md +27 -0
- package/registry/hooks/use-direction.ts +193 -13
- package/registry/index.json +6010 -432
- package/registry/styles/globals.css +3112 -4690
- package/registry.json +1582 -0
- package/schema/config.schema.json +51 -0
- package/schema/registry.schema.json +190 -0
- package/schema/tokens.schema.json +163 -0
- package/src/cli/command-line.js +194 -0
- package/src/cli/config-editors.js +9 -0
- package/src/cli/doctor.js +399 -0
- package/src/cli/file-transaction.js +295 -0
- package/src/cli/global-css.js +153 -0
- package/src/cli/index.js +639 -1391
- package/src/cli/install-plan.js +592 -0
- package/src/cli/install-receipt.js +171 -0
- package/src/cli/jsonc.js +203 -0
- package/src/cli/package-install-state.js +254 -0
- package/src/cli/package-manager.js +238 -0
- package/src/cli/package-plan.js +185 -0
- package/src/cli/package-version.js +97 -0
- package/src/cli/registry-query.js +207 -0
- package/src/cli/reporting.js +55 -0
- package/src/cli/schema-validation.js +19 -0
- package/src/cli/source-scanner.js +686 -0
- package/src/cli/vite-config.js +478 -0
- package/tokens/banhaten.tokens.json +4313 -310
- package/registry/assets/avatars/avatar-02.jpg +0 -0
- package/registry/assets/avatars/avatar-03.jpg +0 -0
- package/registry/assets/avatars/avatar-04.jpg +0 -0
- package/registry/assets/avatars/avatar-05.jpg +0 -0
- package/registry/assets/avatars/avatar-06.jpg +0 -0
- package/registry/assets/avatars/avatar-07.jpg +0 -0
- package/registry/assets/avatars/avatar-08.jpg +0 -0
- package/registry/assets/avatars/avatar-09.jpg +0 -0
- package/registry/assets/avatars/avatar-10.jpg +0 -0
- package/registry/assets/avatars/avatar-11.jpg +0 -0
- package/registry/assets/avatars/avatar-12.jpg +0 -0
- package/registry/assets/avatars/avatar-13.jpg +0 -0
- package/registry/assets/avatars/avatar-14.jpg +0 -0
- package/registry/assets/avatars/avatar-15.jpg +0 -0
- package/registry/assets/avatars/avatar-16.jpg +0 -0
- package/registry/assets/avatars/avatar-17.jpg +0 -0
- package/registry/assets/avatars/avatar-18.jpg +0 -0
- package/registry/assets/avatars/avatar-19.jpg +0 -0
- package/registry/assets/avatars/avatar-20.jpg +0 -0
- package/registry/assets/avatars/avatar-21.jpg +0 -0
- package/registry/assets/avatars/avatar-22.jpg +0 -0
- package/registry/assets/avatars/avatar-23.jpg +0 -0
- package/registry/assets/avatars/avatar-24.jpg +0 -0
- package/registry/assets/avatars/avatar-25.jpg +0 -0
- package/registry/assets/avatars/avatar-26.jpg +0 -0
- package/registry/assets/avatars/avatar-27.jpg +0 -0
- package/registry/assets/avatars/avatar-28.jpg +0 -0
- package/registry/assets/avatars/avatar-29.jpg +0 -0
- package/registry/assets/avatars/avatar-30.jpg +0 -0
- package/registry/assets/avatars/avatar-31.jpg +0 -0
- package/registry/assets/avatars/avatar-32.jpg +0 -0
- package/registry/assets/avatars/avatar-33.jpg +0 -0
- package/registry/assets/avatars/avatar-34.jpg +0 -0
- package/registry/assets/avatars/avatar-35.jpg +0 -0
- package/registry/assets/image-assets.json +0 -744
- package/registry/assets/images/art-02.jpg +0 -0
- package/registry/assets/images/art-03.jpg +0 -0
- package/registry/assets/images/art-04.jpg +0 -0
- package/registry/assets/images/art-05.jpg +0 -0
- package/registry/assets/images/art-06.jpg +0 -0
- package/registry/assets/images/art-07.jpg +0 -0
- package/registry/assets/images/art-08.jpg +0 -0
- package/registry/assets/images/art-09.jpg +0 -0
- package/registry/assets/images/art-10.jpg +0 -0
- package/registry/assets/images/art-11.jpg +0 -0
- package/registry/assets/images/art-12.jpg +0 -0
- package/registry/assets/images/art-13.jpg +0 -0
- package/registry/assets/images/art-14.jpg +0 -0
- package/registry/assets/images/art-15.jpg +0 -0
- package/registry/assets/images/art-16.jpg +0 -0
- package/registry/assets/images/art-17.jpg +0 -0
- package/registry/assets/images/art-18.jpg +0 -0
- package/registry/assets/images/art-19.jpg +0 -0
- package/registry/assets/images/art-20.jpg +0 -0
- package/registry/assets/images/art-21.jpg +0 -0
- package/registry/assets/images/art-22.jpg +0 -0
- package/registry/assets/images/art-23.jpg +0 -0
- package/registry/assets/images/art-24.jpg +0 -0
- package/registry/assets/images/art-25.jpg +0 -0
- package/registry/assets/images/art-26.jpg +0 -0
- package/registry/assets/images/art-27.jpg +0 -0
- package/registry/assets/images/nature-01.jpg +0 -0
- package/registry/assets/images/nature-02.jpg +0 -0
- package/registry/assets/images/nature-03.jpg +0 -0
- package/registry/assets/images/nature-04.jpg +0 -0
- package/registry/assets/images/nature-05.jpg +0 -0
- package/registry/assets/images/nature-06.jpg +0 -0
- package/registry/assets/images/nature-07.jpg +0 -0
- package/registry/assets/images/nature-08.jpg +0 -0
- package/registry/assets/images/nature-09.jpg +0 -0
- package/registry/assets/images/nature-10.jpg +0 -0
- package/registry/assets/images/nature-11.jpg +0 -0
- package/registry/assets/images/nature-12.jpg +0 -0
- package/registry/assets/images/nature-13.jpg +0 -0
- package/registry/assets/images/nature-14.jpg +0 -0
- package/registry/assets/images/nature-15.jpg +0 -0
- package/registry/assets/images/nature-16.jpg +0 -0
- package/registry/assets/images/nature-17.jpg +0 -0
- package/registry/assets/images/nature-18.jpg +0 -0
- package/registry/assets/images/nature-19.jpg +0 -0
- package/registry/assets/images/nature-20.jpg +0 -0
- package/registry/components/expanded/BannerBoard.tsx +0 -225
- package/registry/components/expanded/CatalogTag.tsx +0 -85
- package/registry/components/expanded/CommandBar.tsx +0 -386
- package/registry/components/expanded/IconExplorer.tsx +0 -612
- package/registry/components/expanded/Tabs.tsx +0 -86
- package/registry/components/expanded/TimelineShowcase.tsx +0 -158
- package/registry/components/expanded/commandBar.css +0 -470
- package/registry/components/expanded/iconExplorer.css +0 -764
- package/registry/components/expanded/iconPacks.ts +0 -866
- package/registry/components/expanded/tag.css +0 -148
- package/registry/examples/expanded/icons-demo.tsx +0 -5
- package/tokens/Color mode.zip +0 -0
- package/tokens/Numbers.zip +0 -0
- package/tokens/Radius.zip +0 -0
- package/tokens/Theme.zip +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Banhaten Design System Docs
|
|
2
|
+
|
|
3
|
+
Use these docs with the live playground.
|
|
4
|
+
|
|
5
|
+
- [Registry and CLI](./registry-and-cli.md): registry formats, generated-file ownership, CLI commands, and schema behavior.
|
|
6
|
+
- [Installation](./installation.md): Vite, Next.js/framework-neutral setup, fonts, direction, and safe updates.
|
|
7
|
+
- [Token Governance](./token-governance.md): token-only component rules, exception ledger, and public override surface.
|
|
8
|
+
- [Appearance Presets](./appearance-presets.md): theme and radius mode guidance.
|
|
9
|
+
- [Direction and Localization](./direction-and-localization.md): inherited LTR/RTL and product localization responsibilities.
|
|
10
|
+
- [Form Recipes](./form-recipes.md): accessible Field composition, validation, selection, dates, and RTL.
|
|
11
|
+
- [Density and Elevation](./density-and-elevation.md): supported size contracts and semantic shadow layers.
|
|
12
|
+
- [Support Matrix](./support-matrix.md): framework, runtime, browser, font, and package-manager baseline.
|
|
13
|
+
- [Release Policy](./release-policy.md): stability tiers, versioning, deprecation, and launch gates.
|
|
14
|
+
- [Roadmap](./roadmap.md): explicitly deferred product-specific components and promotion gates.
|
|
15
|
+
- [Launch Comparison](./launch-comparison-shadcn.md): the complete shadcn/ui benchmark, remediation register, and deliberate differences.
|
|
16
|
+
- [Component Docs Pattern](./component-docs-pattern.md): the Base / Anatomy / Alternatives shape every playground component page follows.
|
|
17
|
+
- [Components](./components/README.md): component markdown catalog.
|
|
18
|
+
- [Icon System](./icons.md): icon guidance and explorer notes.
|
|
19
|
+
|
|
20
|
+
The playground remains the primary documentation surface because it renders live registry-backed previews, source snippets, copyable code panels, API tables, file links, and RTL behavior.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Adoption Quality Remediation
|
|
2
|
+
|
|
3
|
+
This checklist turns the Field Index audit into an implementation program. The
|
|
4
|
+
work is ordered so application recipes depend on stable component contracts,
|
|
5
|
+
and enforcement depends on documented recipes.
|
|
6
|
+
|
|
7
|
+
## 1. Shared control density
|
|
8
|
+
|
|
9
|
+
- [x] Add the semantic densities `compact` (32px), `default` (36px), and
|
|
10
|
+
`comfortable` (40px) to Input, Select, Date Picker, Button, Button Group,
|
|
11
|
+
Segmented Control, and Toolbar controls.
|
|
12
|
+
- [x] Keep existing component-specific `size` props as compatibility aliases.
|
|
13
|
+
- [x] Add a cross-component conformance example and automated height checks.
|
|
14
|
+
- [x] Document the semantic density matrix and precedence rules.
|
|
15
|
+
|
|
16
|
+
Acceptance: controls using the same `density` render at the same physical
|
|
17
|
+
height, regardless of their legacy size names.
|
|
18
|
+
|
|
19
|
+
## 2. Truthful machine-readable defaults
|
|
20
|
+
|
|
21
|
+
- [x] Add explicit capability defaults to the registry schema.
|
|
22
|
+
- [x] Stop inferring defaults from the first capability value.
|
|
23
|
+
- [x] Record explicit defaults for the control family.
|
|
24
|
+
- [x] Validate that every recorded default belongs to its capability list.
|
|
25
|
+
|
|
26
|
+
Acceptance: generated API documentation agrees with runtime defaults.
|
|
27
|
+
|
|
28
|
+
## 3. Input icon and shortcut contracts
|
|
29
|
+
|
|
30
|
+
- [x] Replace ambiguous icon booleans with explicit `showAtSign` and `showInfo`
|
|
31
|
+
props while retaining deprecated aliases.
|
|
32
|
+
- [x] Add a reusable keyboard-shortcut composition to Kbd.
|
|
33
|
+
- [x] Make Input and Toolbar Search use the shared shortcut composition.
|
|
34
|
+
- [x] Document search fields and date fields without implicit icons.
|
|
35
|
+
|
|
36
|
+
Acceptance: a generic leading-icon request can no longer accidentally produce
|
|
37
|
+
an at-sign in new code, and shortcuts use consistent keycaps.
|
|
38
|
+
|
|
39
|
+
## 4. Segmented selection and application recipes
|
|
40
|
+
|
|
41
|
+
- [x] Add a content-width Segmented Control with an optional non-interactive
|
|
42
|
+
label segment.
|
|
43
|
+
- [x] Add a canonical Collection Filter Bar recipe.
|
|
44
|
+
- [x] Add a canonical Results Toolbar recipe with cards-per-row selection.
|
|
45
|
+
- [x] Cover responsive, LTR, and RTL compositions.
|
|
46
|
+
|
|
47
|
+
Acceptance: the controls visible in the Field Index screenshot can be composed
|
|
48
|
+
without raw heights, padding, radii, or bespoke segmented buttons.
|
|
49
|
+
|
|
50
|
+
## 5. Agent and consumer adoption contract
|
|
51
|
+
|
|
52
|
+
- [x] Install `.banhaten/USAGE.md` during `banhaten init`.
|
|
53
|
+
- [x] Add machine-readable recommendation and avoidance guidance to relevant
|
|
54
|
+
registry entries.
|
|
55
|
+
- [x] Add a read-only `banhaten doctor` command for version, drift, raw control
|
|
56
|
+
geometry, ambiguous icon props, and native-control diagnostics.
|
|
57
|
+
- [x] Test text and JSON doctor output.
|
|
58
|
+
|
|
59
|
+
Acceptance: an agent receives actionable rules before composing a page, and a
|
|
60
|
+
consumer can detect the most common forms of design-system drift.
|
|
61
|
+
|
|
62
|
+
## 6. Documentation reliability
|
|
63
|
+
|
|
64
|
+
- [x] Replace fixed multi-column component grids with container-safe layouts.
|
|
65
|
+
- [x] Make documentation section anchors compatible with the hash router.
|
|
66
|
+
- [x] Stabilize calendar tests by controlling the displayed month.
|
|
67
|
+
- [x] Add navigation and overflow regression tests.
|
|
68
|
+
|
|
69
|
+
Acceptance: documentation examples do not overlap and section links preserve
|
|
70
|
+
the active component page.
|
|
71
|
+
|
|
72
|
+
## 7. Visual and governance gates
|
|
73
|
+
|
|
74
|
+
- [x] Add visual baselines for the control family and the two golden recipes.
|
|
75
|
+
- [x] Add critical control-text contrast checks rather than relying only on the
|
|
76
|
+
frozen global contrast debt.
|
|
77
|
+
- [x] Generate a recurring-gap promotion report from background scenarios.
|
|
78
|
+
- [x] Document the promotion rule for gaps that recur in three or more
|
|
79
|
+
backgrounds.
|
|
80
|
+
|
|
81
|
+
Acceptance: component-family drift fails CI, critical controls have explicit
|
|
82
|
+
contrast protection, and recurring application gaps become owned system work.
|
|
83
|
+
|
|
84
|
+
## Validation
|
|
85
|
+
|
|
86
|
+
- [x] Registry, token, documentation, CLI, component, and browser checks pass.
|
|
87
|
+
- [x] The repository remains free of generated-artifact drift.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Agent usage
|
|
2
|
+
|
|
3
|
+
`banhaten init` installs `.banhaten/USAGE.md` into every consumer project. Include that file in coding-agent context so generated and redesigned screens use registry defaults and recipes instead of reconstructing the visual language from memory.
|
|
4
|
+
|
|
5
|
+
The workflow is intentionally inspectable:
|
|
6
|
+
|
|
7
|
+
1. `banhaten search <need>` discovers the intended primitive.
|
|
8
|
+
2. `banhaten docs <component>` returns explicit defaults, fit guidance, avoid rules, and recipes.
|
|
9
|
+
3. `banhaten view <component>` exposes the installed source contract.
|
|
10
|
+
4. `banhaten doctor` reports installed-version drift, local managed-file drift, deprecated ambiguous props, raw geometry overrides, native date/select controls, and missing guidance.
|
|
11
|
+
5. `banhaten diff` previews registry updates without writing.
|
|
12
|
+
|
|
13
|
+
For collection screens, start with the filter-bar and results-toolbar recipes in [Form Recipes](./form-recipes.md). For mixed control rows, follow [Density and Elevation](./density-and-elevation.md).
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
# Appearance Presets
|
|
2
|
+
|
|
3
|
+
Appearance presets change the feel of the design system without changing component APIs.
|
|
4
|
+
|
|
5
|
+
Components keep semantic variants such as `primary`, `secondary`, `subtle`, `danger`, and `ghost`. Presets decide how those meanings look through design tokens: color, radius, density, border, and elevation.
|
|
6
|
+
|
|
7
|
+
## Presets
|
|
8
|
+
|
|
9
|
+
- `default`: The baseline product UI. Gray application background, white cards, modest radius, conservative spacing.
|
|
10
|
+
- `rounded`: A softer UI. White application background, stronger radius, relaxed spacing, gentler separation.
|
|
11
|
+
- `sharp`: A precise UI. Square edges, tighter spacing, clearer borders, minimal elevation.
|
|
12
|
+
|
|
13
|
+
Each preset has its own markdown file:
|
|
14
|
+
|
|
15
|
+
- [Default](./appearances/default.md)
|
|
16
|
+
- [Rounded](./appearances/rounded.md)
|
|
17
|
+
- [Sharp](./appearances/sharp.md)
|
|
18
|
+
|
|
19
|
+
Component specs:
|
|
20
|
+
|
|
21
|
+
- [Icons](./icons.md)
|
|
22
|
+
- [Tabs](./tabs.md)
|
|
23
|
+
- [Tag](./components/tag.md)
|
|
24
|
+
- [Timeline](./components/timeline.md)
|
|
25
|
+
|
|
26
|
+
Component guidance lives in:
|
|
27
|
+
|
|
28
|
+
- [Components](./components/README.md)
|
|
29
|
+
- [Banner](./components/banner.md)
|
|
30
|
+
- [Breadcrumbs](./components/breadcrumbs.md)
|
|
31
|
+
- [Divider](./components/divider.md)
|
|
32
|
+
- [File Upload](./components/file-upload.md)
|
|
33
|
+
- [Tag](./components/tag.md)
|
|
34
|
+
- [Timeline](./components/timeline.md)
|
|
35
|
+
|
|
36
|
+
## Token Contract
|
|
37
|
+
|
|
38
|
+
The design system should use semantic tokens instead of importing naming patterns from a framework. Tokens describe where they are used, not how they happen to look in one theme.
|
|
39
|
+
|
|
40
|
+
### Content
|
|
41
|
+
|
|
42
|
+
`content` tokens apply to text and icons.
|
|
43
|
+
|
|
44
|
+
- `content.default`
|
|
45
|
+
- `content.primary`
|
|
46
|
+
- `content.subtle`
|
|
47
|
+
- `content.muted`
|
|
48
|
+
- `content.disabled`
|
|
49
|
+
- `content.inverse`
|
|
50
|
+
- `content.link`
|
|
51
|
+
- `content.linkHover`
|
|
52
|
+
- `content.onColor`
|
|
53
|
+
- `content.onLight`
|
|
54
|
+
- `content.onBrand`
|
|
55
|
+
- `content.success`
|
|
56
|
+
- `content.warning`
|
|
57
|
+
- `content.danger`
|
|
58
|
+
|
|
59
|
+
### Background
|
|
60
|
+
|
|
61
|
+
`background` tokens apply to page, layout, component, and interactive fills.
|
|
62
|
+
|
|
63
|
+
- `background.app`
|
|
64
|
+
- `background.default`
|
|
65
|
+
- `background.card`
|
|
66
|
+
- `background.subtle`
|
|
67
|
+
- `background.muted`
|
|
68
|
+
- `background.disabled`
|
|
69
|
+
- `background.inverse`
|
|
70
|
+
- `background.overlay`
|
|
71
|
+
- `background.brand`
|
|
72
|
+
- `background.brandHover`
|
|
73
|
+
- `background.brandPressed`
|
|
74
|
+
- `background.selected`
|
|
75
|
+
- `background.hover`
|
|
76
|
+
- `background.pressed`
|
|
77
|
+
- `background.success`
|
|
78
|
+
- `background.warning`
|
|
79
|
+
- `background.danger`
|
|
80
|
+
|
|
81
|
+
### Border
|
|
82
|
+
|
|
83
|
+
`border` tokens apply to component outlines, dividers, focus states, and validation states.
|
|
84
|
+
|
|
85
|
+
- `border.default`
|
|
86
|
+
- `border.subtle`
|
|
87
|
+
- `border.strong`
|
|
88
|
+
- `border.disabled`
|
|
89
|
+
- `border.focus`
|
|
90
|
+
- `border.brand`
|
|
91
|
+
- `border.success`
|
|
92
|
+
- `border.warning`
|
|
93
|
+
- `border.danger`
|
|
94
|
+
|
|
95
|
+
### Shape
|
|
96
|
+
|
|
97
|
+
`shape` tokens control radius by usage, not component name.
|
|
98
|
+
|
|
99
|
+
- `shape.action`
|
|
100
|
+
- `shape.control`
|
|
101
|
+
- `shape.card`
|
|
102
|
+
- `shape.panel`
|
|
103
|
+
- `shape.modal`
|
|
104
|
+
- `shape.popover`
|
|
105
|
+
- `shape.badge`
|
|
106
|
+
- `shape.avatar`
|
|
107
|
+
|
|
108
|
+
### Density
|
|
109
|
+
|
|
110
|
+
`density` tokens control repeated spacing and sizing decisions.
|
|
111
|
+
|
|
112
|
+
- `density.controlHeight`
|
|
113
|
+
- `density.controlPaddingX`
|
|
114
|
+
- `density.cardPadding`
|
|
115
|
+
- `density.panelPadding`
|
|
116
|
+
- `density.sectionGap`
|
|
117
|
+
- `density.listRowHeight`
|
|
118
|
+
- `density.tableRowHeight`
|
|
119
|
+
|
|
120
|
+
### Elevation
|
|
121
|
+
|
|
122
|
+
`elevation` tokens control shadows and stacking treatment.
|
|
123
|
+
|
|
124
|
+
- `elevation.card`
|
|
125
|
+
- `elevation.panel`
|
|
126
|
+
- `elevation.popover`
|
|
127
|
+
- `elevation.modal`
|
|
128
|
+
- `elevation.none`
|
|
129
|
+
|
|
130
|
+
## Component Rule
|
|
131
|
+
|
|
132
|
+
Components consume semantic tokens and component-scoped aliases. They must not hard-code preset-specific values or Figma fallback literals in component source.
|
|
133
|
+
|
|
134
|
+
If a Figma reference exposes a literal color, size, radius, shadow, or opacity,
|
|
135
|
+
promote it into the appropriate owned fragment under `tokens/source/`, then
|
|
136
|
+
consume that token from the component. Reserve `tokens/banhaten.utilities.css`
|
|
137
|
+
for authored global CSS that cannot be represented as token data. Component
|
|
138
|
+
docs may record Figma references for audit and QA, but those literals are not
|
|
139
|
+
implementation fallbacks.
|
|
140
|
+
|
|
141
|
+
Good:
|
|
142
|
+
|
|
143
|
+
```tsx
|
|
144
|
+
<Button variant="primary" />
|
|
145
|
+
<Card />
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Avoid:
|
|
149
|
+
|
|
150
|
+
```tsx
|
|
151
|
+
<Button rounded />
|
|
152
|
+
<Card sharp />
|
|
153
|
+
<Card className="rounded-[16px]" />
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
The preset is selected at the design-system root:
|
|
157
|
+
|
|
158
|
+
```tsx
|
|
159
|
+
<DesignSystemProvider appearance="default">
|
|
160
|
+
<App />
|
|
161
|
+
</DesignSystemProvider>
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
or through a root attribute:
|
|
165
|
+
|
|
166
|
+
```html
|
|
167
|
+
<body data-appearance="default">
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## Preset Responsibilities
|
|
171
|
+
|
|
172
|
+
An appearance preset may change:
|
|
173
|
+
|
|
174
|
+
- Page and layout background treatment
|
|
175
|
+
- Card and panel background treatment
|
|
176
|
+
- Radius for actions, controls, cards, modals, popovers, badges, and tabs
|
|
177
|
+
- Component density and padding
|
|
178
|
+
- Border prominence
|
|
179
|
+
- Elevation and shadow strength
|
|
180
|
+
- Hover, pressed, selected, and disabled treatment
|
|
181
|
+
|
|
182
|
+
An appearance preset should not change:
|
|
183
|
+
|
|
184
|
+
- Component behavior
|
|
185
|
+
- Component variant names
|
|
186
|
+
- Accessibility requirements
|
|
187
|
+
- Interaction contracts
|
|
188
|
+
- Information hierarchy
|
|
189
|
+
- Meaning of semantic color roles
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# Default Appearance
|
|
2
|
+
|
|
3
|
+
`default` is the baseline product appearance.
|
|
4
|
+
|
|
5
|
+
It should feel practical, calm, and balanced: a gray application background, white cards, modest radius, restrained elevation, and conservative spacing.
|
|
6
|
+
|
|
7
|
+
## Visual Character
|
|
8
|
+
|
|
9
|
+
- Application background is gray or off-white.
|
|
10
|
+
- Cards and primary content areas are white.
|
|
11
|
+
- Actions and controls have a modest radius.
|
|
12
|
+
- Spacing is comfortable but compact enough for daily product use.
|
|
13
|
+
- Shadows are subtle and used only to separate floating or raised elements.
|
|
14
|
+
|
|
15
|
+
## Token Direction
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
export const defaultAppearance = {
|
|
19
|
+
content: {
|
|
20
|
+
default: "#171717",
|
|
21
|
+
primary: "#000000",
|
|
22
|
+
subtle: "#404040",
|
|
23
|
+
muted: "#737373",
|
|
24
|
+
disabled: "#a3a3a3",
|
|
25
|
+
inverse: "#ffffff",
|
|
26
|
+
link: "#1d4ed8",
|
|
27
|
+
linkHover: "#1e40af",
|
|
28
|
+
onColor: "#ffffff",
|
|
29
|
+
onLight: "#171717",
|
|
30
|
+
onBrand: "#ffffff",
|
|
31
|
+
},
|
|
32
|
+
background: {
|
|
33
|
+
app: "#f4f4f5",
|
|
34
|
+
default: "#ffffff",
|
|
35
|
+
card: "#ffffff",
|
|
36
|
+
subtle: "#fafafa",
|
|
37
|
+
muted: "#f5f5f5",
|
|
38
|
+
disabled: "#e5e5e5",
|
|
39
|
+
inverse: "#171717",
|
|
40
|
+
overlay: "rgba(23, 23, 23, 0.48)",
|
|
41
|
+
brand: "#171717",
|
|
42
|
+
brandHover: "#262626",
|
|
43
|
+
brandPressed: "#0a0a0a",
|
|
44
|
+
selected: "#e5e7eb",
|
|
45
|
+
hover: "#f5f5f5",
|
|
46
|
+
pressed: "#e5e5e5",
|
|
47
|
+
},
|
|
48
|
+
border: {
|
|
49
|
+
default: "#d4d4d4",
|
|
50
|
+
subtle: "#e5e5e5",
|
|
51
|
+
strong: "#a3a3a3",
|
|
52
|
+
disabled: "#e5e5e5",
|
|
53
|
+
focus: "#2563eb",
|
|
54
|
+
brand: "#171717",
|
|
55
|
+
},
|
|
56
|
+
shape: {
|
|
57
|
+
action: "10px",
|
|
58
|
+
control: "10px",
|
|
59
|
+
card: "12px",
|
|
60
|
+
panel: "12px",
|
|
61
|
+
modal: "16px",
|
|
62
|
+
popover: "12px",
|
|
63
|
+
badge: "999px",
|
|
64
|
+
avatar: "999px",
|
|
65
|
+
},
|
|
66
|
+
density: {
|
|
67
|
+
controlHeight: "40px",
|
|
68
|
+
controlPaddingX: "14px",
|
|
69
|
+
cardPadding: "20px",
|
|
70
|
+
panelPadding: "20px",
|
|
71
|
+
sectionGap: "24px",
|
|
72
|
+
listRowHeight: "44px",
|
|
73
|
+
tableRowHeight: "44px",
|
|
74
|
+
},
|
|
75
|
+
elevation: {
|
|
76
|
+
card: "0 1px 2px rgba(0, 0, 0, 0.04)",
|
|
77
|
+
panel: "0 1px 3px rgba(0, 0, 0, 0.06)",
|
|
78
|
+
popover: "0 12px 28px rgba(0, 0, 0, 0.14)",
|
|
79
|
+
modal: "0 24px 64px rgba(0, 0, 0, 0.20)",
|
|
80
|
+
none: "none",
|
|
81
|
+
},
|
|
82
|
+
};
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Component Impact
|
|
86
|
+
|
|
87
|
+
- Buttons: modest radius, dark primary action, balanced padding.
|
|
88
|
+
- Breadcrumbs: inline trails stay quiet; raised trails use `background.card`, `border.subtle`, and the modest control radius.
|
|
89
|
+
- Inputs: modest radius, visible but quiet border.
|
|
90
|
+
- Cards: white on gray app background, subtle border or shadow.
|
|
91
|
+
- Dividers: quiet 1px separators using `border.subtle`, with compact spacing around labels or inline actions.
|
|
92
|
+
- File uploads: subtle dashed drop zones with white queued rows, modest radius, and quiet row elevation.
|
|
93
|
+
- Modals and popovers: slightly more radius than inline components.
|
|
94
|
+
- Tables and lists: normal row height for readable operational screens.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Rounded Appearance
|
|
2
|
+
|
|
3
|
+
`rounded` is the softer appearance.
|
|
4
|
+
|
|
5
|
+
It should feel open, approachable, and more polished: a white application background, larger radii, softer borders, relaxed spacing, and less visual heaviness.
|
|
6
|
+
|
|
7
|
+
## Visual Character
|
|
8
|
+
|
|
9
|
+
- Application background is white.
|
|
10
|
+
- Cards use white or near-white backgrounds with light borders.
|
|
11
|
+
- Primary actions can be pill-shaped.
|
|
12
|
+
- Panels and cards have visibly larger radius.
|
|
13
|
+
- Spacing is a little more relaxed than `default`.
|
|
14
|
+
- Shadows are soft and optional.
|
|
15
|
+
|
|
16
|
+
## Token Direction
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
export const roundedAppearance = {
|
|
20
|
+
content: {
|
|
21
|
+
default: "#18181b",
|
|
22
|
+
primary: "#09090b",
|
|
23
|
+
subtle: "#52525b",
|
|
24
|
+
muted: "#71717a",
|
|
25
|
+
disabled: "#a1a1aa",
|
|
26
|
+
inverse: "#ffffff",
|
|
27
|
+
link: "#0f766e",
|
|
28
|
+
linkHover: "#115e59",
|
|
29
|
+
onColor: "#ffffff",
|
|
30
|
+
onLight: "#18181b",
|
|
31
|
+
onBrand: "#ffffff",
|
|
32
|
+
},
|
|
33
|
+
background: {
|
|
34
|
+
app: "#ffffff",
|
|
35
|
+
default: "#ffffff",
|
|
36
|
+
card: "#ffffff",
|
|
37
|
+
subtle: "#fafafa",
|
|
38
|
+
muted: "#f6f7f7",
|
|
39
|
+
disabled: "#e4e4e7",
|
|
40
|
+
inverse: "#18181b",
|
|
41
|
+
overlay: "rgba(24, 24, 27, 0.42)",
|
|
42
|
+
brand: "#0f766e",
|
|
43
|
+
brandHover: "#115e59",
|
|
44
|
+
brandPressed: "#134e4a",
|
|
45
|
+
selected: "#ccfbf1",
|
|
46
|
+
hover: "#f4f7f6",
|
|
47
|
+
pressed: "#e7f3f0",
|
|
48
|
+
},
|
|
49
|
+
border: {
|
|
50
|
+
default: "#dedede",
|
|
51
|
+
subtle: "#eeeeee",
|
|
52
|
+
strong: "#b8b8b8",
|
|
53
|
+
disabled: "#e4e4e7",
|
|
54
|
+
focus: "#0f766e",
|
|
55
|
+
brand: "#0f766e",
|
|
56
|
+
},
|
|
57
|
+
shape: {
|
|
58
|
+
action: "999px",
|
|
59
|
+
control: "16px",
|
|
60
|
+
card: "22px",
|
|
61
|
+
panel: "24px",
|
|
62
|
+
modal: "28px",
|
|
63
|
+
popover: "20px",
|
|
64
|
+
badge: "999px",
|
|
65
|
+
avatar: "999px",
|
|
66
|
+
},
|
|
67
|
+
density: {
|
|
68
|
+
controlHeight: "44px",
|
|
69
|
+
controlPaddingX: "18px",
|
|
70
|
+
cardPadding: "24px",
|
|
71
|
+
panelPadding: "24px",
|
|
72
|
+
sectionGap: "32px",
|
|
73
|
+
listRowHeight: "48px",
|
|
74
|
+
tableRowHeight: "48px",
|
|
75
|
+
},
|
|
76
|
+
elevation: {
|
|
77
|
+
card: "0 8px 24px rgba(15, 23, 42, 0.06)",
|
|
78
|
+
panel: "0 10px 32px rgba(15, 23, 42, 0.08)",
|
|
79
|
+
popover: "0 18px 40px rgba(15, 23, 42, 0.16)",
|
|
80
|
+
modal: "0 28px 72px rgba(15, 23, 42, 0.22)",
|
|
81
|
+
none: "none",
|
|
82
|
+
},
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Component Impact
|
|
87
|
+
|
|
88
|
+
- Buttons: pill-like primary and action buttons.
|
|
89
|
+
- Breadcrumbs: raised trails inherit the softer control radius and can use slightly more relaxed spacing.
|
|
90
|
+
- Inputs: rounded controls with slightly taller height.
|
|
91
|
+
- Cards: larger radius with light borders and soft separation.
|
|
92
|
+
- Dividers: quiet 1px separators using `border.subtle`, with softer action backgrounds and the preset control radius.
|
|
93
|
+
- File uploads: softer drop zones and queued rows, relaxed padding, and gentle borders.
|
|
94
|
+
- Modals and popovers: rounded, friendly containers.
|
|
95
|
+
- Tables and lists: slightly more vertical breathing room.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Sharp Appearance
|
|
2
|
+
|
|
3
|
+
`sharp` is the precise appearance.
|
|
4
|
+
|
|
5
|
+
It should feel structured, architectural, and efficient: square edges, tighter spacing, stronger borders, flatter surfaces, and minimal elevation.
|
|
6
|
+
|
|
7
|
+
## Visual Character
|
|
8
|
+
|
|
9
|
+
- Application background can be white or a very light gray.
|
|
10
|
+
- Cards are flat panels with clear borders.
|
|
11
|
+
- Radius is zero or nearly zero across most UI.
|
|
12
|
+
- Spacing is tighter than `default`.
|
|
13
|
+
- Borders carry most of the separation work.
|
|
14
|
+
- Shadows are reserved for overlays only.
|
|
15
|
+
|
|
16
|
+
## Token Direction
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
export const sharpAppearance = {
|
|
20
|
+
content: {
|
|
21
|
+
default: "#111111",
|
|
22
|
+
primary: "#000000",
|
|
23
|
+
subtle: "#3f3f46",
|
|
24
|
+
muted: "#6b7280",
|
|
25
|
+
disabled: "#9ca3af",
|
|
26
|
+
inverse: "#ffffff",
|
|
27
|
+
link: "#7c2d12",
|
|
28
|
+
linkHover: "#431407",
|
|
29
|
+
onColor: "#ffffff",
|
|
30
|
+
onLight: "#111111",
|
|
31
|
+
onBrand: "#ffffff",
|
|
32
|
+
},
|
|
33
|
+
background: {
|
|
34
|
+
app: "#f7f7f7",
|
|
35
|
+
default: "#ffffff",
|
|
36
|
+
card: "#ffffff",
|
|
37
|
+
subtle: "#f9fafb",
|
|
38
|
+
muted: "#f3f4f6",
|
|
39
|
+
disabled: "#e5e7eb",
|
|
40
|
+
inverse: "#111111",
|
|
41
|
+
overlay: "rgba(17, 17, 17, 0.52)",
|
|
42
|
+
brand: "#111111",
|
|
43
|
+
brandHover: "#262626",
|
|
44
|
+
brandPressed: "#000000",
|
|
45
|
+
selected: "#e5e7eb",
|
|
46
|
+
hover: "#f3f4f6",
|
|
47
|
+
pressed: "#e5e7eb",
|
|
48
|
+
},
|
|
49
|
+
border: {
|
|
50
|
+
default: "#c7c7c7",
|
|
51
|
+
subtle: "#dedede",
|
|
52
|
+
strong: "#737373",
|
|
53
|
+
disabled: "#dedede",
|
|
54
|
+
focus: "#111111",
|
|
55
|
+
brand: "#111111",
|
|
56
|
+
},
|
|
57
|
+
shape: {
|
|
58
|
+
action: "0px",
|
|
59
|
+
control: "0px",
|
|
60
|
+
card: "0px",
|
|
61
|
+
panel: "0px",
|
|
62
|
+
modal: "0px",
|
|
63
|
+
popover: "0px",
|
|
64
|
+
badge: "2px",
|
|
65
|
+
avatar: "0px",
|
|
66
|
+
},
|
|
67
|
+
density: {
|
|
68
|
+
controlHeight: "38px",
|
|
69
|
+
controlPaddingX: "12px",
|
|
70
|
+
cardPadding: "16px",
|
|
71
|
+
panelPadding: "16px",
|
|
72
|
+
sectionGap: "20px",
|
|
73
|
+
listRowHeight: "40px",
|
|
74
|
+
tableRowHeight: "38px",
|
|
75
|
+
},
|
|
76
|
+
elevation: {
|
|
77
|
+
card: "none",
|
|
78
|
+
panel: "none",
|
|
79
|
+
popover: "0 12px 24px rgba(0, 0, 0, 0.18)",
|
|
80
|
+
modal: "0 20px 56px rgba(0, 0, 0, 0.24)",
|
|
81
|
+
none: "none",
|
|
82
|
+
},
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Component Impact
|
|
87
|
+
|
|
88
|
+
- Buttons: square edges, compact padding, strong hover and pressed states.
|
|
89
|
+
- Breadcrumbs: raised trails use square or near-square corners with tight separator rhythm.
|
|
90
|
+
- Inputs: square controls with clear border states.
|
|
91
|
+
- Cards: flat panels with borders instead of visible rounding.
|
|
92
|
+
- Dividers: clear 1px separators using `border.subtle`, with square action treatment and tight spacing.
|
|
93
|
+
- File uploads: precise dashed drop zones, square queued rows, tighter spacing, and border-led error states.
|
|
94
|
+
- Modals and popovers: square containers with overlay separation.
|
|
95
|
+
- Tables and lists: denser rows for scanning and comparison.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Component documentation pattern
|
|
2
|
+
|
|
3
|
+
Every component page in the playground renders through one shell so the docs
|
|
4
|
+
read the same way from component to component. A page is not "documented" until
|
|
5
|
+
it follows this shape.
|
|
6
|
+
|
|
7
|
+
## The shape
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
Header
|
|
11
|
+
Anchor nav
|
|
12
|
+
1. Base the component with no options applied
|
|
13
|
+
2. Anatomy live-measured specs, mapped back to tokens
|
|
14
|
+
3. Alternatives every supported variation, one card each
|
|
15
|
+
4. Installation / Usage / Composition / API / RTL / Live Variants
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Sections 4 and below are generated from `registry/index.json` by
|
|
19
|
+
`RegistryComponentDocs`. Sections 1 to 3 are authored per component.
|
|
20
|
+
|
|
21
|
+
## Writing a page
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
import { ComponentDocPage, type DocAlternative } from "./shared/component-doc-page"
|
|
25
|
+
|
|
26
|
+
export function BadgePage({ tokens }: { tokens: Record<string, string> }) {
|
|
27
|
+
return (
|
|
28
|
+
<ComponentDocPage
|
|
29
|
+
componentId="badge"
|
|
30
|
+
title="Badge"
|
|
31
|
+
description="…"
|
|
32
|
+
tokens={tokens}
|
|
33
|
+
base={{ children: <Badge>Badge</Badge>, code: baseCode }}
|
|
34
|
+
anatomy={{
|
|
35
|
+
options: [
|
|
36
|
+
{ id: "size", label: "Size", values: [{ id: "sm", label: "sm" }, { id: "lg", label: "lg" }] },
|
|
37
|
+
{ id: "type", label: "Type", values: […] },
|
|
38
|
+
],
|
|
39
|
+
render: (selection) => <Badge size={selection.size as "sm" | "lg"}>Badge</Badge>,
|
|
40
|
+
}}
|
|
41
|
+
alternatives={badgeAlternatives}
|
|
42
|
+
/>
|
|
43
|
+
)
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`playground/src/pages/BadgePage.tsx` is the reference implementation.
|
|
48
|
+
|
|
49
|
+
## Anatomy
|
|
50
|
+
|
|
51
|
+
The inspector in `playground/src/pages/shared/anatomy/` measures the rendered
|
|
52
|
+
DOM rather than reading hand-written numbers, so a spec can never drift from the
|
|
53
|
+
component that ships.
|
|
54
|
+
|
|
55
|
+
- The **first** option group becomes the rows of the spec matrix. Every value in
|
|
56
|
+
it is rendered off-screen and measured, so the matrix shows all sizes at once.
|
|
57
|
+
- Remaining groups become scrub toggles.
|
|
58
|
+
- Hovering a spec value highlights the matching segment on the diagram; hovering
|
|
59
|
+
a row switches the diagram to that variant.
|
|
60
|
+
- Each measured value is reverse-mapped to the `--bh-*` token that produced it.
|
|
61
|
+
A value with no matching token renders in the warning color with a `!` — that
|
|
62
|
+
is a real finding, not a display bug: it means the component hard-codes a
|
|
63
|
+
length instead of using the scale.
|
|
64
|
+
- Rulers and offsets are logical, so the whole diagram mirrors correctly in RTL
|
|
65
|
+
while the measurements stay identical.
|
|
66
|
+
|
|
67
|
+
Pass `measureSelector` when the rendered root is a wrapper rather than the
|
|
68
|
+
component itself.
|
|
69
|
+
|
|
70
|
+
Omit `anatomy` only for components with no inline measurable root: portal-only
|
|
71
|
+
overlays and canvas-style components.
|
|
72
|
+
|
|
73
|
+
## Enforcement
|
|
74
|
+
|
|
75
|
+
`playground/e2e/docs-consistency.spec.ts` asserts that every component and
|
|
76
|
+
pattern page renders a Base section, an Alternatives section, and an Anatomy
|
|
77
|
+
inspector with at least one measured row, and logs no console errors.
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
npm --prefix playground run test:browser
|
|
81
|
+
```
|