banhaten 0.4.0 → 0.5.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 +139 -100
- package/CONTRIBUTING.md +46 -44
- package/README.md +192 -190
- package/SECURITY.md +15 -15
- package/banhaten.config.example.json +11 -11
- package/docs/design-spacing.md +13 -0
- package/docs/design-system/README.md +22 -20
- package/docs/design-system/adoption-quality-remediation.md +87 -87
- package/docs/design-system/agent-usage.md +13 -13
- package/docs/design-system/appearance-presets.md +189 -189
- package/docs/design-system/appearances/default.md +94 -94
- package/docs/design-system/appearances/rounded.md +95 -95
- package/docs/design-system/appearances/sharp.md +95 -95
- package/docs/design-system/component-docs-pattern.md +81 -81
- package/docs/design-system/component-implementation-ownership-audit.md +245 -245
- package/docs/design-system/component-quality-audit-2026-08-20.md +225 -225
- package/docs/design-system/component-showcase-consistency-report.md +219 -219
- package/docs/design-system/component-token-consistency-audit.md +173 -173
- package/docs/design-system/components/README.md +90 -76
- package/docs/design-system/components/accordion.md +53 -53
- package/docs/design-system/components/activity-feed.md +94 -94
- package/docs/design-system/components/activity-heatmap.md +57 -57
- package/docs/design-system/components/agent-input.md +85 -0
- package/docs/design-system/components/alert-dialog.md +72 -72
- package/docs/design-system/components/alert.md +97 -97
- package/docs/design-system/components/approval-card.md +134 -0
- package/docs/design-system/components/aspect-ratio.md +45 -45
- package/docs/design-system/components/attribute.md +88 -88
- package/docs/design-system/components/autocomplete.md +75 -75
- package/docs/design-system/components/avatar.md +54 -54
- package/docs/design-system/components/badge.md +54 -54
- package/docs/design-system/components/banner.md +87 -87
- package/docs/design-system/components/breadcrumbs.md +176 -175
- package/docs/design-system/components/button-group.md +98 -98
- package/docs/design-system/components/button.md +83 -80
- package/docs/design-system/components/card.md +88 -88
- package/docs/design-system/components/carousel.md +46 -46
- package/docs/design-system/components/catalog-components.md +47 -47
- package/docs/design-system/components/chart.md +95 -24
- package/docs/design-system/components/checkbox.md +54 -54
- package/docs/design-system/components/collapsible.md +67 -53
- package/docs/design-system/components/command.md +62 -62
- package/docs/design-system/components/context-menu.md +46 -46
- package/docs/design-system/components/date-picker.md +81 -81
- package/docs/design-system/components/divider.md +102 -102
- package/docs/design-system/components/empty-state.md +56 -56
- package/docs/design-system/components/field.md +70 -70
- package/docs/design-system/components/file-upload.md +187 -187
- package/docs/design-system/components/hover-card.md +48 -48
- package/docs/design-system/components/icons.md +48 -48
- package/docs/design-system/components/inline-citations.md +93 -0
- package/docs/design-system/components/input-group.md +58 -58
- package/docs/design-system/components/input-otp.md +56 -56
- package/docs/design-system/components/input.md +114 -60
- package/docs/design-system/components/item.md +59 -59
- package/docs/design-system/components/kbd.md +51 -49
- package/docs/design-system/components/label.md +49 -49
- package/docs/design-system/components/menu.md +71 -61
- package/docs/design-system/components/menubar.md +47 -47
- package/docs/design-system/components/modal.md +105 -105
- package/docs/design-system/components/native-select.md +54 -54
- package/docs/design-system/components/navigation-menu.md +50 -50
- package/docs/design-system/components/onboarding-step-list-item.md +82 -82
- package/docs/design-system/components/page-header.md +93 -86
- package/docs/design-system/components/pagination.md +57 -57
- package/docs/design-system/components/popover.md +60 -60
- package/docs/design-system/components/progress-slider.md +50 -50
- package/docs/design-system/components/progress.md +76 -76
- package/docs/design-system/components/radio-card.md +51 -51
- package/docs/design-system/components/radio-group.md +57 -57
- package/docs/design-system/components/resizable.md +44 -44
- package/docs/design-system/components/rolling-count.md +61 -0
- package/docs/design-system/components/scroll-area.md +51 -51
- package/docs/design-system/components/segmented-control.md +54 -54
- package/docs/design-system/components/select.md +68 -62
- package/docs/design-system/components/sheet.md +67 -67
- package/docs/design-system/components/shimmer-text.md +67 -0
- package/docs/design-system/components/sidebar.md +110 -99
- package/docs/design-system/components/skeleton.md +75 -75
- package/docs/design-system/components/slideout.md +65 -65
- package/docs/design-system/components/slider.md +63 -63
- package/docs/design-system/components/social-button.md +50 -50
- package/docs/design-system/components/spinner.md +62 -62
- package/docs/design-system/components/steps.md +65 -65
- package/docs/design-system/components/streaming-text.md +82 -0
- package/docs/design-system/components/table.md +419 -414
- package/docs/design-system/components/tabs.md +59 -55
- package/docs/design-system/components/tag.md +80 -80
- package/docs/design-system/components/task-list.md +95 -0
- package/docs/design-system/components/textarea.md +50 -50
- package/docs/design-system/components/thinking-reasoning.md +72 -0
- package/docs/design-system/components/thinking-state.md +67 -0
- package/docs/design-system/components/timeline.md +83 -83
- package/docs/design-system/components/toast.md +58 -58
- package/docs/design-system/components/toggle.md +81 -81
- package/docs/design-system/components/toolbar.md +92 -87
- package/docs/design-system/components/tooltip.md +94 -92
- package/docs/design-system/components/typography.md +18 -18
- package/docs/design-system/density-and-elevation.md +65 -65
- package/docs/design-system/design-system-test-missing-items.md +368 -368
- package/docs/design-system/direction-and-localization.md +23 -23
- package/docs/design-system/form-recipes.md +73 -73
- package/docs/design-system/gap-promotion-policy.md +21 -21
- package/docs/design-system/icons.md +74 -74
- package/docs/design-system/installation.md +70 -68
- package/docs/design-system/launch-comparison-shadcn.md +98 -98
- package/docs/design-system/registry-and-cli.md +64 -64
- package/docs/design-system/release-policy.md +30 -30
- package/docs/design-system/roadmap.md +14 -14
- package/docs/design-system/support-matrix.md +23 -23
- package/docs/design-system/tabs.md +54 -53
- package/docs/design-system/template-gap-audit.md +32 -0
- package/docs/design-system/templates.md +59 -0
- package/docs/design-system/token-governance.md +72 -59
- package/package.json +98 -98
- package/registry/component-contract.json +40 -40
- package/registry/components/accordion.tsx +155 -155
- package/registry/components/agent-input-parts.tsx +552 -0
- package/registry/components/agent-input-state.ts +156 -0
- package/registry/components/agent-input.css +307 -0
- package/registry/components/agent-input.tsx +382 -0
- package/registry/components/alert-dialog.tsx +297 -297
- package/registry/components/alert.tsx +293 -293
- package/registry/components/approval-card.css +409 -0
- package/registry/components/approval-card.tsx +401 -0
- package/registry/components/approval-frame.tsx +108 -0
- package/registry/components/approval-questions.tsx +559 -0
- package/registry/components/aspect-ratio.tsx +30 -30
- package/registry/components/attribute.tsx +454 -454
- package/registry/components/autocomplete.tsx +598 -651
- package/registry/components/avatar.tsx +385 -385
- package/registry/components/badge.tsx +629 -629
- package/registry/components/button-group.tsx +565 -565
- package/registry/components/button.tsx +127 -123
- package/registry/components/card.tsx +638 -638
- package/registry/components/carousel.tsx +296 -296
- package/registry/components/chart-block-data.ts +177 -0
- package/registry/components/chart-block.css +171 -0
- package/registry/components/chart-block.tsx +260 -0
- package/registry/components/chart-interactions.ts +123 -0
- package/registry/components/chart-options.cartesian.ts +162 -0
- package/registry/components/chart-options.paint.ts +99 -0
- package/registry/components/chart-options.parts.ts +72 -0
- package/registry/components/chart-options.radial.ts +109 -0
- package/registry/components/chart-options.ts +44 -0
- package/registry/components/chart-options.types.ts +67 -0
- package/registry/components/chart.tsx +203 -203
- package/registry/components/checkbox.tsx +247 -247
- package/registry/components/collapsible.tsx +109 -69
- package/registry/components/command.tsx +208 -208
- package/registry/components/context-menu.tsx +236 -236
- package/registry/components/data-chart.tsx +40 -0
- package/registry/components/date-picker.tsx +1289 -1289
- package/registry/components/echart-theme.ts +246 -0
- package/registry/components/echart.css +49 -0
- package/registry/components/echart.tsx +178 -0
- package/registry/components/expanded/ActivityFeed.tsx +227 -227
- package/registry/components/expanded/ActivityHeatmap.tsx +64 -64
- package/registry/components/expanded/Banner.tsx +179 -179
- package/registry/components/expanded/Breadcrumbs.tsx +131 -131
- package/registry/components/expanded/CatalogComponentsShowcase.tsx +205 -205
- package/registry/components/expanded/CatalogDivider.tsx +49 -49
- package/registry/components/expanded/EmptyState.tsx +155 -155
- package/registry/components/expanded/FileUpload.tsx +543 -543
- package/registry/components/expanded/OnboardingStepListItem.tsx +60 -60
- package/registry/components/expanded/PageHeader.tsx +179 -166
- package/registry/components/expanded/Slideout.tsx +108 -108
- package/registry/components/expanded/Steps.tsx +402 -402
- package/registry/components/expanded/Table.tsx +1092 -1071
- package/registry/components/expanded/Timeline.tsx +203 -203
- package/registry/components/expanded/activityFeed.css +248 -248
- package/registry/components/expanded/activityHeatmap.css +66 -66
- package/registry/components/expanded/banner.css +260 -260
- package/registry/components/expanded/breadcrumbs.css +140 -140
- package/registry/components/expanded/catalogComponentsShowcase.css +87 -87
- package/registry/components/expanded/divider.css +75 -75
- package/registry/components/expanded/emptyState.css +111 -111
- package/registry/components/expanded/fileUpload.css +457 -457
- package/registry/components/expanded/onboardingStepListItem.css +135 -135
- package/registry/components/expanded/pageHeader.css +248 -290
- package/registry/components/expanded/slideout.css +276 -276
- package/registry/components/expanded/steps.css +356 -356
- package/registry/components/expanded/table.css +606 -606
- package/registry/components/expanded/timeline.css +286 -286
- package/registry/components/field.tsx +283 -283
- package/registry/components/hover-card.tsx +48 -48
- package/registry/components/inline-citations.css +126 -0
- package/registry/components/inline-citations.tsx +292 -0
- package/registry/components/input-content.ts +107 -107
- package/registry/components/input-group.tsx +130 -130
- package/registry/components/input-otp.tsx +584 -584
- package/registry/components/input.tsx +990 -979
- package/registry/components/item.tsx +189 -189
- package/registry/components/kbd.tsx +246 -245
- package/registry/components/label.tsx +78 -78
- package/registry/components/menu.tsx +978 -986
- package/registry/components/menubar.tsx +226 -226
- package/registry/components/modal.tsx +872 -872
- package/registry/components/native-select.tsx +205 -205
- package/registry/components/navigation-menu.tsx +171 -171
- package/registry/components/pagination.css +36 -36
- package/registry/components/pagination.tsx +560 -560
- package/registry/components/popover.tsx +338 -338
- package/registry/components/progress-slider.tsx +216 -216
- package/registry/components/radio-card.tsx +676 -676
- package/registry/components/radio-group.tsx +570 -570
- package/registry/components/resizable.tsx +108 -108
- package/registry/components/rolling-count.css +37 -0
- package/registry/components/rolling-count.tsx +110 -0
- package/registry/components/scroll-area.tsx +91 -91
- package/registry/components/segmented-control.tsx +87 -87
- package/registry/components/select-content.tsx +218 -218
- package/registry/components/select.tsx +937 -932
- package/registry/components/sheet.tsx +305 -305
- package/registry/components/shimmer-text.css +69 -0
- package/registry/components/shimmer-text.tsx +43 -0
- package/registry/components/sidebar.tsx +1433 -1230
- package/registry/components/skeleton.css +54 -54
- package/registry/components/skeleton.tsx +482 -482
- package/registry/components/slider.tsx +380 -380
- package/registry/components/social-button.tsx +387 -387
- package/registry/components/spinner.tsx +78 -78
- package/registry/components/streaming-text.css +45 -0
- package/registry/components/streaming-text.tsx +165 -0
- package/registry/components/table-elements.tsx +128 -128
- package/registry/components/tabs.css +222 -218
- package/registry/components/tabs.tsx +241 -241
- package/registry/components/tag.tsx +423 -423
- package/registry/components/task-list.css +328 -0
- package/registry/components/task-list.tsx +429 -0
- package/registry/components/textarea.tsx +610 -610
- package/registry/components/thinking-reasoning.css +178 -0
- package/registry/components/thinking-reasoning.tsx +253 -0
- package/registry/components/thinking-state.css +8 -0
- package/registry/components/thinking-state.tsx +46 -0
- package/registry/components/toast.tsx +136 -136
- package/registry/components/toggle.tsx +256 -256
- package/registry/components/toolbar.tsx +539 -539
- package/registry/components/tooltip.tsx +433 -431
- package/registry/examples/agent-input-demo.tsx +90 -0
- package/registry/examples/alert-demo.tsx +34 -34
- package/registry/examples/alert-dialog-demo.tsx +42 -42
- package/registry/examples/approval-card-demo.tsx +83 -0
- package/registry/examples/aspect-ratio-demo.tsx +11 -11
- package/registry/examples/attribute-demo.tsx +65 -65
- package/registry/examples/autocomplete-demo.tsx +109 -109
- package/registry/examples/avatar-demo.tsx +132 -132
- package/registry/examples/badge-demo.tsx +69 -69
- package/registry/examples/button-demo.tsx +86 -83
- package/registry/examples/button-group-demo.tsx +63 -63
- package/registry/examples/card-demo.tsx +86 -86
- package/registry/examples/carousel-demo.tsx +43 -43
- package/registry/examples/chart-block-demo.tsx +5 -0
- package/registry/examples/chart-demo.tsx +18 -33
- package/registry/examples/checkbox-demo.tsx +62 -62
- package/registry/examples/collapsible-demo.tsx +16 -16
- package/registry/examples/collection-filter-bar-demo.tsx +135 -135
- package/registry/examples/command-demo.tsx +42 -42
- package/registry/examples/command-palette-demo.tsx +235 -235
- package/registry/examples/context-menu-demo.tsx +29 -29
- package/registry/examples/control-density-contract-demo.tsx +65 -61
- package/registry/examples/date-picker-demo.tsx +127 -127
- package/registry/examples/divider-demo.tsx +17 -17
- package/registry/examples/expanded/activity-heatmap-demo.tsx +29 -29
- package/registry/examples/expanded/banner-demo.tsx +48 -48
- package/registry/examples/expanded/breadcrumbs-demo.tsx +59 -59
- package/registry/examples/expanded/empty-state-demo.tsx +39 -39
- package/registry/examples/expanded/file-upload-demo.tsx +60 -60
- package/registry/examples/expanded/onboarding-step-demo.tsx +11 -11
- package/registry/examples/expanded/slideout-demo.tsx +15 -15
- package/registry/examples/expanded/steps-demo.tsx +29 -29
- package/registry/examples/expanded/tabs-demo.tsx +13 -13
- package/registry/examples/expanded/timeline-demo.tsx +18 -18
- package/registry/examples/field-demo.tsx +51 -51
- package/registry/examples/hover-card-demo.tsx +23 -23
- package/registry/examples/inline-citations-demo.tsx +31 -0
- package/registry/examples/input-actions-demo.tsx +36 -0
- package/registry/examples/input-demo.tsx +87 -87
- package/registry/examples/input-group-demo.tsx +16 -16
- package/registry/examples/input-otp-demo.tsx +72 -72
- package/registry/examples/item-demo.tsx +46 -46
- package/registry/examples/kbd-demo.tsx +12 -12
- package/registry/examples/label-demo.tsx +20 -20
- package/registry/examples/menu-demo.tsx +122 -122
- package/registry/examples/menubar-demo.tsx +34 -34
- package/registry/examples/modal-demo.tsx +74 -74
- package/registry/examples/native-select-demo.tsx +16 -16
- package/registry/examples/navigation-menu-demo.tsx +29 -29
- package/registry/examples/pagination-demo.tsx +20 -20
- package/registry/examples/popover-demo.tsx +547 -546
- package/registry/examples/progress-demo.tsx +37 -37
- package/registry/examples/progress-slider-demo.tsx +29 -29
- package/registry/examples/radio-card-demo.tsx +51 -51
- package/registry/examples/radio-group-demo.tsx +62 -62
- package/registry/examples/resizable-demo.tsx +22 -22
- package/registry/examples/results-toolbar-demo.tsx +44 -44
- package/registry/examples/rolling-count-demo.tsx +39 -0
- package/registry/examples/scroll-area-demo.tsx +15 -15
- package/registry/examples/segmented-control-demo.tsx +39 -39
- package/registry/examples/select-demo.tsx +87 -87
- package/registry/examples/sheet-demo.tsx +47 -47
- package/registry/examples/shimmer-text-demo.tsx +20 -0
- package/registry/examples/sidebar-demo.tsx +101 -101
- package/registry/examples/slider-demo.tsx +31 -31
- package/registry/examples/social-button-demo.tsx +61 -61
- package/registry/examples/spinner-demo.tsx +59 -59
- package/registry/examples/streaming-text-demo.tsx +28 -0
- package/registry/examples/tabs-demo.tsx +13 -13
- package/registry/examples/tag-demo.tsx +29 -29
- package/registry/examples/task-list-demo.tsx +74 -0
- package/registry/examples/textarea-demo.tsx +79 -79
- package/registry/examples/thinking-reasoning-demo.tsx +74 -0
- package/registry/examples/thinking-state-demo.tsx +13 -0
- package/registry/examples/toast-demo.tsx +35 -35
- package/registry/examples/toggle-demo.tsx +59 -59
- package/registry/examples/tooltip-demo.tsx +115 -115
- package/registry/guidance/USAGE.md +27 -27
- package/registry/guidance/charts.LICENSE.txt +24 -0
- package/registry/hooks/use-controllable-state.ts +33 -0
- package/registry/hooks/use-direction.ts +207 -207
- package/registry/hooks/use-listbox-navigation.ts +73 -0
- package/registry/hooks/use-motion-end.ts +55 -0
- package/registry/hooks/use-reduced-motion.ts +28 -0
- package/registry/index.json +1403 -155
- package/registry/styles/globals.css +946 -1088
- package/registry.json +361 -8
- package/schema/config.schema.json +51 -51
- package/schema/registry.schema.json +194 -190
- package/schema/tokens.schema.json +167 -163
- package/src/cli/command-line.js +194 -194
- package/src/cli/config-editors.js +9 -9
- package/src/cli/doctor.js +399 -399
- package/src/cli/file-transaction.js +302 -295
- package/src/cli/global-css.js +153 -153
- package/src/cli/index.js +1002 -1009
- package/src/cli/install-plan.js +592 -592
- package/src/cli/install-receipt.js +171 -171
- package/src/cli/jsonc.js +203 -203
- package/src/cli/package-install-state.js +254 -254
- package/src/cli/package-manager.js +238 -238
- package/src/cli/package-plan.js +185 -185
- package/src/cli/package-version.js +97 -97
- package/src/cli/registry-query.js +207 -207
- package/src/cli/reporting.js +55 -55
- package/src/cli/schema-validation.js +19 -19
- package/src/cli/source-scanner.js +686 -686
- package/src/cli/vite-config.js +478 -478
- package/tokens/banhaten.tokens.json +306 -192
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
# Hover Card
|
|
2
|
-
|
|
3
|
-
Hover Card wraps Radix HoverCard for rich preview content on hover and focus.
|
|
4
|
-
|
|
5
|
-
## API
|
|
6
|
-
|
|
7
|
-
```tsx
|
|
8
|
-
<HoverCard>
|
|
9
|
-
<HoverCardTrigger>Workspace profile</HoverCardTrigger>
|
|
10
|
-
<HoverCardContent>Preview content</HoverCardContent>
|
|
11
|
-
</HoverCard>
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
| Part | Purpose |
|
|
15
|
-
| --- | --- |
|
|
16
|
-
| `HoverCard`, `HoverCardTrigger`, `HoverCardPortal` | Radix shell |
|
|
17
|
-
| `HoverCardContent` | tokenized preview surface |
|
|
18
|
-
|
|
19
|
-
## Token Contract
|
|
20
|
-
|
|
21
|
-
Hover Card uses Banhaten raised background, popover shadow, radius, spacing, and content tokens.
|
|
22
|
-
|
|
23
|
-
## RTL
|
|
24
|
-
|
|
25
|
-
Content inherits direction and uses logical text alignment.
|
|
26
|
-
|
|
27
|
-
## Accessibility
|
|
28
|
-
|
|
29
|
-
Radix manages hover/focus timing and content relationships.
|
|
30
|
-
|
|
31
|
-
## Install
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
npx banhaten add hover-card
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## Examples
|
|
38
|
-
|
|
39
|
-
Primary registry example: `examples/hover-card-demo.tsx`.
|
|
40
|
-
|
|
41
|
-
Open the live component page or run `npx banhaten docs hover-card` to inspect source files, install command, and examples.
|
|
42
|
-
|
|
43
|
-
## RTL Rules
|
|
44
|
-
|
|
45
|
-
- `inheritsDirection`: true
|
|
46
|
-
- `textDirection`: Content inherits direction and uses logical text alignment.
|
|
47
|
-
|
|
1
|
+
# Hover Card
|
|
2
|
+
|
|
3
|
+
Hover Card wraps Radix HoverCard for rich preview content on hover and focus.
|
|
4
|
+
|
|
5
|
+
## API
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
<HoverCard>
|
|
9
|
+
<HoverCardTrigger>Workspace profile</HoverCardTrigger>
|
|
10
|
+
<HoverCardContent>Preview content</HoverCardContent>
|
|
11
|
+
</HoverCard>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
| Part | Purpose |
|
|
15
|
+
| --- | --- |
|
|
16
|
+
| `HoverCard`, `HoverCardTrigger`, `HoverCardPortal` | Radix shell |
|
|
17
|
+
| `HoverCardContent` | tokenized preview surface |
|
|
18
|
+
|
|
19
|
+
## Token Contract
|
|
20
|
+
|
|
21
|
+
Hover Card uses Banhaten raised background, popover shadow, radius, spacing, and content tokens.
|
|
22
|
+
|
|
23
|
+
## RTL
|
|
24
|
+
|
|
25
|
+
Content inherits direction and uses logical text alignment.
|
|
26
|
+
|
|
27
|
+
## Accessibility
|
|
28
|
+
|
|
29
|
+
Radix manages hover/focus timing and content relationships.
|
|
30
|
+
|
|
31
|
+
## Install
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx banhaten add hover-card
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Examples
|
|
38
|
+
|
|
39
|
+
Primary registry example: `examples/hover-card-demo.tsx`.
|
|
40
|
+
|
|
41
|
+
Open the live component page or run `npx banhaten docs hover-card` to inspect source files, install command, and examples.
|
|
42
|
+
|
|
43
|
+
## RTL Rules
|
|
44
|
+
|
|
45
|
+
- `inheritsDirection`: true
|
|
46
|
+
- `textDirection`: Content inherits direction and uses logical text alignment.
|
|
47
|
+
|
|
48
48
|
<!-- registry-contract:start -->
|
|
49
49
|
## Registry Contract
|
|
50
50
|
|
|
@@ -57,5 +57,5 @@ This table is generated from `registry/index.json`; edit the component-owned sou
|
|
|
57
57
|
| `parts` | `HoverCard`, `HoverCardTrigger`, `HoverCardContent`, `HoverCardPortal` |
|
|
58
58
|
| `registryDependencies` | None |
|
|
59
59
|
| `features` | `hover preview`, `focus preview`, `open delay`, `close delay` |
|
|
60
|
-
| `tokens` | `--bh-bg-raised`, `--bh-content-default`, `--bh-radius-2xl-12`, `--bh-space-18xl-320`, `--bh-space-3xl-16`, `--bh-space-md-8`, `--bh-z-popover`, `--
|
|
60
|
+
| `tokens` | `--bh-bg-raised`, `--bh-content-default`, `--bh-radius-2xl-12`, `--bh-space-18xl-320`, `--bh-space-3xl-16`, `--bh-space-md-8`, `--bh-z-popover`, `--elevation-popover` |
|
|
61
61
|
<!-- registry-contract:end -->
|
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
# Icons
|
|
2
|
-
|
|
3
|
-
Icons is an expanded-tier explorer for reviewing open-source icon packs, semantic mappings, shortlist comparisons, and Iconify catalog options.
|
|
4
|
-
|
|
5
|
-
## API
|
|
6
|
-
|
|
7
|
-
```tsx
|
|
8
|
-
<IconExplorer />
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
| Feature | Notes |
|
|
12
|
-
| --- | --- |
|
|
13
|
-
| Icon pack review | compares candidate open-source packs |
|
|
14
|
-
| Semantic mapping | maps product concepts to icon candidates |
|
|
15
|
-
| Shortlist comparison | supports side-by-side review |
|
|
16
|
-
| Iconify inspection | loads Iconify catalog data at runtime |
|
|
17
|
-
|
|
18
|
-
## Runtime
|
|
19
|
-
|
|
20
|
-
The explorer may load `https://code.iconify.design/iconify-icon/3.0.0/iconify-icon.min.js` and query `https://api.iconify.design`.
|
|
21
|
-
|
|
22
|
-
## Token Contract
|
|
23
|
-
|
|
24
|
-
The explorer uses expanded-tier CSS plus Banhaten surface, typography, border, spacing, focus, and content tokens. Product components should still use their local icon contracts instead of depending on this explorer.
|
|
25
|
-
|
|
26
|
-
## RTL
|
|
27
|
-
|
|
28
|
-
Explorer layout should inherit page direction for navigation, labels, and comparison rows. Icon glyphs themselves should only mirror when they are directional.
|
|
29
|
-
|
|
30
|
-
## Accessibility
|
|
31
|
-
|
|
32
|
-
Icon candidates must be reviewed for accessible usage. Decorative icons should be hidden with `aria-hidden`; actionable icon-only controls need clear accessible names.
|
|
33
|
-
|
|
34
|
-
## Install
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npx banhaten add icons
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Examples
|
|
41
|
-
|
|
42
|
-
Primary registry example: `examples/expanded/icons-demo.tsx`.
|
|
43
|
-
|
|
44
|
-
Open the live component page or run `npx banhaten docs icons` to inspect source files, install command, and examples.
|
|
45
|
-
|
|
46
|
-
## RTL Rules
|
|
47
|
-
|
|
48
|
-
This component has no special RTL contract beyond inherited document direction and logical spacing.
|
|
1
|
+
# Icons
|
|
2
|
+
|
|
3
|
+
Icons is an expanded-tier explorer for reviewing open-source icon packs, semantic mappings, shortlist comparisons, and Iconify catalog options.
|
|
4
|
+
|
|
5
|
+
## API
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
<IconExplorer />
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
| Feature | Notes |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| Icon pack review | compares candidate open-source packs |
|
|
14
|
+
| Semantic mapping | maps product concepts to icon candidates |
|
|
15
|
+
| Shortlist comparison | supports side-by-side review |
|
|
16
|
+
| Iconify inspection | loads Iconify catalog data at runtime |
|
|
17
|
+
|
|
18
|
+
## Runtime
|
|
19
|
+
|
|
20
|
+
The explorer may load `https://code.iconify.design/iconify-icon/3.0.0/iconify-icon.min.js` and query `https://api.iconify.design`.
|
|
21
|
+
|
|
22
|
+
## Token Contract
|
|
23
|
+
|
|
24
|
+
The explorer uses expanded-tier CSS plus Banhaten surface, typography, border, spacing, focus, and content tokens. Product components should still use their local icon contracts instead of depending on this explorer.
|
|
25
|
+
|
|
26
|
+
## RTL
|
|
27
|
+
|
|
28
|
+
Explorer layout should inherit page direction for navigation, labels, and comparison rows. Icon glyphs themselves should only mirror when they are directional.
|
|
29
|
+
|
|
30
|
+
## Accessibility
|
|
31
|
+
|
|
32
|
+
Icon candidates must be reviewed for accessible usage. Decorative icons should be hidden with `aria-hidden`; actionable icon-only controls need clear accessible names.
|
|
33
|
+
|
|
34
|
+
## Install
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npx banhaten add icons
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Examples
|
|
41
|
+
|
|
42
|
+
Primary registry example: `examples/expanded/icons-demo.tsx`.
|
|
43
|
+
|
|
44
|
+
Open the live component page or run `npx banhaten docs icons` to inspect source files, install command, and examples.
|
|
45
|
+
|
|
46
|
+
## RTL Rules
|
|
47
|
+
|
|
48
|
+
This component has no special RTL contract beyond inherited document direction and logical spacing.
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Inline Citations
|
|
2
|
+
|
|
3
|
+
`InlineCitations` renders prose with superscript numbered chips that link to their sources and reveal the reference name in a Tooltip on hover, followed by a compact source list showing the number, label, host, and an external-link arrow.
|
|
4
|
+
|
|
5
|
+
Compose the prose from `CitationProse` paragraphs and place a `CitationMark` wherever a claim needs support. Each mark finds its source by number, so nothing is parsed out of the text: a literal "[1]" stays text, and a mark whose number has no source renders nothing instead of a dead chip. Outside `InlineCitations`, give a mark its own `href` and `label`.
|
|
6
|
+
|
|
7
|
+
Citation URLs usually come from model output or search results, so only web addresses become links: `http:` and `https:` URLs, relative links included. A source with any other URL, such as `javascript:` or `data:`, gets no chip in the prose and a plain, unlinked row in the source list. This holds on React 18, which still renders `javascript:` links, as well as on React 19.
|
|
8
|
+
|
|
9
|
+
## API
|
|
10
|
+
|
|
11
|
+
```tsx
|
|
12
|
+
import {
|
|
13
|
+
CitationMark,
|
|
14
|
+
CitationProse,
|
|
15
|
+
InlineCitations,
|
|
16
|
+
type CitationSource,
|
|
17
|
+
} from "@/components/ui/inline-citations"
|
|
18
|
+
|
|
19
|
+
const sources: CitationSource[] = [
|
|
20
|
+
{ host: "arxiv.org", label: "Attention Is All You Need", url: "https://arxiv.org/abs/1706.03762" },
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
<InlineCitations sources={sources}>
|
|
24
|
+
<CitationProse>
|
|
25
|
+
Transformers scale well with data and compute<CitationMark n={1} />.
|
|
26
|
+
</CitationProse>
|
|
27
|
+
</InlineCitations>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Model output that attaches citations to spans of text maps straight onto marks:
|
|
31
|
+
|
|
32
|
+
```tsx
|
|
33
|
+
<CitationProse>
|
|
34
|
+
{segments.map((segment, index) => (
|
|
35
|
+
<React.Fragment key={index}>
|
|
36
|
+
{segment.text}
|
|
37
|
+
{segment.cite ? <CitationMark n={segment.cite} /> : null}
|
|
38
|
+
</React.Fragment>
|
|
39
|
+
))}
|
|
40
|
+
</CitationProse>
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
| Prop | Type | Default | Description |
|
|
44
|
+
| --- | --- | --- | --- |
|
|
45
|
+
| `children` | `React.ReactNode` | – | Cited prose: `CitationProse` paragraphs with `CitationMark` markers. |
|
|
46
|
+
| `sources` | `readonly CitationSource[]` | – | `label`, `url`, optional `host`, and optional `n` (defaults to position). Only `http:` and `https:` URLs link. |
|
|
47
|
+
| `showSources` | `boolean` | `true` | Renders the source list under the prose whenever there are sources to list. |
|
|
48
|
+
| `labels` | `Partial<InlineCitationsLabels>` | English | `citation(n, label)` accessible name and the `sources` list name. |
|
|
49
|
+
|
|
50
|
+
`CitationMark` takes the marker number `n`; its optional `href` and `label` override the matching source. `CitationList` and `CitationItem` render the reference list on their own.
|
|
51
|
+
|
|
52
|
+
## Install
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npx banhaten add inline-citations
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Examples
|
|
59
|
+
|
|
60
|
+
Primary registry example: `examples/inline-citations-demo.tsx`.
|
|
61
|
+
|
|
62
|
+
## Token Contract
|
|
63
|
+
|
|
64
|
+
Chips are `--bh-citation-mark-size` squares (aliasing `--bh-space-2xl-14`) with `--bh-radius-sm-4`, `--bh-interactive-soft-default` fill, `--bh-content-subtle` text on the `body-3xs-semibold` scale, and `--bh-interactive-soft-hover` on hover. The list separates with `--bh-border-subtle`, uses the `body-2xs` scale, and reveals a `--bh-space-lg-10` arrow. Tooltips reuse the Tooltip primitive tokens.
|
|
65
|
+
|
|
66
|
+
Covered source files: `components/inline-citations.tsx`, `components/inline-citations.css`, and the `tooltip` registry dependency.
|
|
67
|
+
|
|
68
|
+
## RTL Rules
|
|
69
|
+
|
|
70
|
+
- Prose and list rows inherit document direction and use logical margins and gaps.
|
|
71
|
+
- Hosts stay LTR; the external arrow mirrors horizontally in RTL.
|
|
72
|
+
|
|
73
|
+
## Accessibility
|
|
74
|
+
|
|
75
|
+
Every chip is a link with an accessible name that includes the number and the reference label, opening in a new tab with `rel="noreferrer"`. The source list is a `nav` landmark named by `labels.sources`. Hover-only affordances (tooltip, arrow) also appear on keyboard focus.
|
|
76
|
+
|
|
77
|
+
<!-- registry-contract:start -->
|
|
78
|
+
## Registry Contract
|
|
79
|
+
|
|
80
|
+
This table is generated from `registry/index.json`; edit the component-owned source under `registry/catalog/components/`, not this table or the compiled index.
|
|
81
|
+
`supportedExports` is the exhaustive runtime import contract grouped by source module. `parts` is an ordered, non-exhaustive anatomy list.
|
|
82
|
+
|
|
83
|
+
| Field | Values |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `supportedExports` | `components/inline-citations.tsx: CitationItem, CitationList, CitationMark, CitationProse, InlineCitations` |
|
|
86
|
+
| `parts` | `InlineCitations`, `CitationProse`, `CitationMark`, `CitationList`, `CitationItem` |
|
|
87
|
+
| `registryDependencies` | `tooltip` |
|
|
88
|
+
| `props.children` | `React.ReactNode; default null; Cited prose: CitationProse paragraphs with CitationMark markers that find their source by number.` |
|
|
89
|
+
| `props.sources` | `readonly CitationSource[]; default null; Cited sources with label, url, optional host, and optional marker number. Only http and https URLs become links.` |
|
|
90
|
+
| `props.showSources` | `boolean; default "true"; Renders the compact source list under the prose when there are sources.` |
|
|
91
|
+
| `props.labels` | `Partial<InlineCitationsLabels>; default "English"; Localized accessible names for markers and the source list.` |
|
|
92
|
+
| `tokens` | `--bh-border-subtle`, `--bh-border-width-default`, `--bh-citation-mark-size`, `--bh-content-default`, `--bh-content-subtle`, `--bh-duration-default`, `--bh-duration-fast`, `--bh-easing-standard`, `--bh-font-family`, `--bh-icon-stroke-180`, `--bh-interactive-soft-default`, `--bh-interactive-soft-hover`, `--bh-opacity-0`, `--bh-opacity-100`, `--bh-radius-sm-4`, `--bh-space-lg-10`, `--bh-space-sm-6`, `--bh-space-xl-12`, `--bh-space-xxs-2`, `--bh-space-xxxs-1`, `--bh-text-body-2xs-regular-font-size`, `--bh-text-body-2xs-regular-font-weight`, `--bh-text-body-2xs-regular-letter-spacing`, `--bh-text-body-2xs-regular-line-height`, `--bh-text-body-3xs-semibold-font-size`, `--bh-text-body-3xs-semibold-font-weight`, `--bh-text-body-3xs-semibold-letter-spacing`, `--bh-text-body-sm-regular-font-size`, `--bh-text-body-sm-regular-font-weight`, `--bh-text-body-sm-regular-letter-spacing`, `--bh-text-body-sm-regular-line-height`, `--elevation-component-focus-ring` |
|
|
93
|
+
<!-- registry-contract:end -->
|
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
# Input Group
|
|
2
|
-
|
|
3
|
-
Input Group provides a tokenized shell for text inputs with protocol add-ons, prefixes, suffixes, and inline actions.
|
|
4
|
-
|
|
5
|
-
## API
|
|
6
|
-
|
|
7
|
-
```tsx
|
|
8
|
-
<InputGroup>
|
|
9
|
-
<InputGroupAddon>https://</InputGroupAddon>
|
|
10
|
-
<InputGroupInput aria-label="Workspace URL" />
|
|
11
|
-
<InputGroupButton>Save</InputGroupButton>
|
|
12
|
-
</InputGroup>
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
| Part | Purpose |
|
|
16
|
-
| --- | --- |
|
|
17
|
-
| `InputGroup` | shared input shell |
|
|
18
|
-
| `InputGroupAddon` | prefix or suffix content |
|
|
19
|
-
| `InputGroupInput` | native input |
|
|
20
|
-
| `InputGroupButton` | inline action |
|
|
21
|
-
|
|
22
|
-
| Prop | Values |
|
|
23
|
-
| --- | --- |
|
|
24
|
-
| `size` | `md`, `lg` |
|
|
25
|
-
| `variant` | `default`, `soft` |
|
|
26
|
-
| `state` | `default`, `error` |
|
|
27
|
-
|
|
28
|
-
## Token Contract
|
|
29
|
-
|
|
30
|
-
Input Group reuses Banhaten input width, height, radius, border, shadow, typography, and focus tokens.
|
|
31
|
-
|
|
32
|
-
## RTL
|
|
33
|
-
|
|
34
|
-
Use logical add-on order. Border placement uses logical inline sides.
|
|
35
|
-
|
|
36
|
-
## Accessibility
|
|
37
|
-
|
|
38
|
-
Give `InputGroupInput` an accessible label through `aria-label`, `aria-labelledby`, or a surrounding Field.
|
|
39
|
-
|
|
40
|
-
## Install
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
npx banhaten add input-group
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Examples
|
|
47
|
-
|
|
48
|
-
Primary registry example: `examples/input-group-demo.tsx`.
|
|
49
|
-
|
|
50
|
-
Open the live component page or run `npx banhaten docs input-group` to inspect source files, install command, and examples.
|
|
51
|
-
|
|
52
|
-
## RTL Rules
|
|
53
|
-
|
|
54
|
-
- `inheritsDirection`: true
|
|
55
|
-
- `spacing`: Add-ons and input segments use logical borders and inherited direction.
|
|
56
|
-
- `textDirection`: Input text uses text-start so mixed Arabic and English values align naturally.
|
|
57
|
-
|
|
1
|
+
# Input Group
|
|
2
|
+
|
|
3
|
+
Input Group provides a tokenized shell for text inputs with protocol add-ons, prefixes, suffixes, and inline actions.
|
|
4
|
+
|
|
5
|
+
## API
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
<InputGroup>
|
|
9
|
+
<InputGroupAddon>https://</InputGroupAddon>
|
|
10
|
+
<InputGroupInput aria-label="Workspace URL" />
|
|
11
|
+
<InputGroupButton>Save</InputGroupButton>
|
|
12
|
+
</InputGroup>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
| Part | Purpose |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| `InputGroup` | shared input shell |
|
|
18
|
+
| `InputGroupAddon` | prefix or suffix content |
|
|
19
|
+
| `InputGroupInput` | native input |
|
|
20
|
+
| `InputGroupButton` | inline action |
|
|
21
|
+
|
|
22
|
+
| Prop | Values |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `size` | `md`, `lg` |
|
|
25
|
+
| `variant` | `default`, `soft` |
|
|
26
|
+
| `state` | `default`, `error` |
|
|
27
|
+
|
|
28
|
+
## Token Contract
|
|
29
|
+
|
|
30
|
+
Input Group reuses Banhaten input width, height, radius, border, shadow, typography, and focus tokens.
|
|
31
|
+
|
|
32
|
+
## RTL
|
|
33
|
+
|
|
34
|
+
Use logical add-on order. Border placement uses logical inline sides.
|
|
35
|
+
|
|
36
|
+
## Accessibility
|
|
37
|
+
|
|
38
|
+
Give `InputGroupInput` an accessible label through `aria-label`, `aria-labelledby`, or a surrounding Field.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx banhaten add input-group
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Examples
|
|
47
|
+
|
|
48
|
+
Primary registry example: `examples/input-group-demo.tsx`.
|
|
49
|
+
|
|
50
|
+
Open the live component page or run `npx banhaten docs input-group` to inspect source files, install command, and examples.
|
|
51
|
+
|
|
52
|
+
## RTL Rules
|
|
53
|
+
|
|
54
|
+
- `inheritsDirection`: true
|
|
55
|
+
- `spacing`: Add-ons and input segments use logical borders and inherited direction.
|
|
56
|
+
- `textDirection`: Input text uses text-start so mixed Arabic and English values align naturally.
|
|
57
|
+
|
|
58
58
|
<!-- registry-contract:start -->
|
|
59
59
|
## Registry Contract
|
|
60
60
|
|
|
@@ -68,6 +68,6 @@ This table is generated from `registry/index.json`; edit the component-owned sou
|
|
|
68
68
|
| `registryDependencies` | `button` |
|
|
69
69
|
| `sizes` | `md`, `lg` |
|
|
70
70
|
| `states` | `default`, `error` |
|
|
71
|
-
| `tokens` | `--bh-border-danger-strong`, `--bh-border-disabled`, `--bh-border-input`, `--bh-border-width-default`, `--bh-content-default`, `--bh-content-disabled`, `--bh-content-muted`, `--bh-content-subtle`, `--bh-input-border`, `--bh-input-lg-height`, `--bh-input-lg-padding-x`, `--bh-input-md-height`, `--bh-input-radius`, `--bh-input-width`, `--bh-interactive-input-default`, `--bh-interactive-input-disabled`, `--bh-interactive-input-soft`, `--bh-space-sm-6`, `--bh-space-xl-12`, `--bh-space-xs-4`, `--bh-text-body-md-regular-font-size`, `--bh-text-body-md-regular-font-weight`, `--bh-text-body-md-regular-letter-spacing`, `--bh-text-body-md-regular-line-height`, `--bh-text-body-sm-medium-font-size`, `--bh-text-body-sm-medium-font-weight`, `--bh-text-body-sm-medium-letter-spacing`, `--bh-text-body-sm-medium-line-height`, `--
|
|
71
|
+
| `tokens` | `--bh-border-danger-strong`, `--bh-border-disabled`, `--bh-border-input`, `--bh-border-width-default`, `--bh-content-default`, `--bh-content-disabled`, `--bh-content-muted`, `--bh-content-subtle`, `--bh-input-border`, `--bh-input-lg-height`, `--bh-input-lg-padding-x`, `--bh-input-md-height`, `--bh-input-radius`, `--bh-input-width`, `--bh-interactive-input-default`, `--bh-interactive-input-disabled`, `--bh-interactive-input-soft`, `--bh-space-sm-6`, `--bh-space-xl-12`, `--bh-space-xs-4`, `--bh-text-body-md-regular-font-size`, `--bh-text-body-md-regular-font-weight`, `--bh-text-body-md-regular-letter-spacing`, `--bh-text-body-md-regular-line-height`, `--bh-text-body-sm-medium-font-size`, `--bh-text-body-sm-medium-font-weight`, `--bh-text-body-sm-medium-letter-spacing`, `--bh-text-body-sm-medium-line-height`, `--elevation-component-default`, `--elevation-input`, `--elevation-input-focus-ring` |
|
|
72
72
|
| `variants` | `default`, `soft` |
|
|
73
73
|
<!-- registry-contract:end -->
|
|
@@ -1,59 +1,59 @@
|
|
|
1
|
-
# Input OTP
|
|
2
|
-
|
|
3
|
-
Input OTP captures one-time passcodes and short verification codes. It reuses the Banhaten Input surface and typography while adding grouped slots, paste distribution, hidden form value, masking, custom length, and RTL-aware keyboard navigation.
|
|
4
|
-
|
|
5
|
-
## API
|
|
6
|
-
|
|
7
|
-
```tsx
|
|
8
|
-
<InputOTP
|
|
9
|
-
label="Verification code"
|
|
10
|
-
length={6}
|
|
11
|
-
name="code"
|
|
12
|
-
onValueChange={setCode}
|
|
13
|
-
/>
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
| Prop | Values |
|
|
17
|
-
| --- | --- |
|
|
18
|
-
| `value`, `defaultValue` | controlled or uncontrolled string |
|
|
19
|
-
| `length` | slot count |
|
|
20
|
-
| `groupPattern` | array of slot group sizes |
|
|
21
|
-
| `masked` | `boolean` |
|
|
22
|
-
| `variant` | `default`, `soft` |
|
|
23
|
-
| `size` | `md`, `lg` |
|
|
24
|
-
| `state` | `default`, `filled`, `error`, `disabled` |
|
|
25
|
-
|
|
26
|
-
## Token Contract
|
|
27
|
-
|
|
28
|
-
Input OTP uses Input field tokens for surfaces, typography, focus, border, error, helper text, labels, slot gaps, and disabled states.
|
|
29
|
-
|
|
30
|
-
## RTL
|
|
31
|
-
|
|
32
|
-
Slot groups inherit direction. Arrow navigation mirrors in RTL so visual previous and next follow the rendered direction.
|
|
33
|
-
|
|
34
|
-
## Accessibility
|
|
35
|
-
|
|
36
|
-
Provide a clear label and helper text describing how many digits are expected. The hidden form value lets the component participate in standard form submission.
|
|
37
|
-
|
|
38
|
-
## Install
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
npx banhaten add input-otp
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Examples
|
|
45
|
-
|
|
46
|
-
Primary registry example: `examples/input-otp-demo.tsx`.
|
|
47
|
-
|
|
48
|
-
Open the live component page or run `npx banhaten docs input-otp` to inspect source files, install command, and examples.
|
|
49
|
-
|
|
50
|
-
## RTL Rules
|
|
51
|
-
|
|
52
|
-
- `inheritsDirection`: true
|
|
53
|
-
- `keyboard`: Arrow navigation mirrors for RTL: visual previous and next follow the inherited direction.
|
|
54
|
-
- `spacing`: Slot groups, separators, labels, and helper text use inherited direction plus Input spacing tokens.
|
|
55
|
-
- `composition`: Each slot reuses the Banhaten Input surface and control typography instead of a separate field style.
|
|
56
|
-
|
|
1
|
+
# Input OTP
|
|
2
|
+
|
|
3
|
+
Input OTP captures one-time passcodes and short verification codes. It reuses the Banhaten Input surface and typography while adding grouped slots, paste distribution, hidden form value, masking, custom length, and RTL-aware keyboard navigation.
|
|
4
|
+
|
|
5
|
+
## API
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
<InputOTP
|
|
9
|
+
label="Verification code"
|
|
10
|
+
length={6}
|
|
11
|
+
name="code"
|
|
12
|
+
onValueChange={setCode}
|
|
13
|
+
/>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
| Prop | Values |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| `value`, `defaultValue` | controlled or uncontrolled string |
|
|
19
|
+
| `length` | slot count |
|
|
20
|
+
| `groupPattern` | array of slot group sizes |
|
|
21
|
+
| `masked` | `boolean` |
|
|
22
|
+
| `variant` | `default`, `soft` |
|
|
23
|
+
| `size` | `md`, `lg` |
|
|
24
|
+
| `state` | `default`, `filled`, `error`, `disabled` |
|
|
25
|
+
|
|
26
|
+
## Token Contract
|
|
27
|
+
|
|
28
|
+
Input OTP uses Input field tokens for surfaces, typography, focus, border, error, helper text, labels, slot gaps, and disabled states.
|
|
29
|
+
|
|
30
|
+
## RTL
|
|
31
|
+
|
|
32
|
+
Slot groups inherit direction. Arrow navigation mirrors in RTL so visual previous and next follow the rendered direction.
|
|
33
|
+
|
|
34
|
+
## Accessibility
|
|
35
|
+
|
|
36
|
+
Provide a clear label and helper text describing how many digits are expected. The hidden form value lets the component participate in standard form submission.
|
|
37
|
+
|
|
38
|
+
## Install
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx banhaten add input-otp
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
Primary registry example: `examples/input-otp-demo.tsx`.
|
|
47
|
+
|
|
48
|
+
Open the live component page or run `npx banhaten docs input-otp` to inspect source files, install command, and examples.
|
|
49
|
+
|
|
50
|
+
## RTL Rules
|
|
51
|
+
|
|
52
|
+
- `inheritsDirection`: true
|
|
53
|
+
- `keyboard`: Arrow navigation mirrors for RTL: visual previous and next follow the inherited direction.
|
|
54
|
+
- `spacing`: Slot groups, separators, labels, and helper text use inherited direction plus Input spacing tokens.
|
|
55
|
+
- `composition`: Each slot reuses the Banhaten Input surface and control typography instead of a separate field style.
|
|
56
|
+
|
|
57
57
|
<!-- registry-contract:start -->
|
|
58
58
|
## Registry Contract
|
|
59
59
|
|