@brightlocal/ui-components 3.0.0 → 3.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/README.md +7 -1
- package/component-meta.json +749 -53
- package/deprecations.json +114 -4
- package/dist/accordion.cjs +1 -1
- package/dist/accordion.d.ts +36 -0
- package/dist/accordion.d.ts.map +1 -1
- package/dist/accordion.js +74 -61
- package/dist/alert-dialog.cjs +1 -1
- package/dist/alert-dialog.d.ts +32 -3
- package/dist/alert-dialog.d.ts.map +1 -1
- package/dist/alert-dialog.js +61 -58
- package/dist/alert.cjs +1 -1
- package/dist/alert.d.ts.map +1 -1
- package/dist/alert.js +58 -57
- package/dist/badge.cjs +1 -1
- package/dist/badge.d.ts +9 -0
- package/dist/badge.d.ts.map +1 -1
- package/dist/badge.js +50 -30
- package/dist/banner.cjs +1 -0
- package/dist/banner.d.ts +81 -0
- package/dist/banner.d.ts.map +1 -0
- package/dist/banner.js +176 -0
- package/dist/blocks/empty-state.cjs +1 -1
- package/dist/blocks/empty-state.d.ts +4 -3
- package/dist/blocks/empty-state.d.ts.map +1 -1
- package/dist/blocks/empty-state.js +50 -57
- package/dist/blocks/progress-state.d.ts +2 -2
- package/dist/blocks/sidebar.cjs +1 -1
- package/dist/blocks/sidebar.d.ts +17 -0
- package/dist/blocks/sidebar.d.ts.map +1 -1
- package/dist/blocks/sidebar.js +8 -2
- package/dist/brand-illustration-motif.d.ts +1 -1
- package/dist/button-group.cjs +1 -0
- package/dist/button-group.d.ts +36 -0
- package/dist/button-group.d.ts.map +1 -0
- package/dist/button-group.js +47 -0
- package/dist/button.cjs +1 -1
- package/dist/button.js +1 -1
- package/dist/card.cjs +1 -1
- package/dist/card.d.ts +105 -7
- package/dist/card.d.ts.map +1 -1
- package/dist/card.js +198 -101
- package/dist/chart.cjs +3 -3
- package/dist/chart.d.ts +270 -24
- package/dist/chart.d.ts.map +1 -1
- package/dist/chart.js +497 -322
- package/dist/checkbox.cjs +1 -1
- package/dist/checkbox.d.ts +1 -1
- package/dist/checkbox.d.ts.map +1 -1
- package/dist/checkbox.js +2 -1
- package/dist/chip.cjs +1 -1
- package/dist/chip.d.ts +38 -4
- package/dist/chip.d.ts.map +1 -1
- package/dist/chip.js +95 -81
- package/dist/combobox.cjs +1 -1
- package/dist/combobox.js +2 -2
- package/dist/command.cjs +1 -1
- package/dist/command.d.ts +23 -1
- package/dist/command.d.ts.map +1 -1
- package/dist/command.js +251 -225
- package/dist/data-table.cjs +1 -1
- package/dist/data-table.d.ts +201 -23
- package/dist/data-table.d.ts.map +1 -1
- package/dist/data-table.js +712 -568
- package/dist/date-picker.cjs +1 -1
- package/dist/date-picker.d.ts +13 -5
- package/dist/date-picker.d.ts.map +1 -1
- package/dist/date-picker.js +54 -53
- package/dist/field.cjs +1 -1
- package/dist/field.d.ts +8 -1
- package/dist/field.d.ts.map +1 -1
- package/dist/field.js +79 -52
- package/dist/global-layout.cjs +1 -1
- package/dist/global-layout.d.ts +105 -13
- package/dist/global-layout.d.ts.map +1 -1
- package/dist/global-layout.js +146 -129
- package/dist/grid.d.ts +26 -3
- package/dist/grid.d.ts.map +1 -1
- package/dist/hooks/use-breakpoint.cjs +1 -1
- package/dist/hooks/use-breakpoint.d.ts +1 -1
- package/dist/hooks/use-breakpoint.d.ts.map +1 -1
- package/dist/hooks/use-breakpoint.js +1 -0
- package/dist/hooks/use-mobile.cjs +1 -0
- package/dist/hooks/use-mobile.js +8 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +594 -553
- package/dist/info-tooltip.cjs +1 -0
- package/dist/info-tooltip.d.ts +39 -0
- package/dist/info-tooltip.d.ts.map +1 -0
- package/dist/info-tooltip.js +41 -0
- package/dist/input-chip.cjs +1 -1
- package/dist/input-chip.js +1 -1
- package/dist/input-group.cjs +1 -1
- package/dist/input-group.d.ts +33 -2
- package/dist/input-group.d.ts.map +1 -1
- package/dist/input-group.js +167 -54
- package/dist/input-otp.cjs +1 -1
- package/dist/input-otp.js +9 -9
- package/dist/input-password.cjs +1 -1
- package/dist/input-password.d.ts +45 -15
- package/dist/input-password.d.ts.map +1 -1
- package/dist/input-password.js +31 -30
- package/dist/input.cjs +1 -1
- package/dist/input.js +10 -10
- package/dist/lib/block-illustration.cjs +1 -1
- package/dist/lib/block-illustration.d.ts +4 -1
- package/dist/lib/block-illustration.d.ts.map +1 -1
- package/dist/lib/block-illustration.js +12 -11
- package/dist/lib/empty-chip.cjs +1 -0
- package/dist/lib/empty-chip.d.ts +4 -0
- package/dist/lib/empty-chip.d.ts.map +1 -0
- package/dist/lib/empty-chip.js +13 -0
- package/dist/lib/utils.cjs +1 -1
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +4 -3
- package/dist/list.cjs +1 -1
- package/dist/list.js +1 -1
- package/dist/multi-select-filter.cjs +1 -0
- package/dist/multi-select-filter.d.ts +178 -0
- package/dist/multi-select-filter.d.ts.map +1 -0
- package/dist/multi-select-filter.js +463 -0
- package/dist/pagination.cjs +1 -1
- package/dist/pagination.d.ts +3 -0
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +57 -57
- package/dist/progress.cjs +1 -1
- package/dist/progress.d.ts +123 -16
- package/dist/progress.d.ts.map +1 -1
- package/dist/progress.js +89 -75
- package/dist/rating.cjs +1 -1
- package/dist/rating.js +18 -18
- package/dist/relative-date.cjs +1 -0
- package/dist/relative-date.d.ts +65 -0
- package/dist/relative-date.d.ts.map +1 -0
- package/dist/relative-date.js +128 -0
- package/dist/scroll-area.cjs +1 -1
- package/dist/scroll-area.d.ts +15 -6
- package/dist/scroll-area.d.ts.map +1 -1
- package/dist/scroll-area.js +38 -36
- package/dist/select.cjs +2 -2
- package/dist/select.d.ts +24 -3
- package/dist/select.d.ts.map +1 -1
- package/dist/select.js +130 -110
- package/dist/sheet.cjs +1 -1
- package/dist/sheet.d.ts +78 -2
- package/dist/sheet.d.ts.map +1 -1
- package/dist/sheet.js +192 -85
- package/dist/single-select-filter.cjs +1 -0
- package/dist/single-select-filter.d.ts +81 -0
- package/dist/single-select-filter.d.ts.map +1 -0
- package/dist/single-select-filter.js +226 -0
- package/dist/sonner.cjs +1 -1
- package/dist/sonner.d.ts.map +1 -1
- package/dist/sonner.js +22 -22
- package/dist/split-layout.cjs +1 -1
- package/dist/split-layout.d.ts +1 -1
- package/dist/split-layout.js +13 -13
- package/dist/table.cjs +1 -1
- package/dist/table.d.ts +45 -4
- package/dist/table.d.ts.map +1 -1
- package/dist/table.js +90 -73
- package/dist/tabs.cjs +1 -1
- package/dist/tabs.d.ts +12 -1
- package/dist/tabs.d.ts.map +1 -1
- package/dist/tabs.js +148 -126
- package/dist/textarea.cjs +1 -1
- package/dist/textarea.js +1 -1
- package/dist/tooltip.cjs +1 -1
- package/dist/tooltip.d.ts +38 -36
- package/dist/tooltip.d.ts.map +1 -1
- package/dist/tooltip.js +262 -73
- package/dist/typography-heading.cjs +1 -1
- package/dist/typography-heading.d.ts +13 -0
- package/dist/typography-heading.d.ts.map +1 -1
- package/dist/typography-heading.js +32 -21
- package/dist/typography-text.cjs +1 -1
- package/dist/typography-text.d.ts +15 -2
- package/dist/typography-text.d.ts.map +1 -1
- package/dist/typography-text.js +35 -24
- package/dist/typography.d.ts +1 -1
- package/package.json +5 -6
- package/src/blocks/empty-state.tsx +17 -24
- package/src/blocks/progress-state.tsx +2 -2
- package/src/blocks/sidebar.tsx +26 -2
- package/src/components/accordion.tsx +82 -27
- package/src/components/alert-dialog.tsx +50 -5
- package/src/components/alert.tsx +16 -8
- package/src/components/badge.tsx +40 -3
- package/src/components/banner.tsx +288 -0
- package/src/components/brand-illustration-motif.tsx +1 -1
- package/src/components/button-group.tsx +112 -0
- package/src/components/button.tsx +1 -1
- package/src/components/card.tsx +249 -27
- package/src/components/chart.tsx +586 -53
- package/src/components/checkbox.tsx +1 -1
- package/src/components/chip.tsx +83 -10
- package/src/components/combobox.tsx +2 -2
- package/src/components/command.tsx +56 -4
- package/src/components/data-table.tsx +842 -199
- package/src/components/date-picker.tsx +18 -7
- package/src/components/field.tsx +81 -12
- package/src/components/global-layout.tsx +176 -38
- package/src/components/grid.tsx +34 -3
- package/src/components/info-tooltip.tsx +94 -0
- package/src/components/input-chip.tsx +1 -1
- package/src/components/input-group.tsx +246 -11
- package/src/components/input-otp.tsx +1 -1
- package/src/components/input-password.tsx +56 -22
- package/src/components/input.tsx +1 -1
- package/src/components/list.tsx +1 -1
- package/src/components/multi-select-filter.tsx +912 -0
- package/src/components/pagination.tsx +10 -3
- package/src/components/progress.tsx +190 -31
- package/src/components/rating.tsx +1 -1
- package/src/components/relative-date.tsx +230 -0
- package/src/components/scroll-area.tsx +23 -10
- package/src/components/select.tsx +65 -11
- package/src/components/sheet.tsx +240 -4
- package/src/components/single-select-filter.tsx +443 -0
- package/src/components/sonner.tsx +16 -5
- package/src/components/split-layout.tsx +2 -2
- package/src/components/table.tsx +71 -11
- package/src/components/tabs.tsx +93 -46
- package/src/components/textarea.tsx +1 -1
- package/src/components/tooltip.tsx +440 -68
- package/src/components/typography-heading.tsx +24 -0
- package/src/components/typography-text.tsx +27 -3
- package/src/components/typography.tsx +1 -1
- package/src/hooks/use-breakpoint.ts +2 -1
- package/src/index.ts +6 -0
- package/src/lib/block-illustration.tsx +5 -1
- package/src/lib/empty-chip.ts +24 -0
- package/src/lib/utils.ts +1 -0
package/component-meta.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brightlocal/ui-components",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"description": "Machine-readable registry of all components in the BrightLocal Design System",
|
|
5
5
|
"components": [
|
|
6
6
|
{
|
|
@@ -200,7 +200,12 @@
|
|
|
200
200
|
],
|
|
201
201
|
"compound": true,
|
|
202
202
|
"dataHookRequired": true,
|
|
203
|
-
"variants": {
|
|
203
|
+
"variants": {
|
|
204
|
+
"variant": [
|
|
205
|
+
"primary",
|
|
206
|
+
"destructive"
|
|
207
|
+
]
|
|
208
|
+
},
|
|
204
209
|
"props": [
|
|
205
210
|
"open",
|
|
206
211
|
"onOpenChange"
|
|
@@ -255,6 +260,12 @@
|
|
|
255
260
|
"export": "AlertDialog",
|
|
256
261
|
"note": "Draws the assembled dialog; all sub-parts are drawn inside",
|
|
257
262
|
"axes": [
|
|
263
|
+
{
|
|
264
|
+
"figma": "Variant",
|
|
265
|
+
"code": "variant",
|
|
266
|
+
"export": "AlertDialogAction",
|
|
267
|
+
"note": "Prop lives on AlertDialogAction; the set swaps the confirm Button instance to Primary/Destructive (DS-818)"
|
|
268
|
+
},
|
|
258
269
|
{
|
|
259
270
|
"figma": "Breakpoint",
|
|
260
271
|
"exempt": "figma-only-style",
|
|
@@ -290,7 +301,7 @@
|
|
|
290
301
|
},
|
|
291
302
|
{
|
|
292
303
|
"export": "AlertDialogAction",
|
|
293
|
-
"reason": "Drawn inside the set as a Button instance"
|
|
304
|
+
"reason": "Drawn inside the set as a Button instance; its variant prop is the set's Variant axis"
|
|
294
305
|
},
|
|
295
306
|
{
|
|
296
307
|
"export": "AlertDialogCancel",
|
|
@@ -427,7 +438,8 @@
|
|
|
427
438
|
]
|
|
428
439
|
},
|
|
429
440
|
"props": [
|
|
430
|
-
"asChild"
|
|
441
|
+
"asChild",
|
|
442
|
+
"srLabel"
|
|
431
443
|
],
|
|
432
444
|
"description": "Status badges and labels",
|
|
433
445
|
"aliases": [
|
|
@@ -488,8 +500,54 @@
|
|
|
488
500
|
],
|
|
489
501
|
"unmappedExports": [],
|
|
490
502
|
"figmaOnly": []
|
|
503
|
+
},
|
|
504
|
+
"i18nProps": {
|
|
505
|
+
"Badge": {
|
|
506
|
+
"srLabel": "string — no default; screen-reader phrase replacing a bare numeral (\"3 active\"); ignored with asChild"
|
|
507
|
+
}
|
|
491
508
|
}
|
|
492
509
|
},
|
|
510
|
+
{
|
|
511
|
+
"name": "Banner",
|
|
512
|
+
"import": "@brightlocal/ui-components/banner",
|
|
513
|
+
"category": "feedback",
|
|
514
|
+
"exports": [
|
|
515
|
+
"Banner",
|
|
516
|
+
"BannerIllustration",
|
|
517
|
+
"BannerContent",
|
|
518
|
+
"BannerTitle",
|
|
519
|
+
"BannerDescription",
|
|
520
|
+
"BannerActions"
|
|
521
|
+
],
|
|
522
|
+
"compound": true,
|
|
523
|
+
"dataHookRequired": true,
|
|
524
|
+
"variants": {
|
|
525
|
+
"variant": [
|
|
526
|
+
"sky",
|
|
527
|
+
"violet"
|
|
528
|
+
]
|
|
529
|
+
},
|
|
530
|
+
"props": [
|
|
531
|
+
"variant",
|
|
532
|
+
"onDismiss",
|
|
533
|
+
"dismissLabel"
|
|
534
|
+
],
|
|
535
|
+
"description": "Branded, dismissible invitation to an optional step — composed from BannerIllustration, BannerContent (BannerTitle, BannerDescription) and BannerActions on a highlight sky/violet surface",
|
|
536
|
+
"i18nProps": {
|
|
537
|
+
"Banner": {
|
|
538
|
+
"dismissLabel": "string — default: \"Dismiss\""
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
"whenToUse": [
|
|
542
|
+
"Inviting the user to an optional step that improves the page (connect an account, turn on two-factor authentication)",
|
|
543
|
+
"A one-off, dismissible nudge tied to the current page"
|
|
544
|
+
],
|
|
545
|
+
"doNotUseFor": [
|
|
546
|
+
"something that happened — a failure, a risk, a tip (use Alert)",
|
|
547
|
+
"brand statements or pull-quotes (use Callout)",
|
|
548
|
+
"feedback after an action (use a toast / Sonner)"
|
|
549
|
+
]
|
|
550
|
+
},
|
|
493
551
|
{
|
|
494
552
|
"name": "BrandIllustrationMotif",
|
|
495
553
|
"import": "@brightlocal/ui-components/brand-illustration-motif",
|
|
@@ -761,6 +819,48 @@
|
|
|
761
819
|
"figmaOnly": []
|
|
762
820
|
}
|
|
763
821
|
},
|
|
822
|
+
{
|
|
823
|
+
"name": "ButtonGroup",
|
|
824
|
+
"import": "@brightlocal/ui-components/button-group",
|
|
825
|
+
"category": "interactive",
|
|
826
|
+
"exports": [
|
|
827
|
+
"ButtonGroup",
|
|
828
|
+
"ButtonGroupSeparator"
|
|
829
|
+
],
|
|
830
|
+
"compound": true,
|
|
831
|
+
"dataHookRequired": true,
|
|
832
|
+
"variants": {},
|
|
833
|
+
"props": [],
|
|
834
|
+
"description": "Joins Buttons and a Select trigger into one attached control with merged borders",
|
|
835
|
+
"aliases": [
|
|
836
|
+
"button group",
|
|
837
|
+
"attached buttons",
|
|
838
|
+
"split button",
|
|
839
|
+
"segmented actions",
|
|
840
|
+
"run navigator"
|
|
841
|
+
],
|
|
842
|
+
"whenToUse": [
|
|
843
|
+
"Prev/next steppers attached around a Select (RunNavigator recipe)",
|
|
844
|
+
"A primary action with an attached menu trigger (SplitButton recipe)",
|
|
845
|
+
"A row of related actions that should read as one control"
|
|
846
|
+
],
|
|
847
|
+
"doNotUseFor": [
|
|
848
|
+
"on/off or single-choice selection (use ToggleGroup — it owns the selected state and keyboard model)",
|
|
849
|
+
"quick filters over a collection (use ToggleGroup, or Tabs variant=\"underline\" for a promoted tab row)",
|
|
850
|
+
"attaching icons or buttons to a text input (use InputGroup)"
|
|
851
|
+
],
|
|
852
|
+
"states": [
|
|
853
|
+
"default",
|
|
854
|
+
"hover",
|
|
855
|
+
"focus",
|
|
856
|
+
"disabled"
|
|
857
|
+
],
|
|
858
|
+
"a11yContract": [
|
|
859
|
+
"role=group on the container",
|
|
860
|
+
"icon-only child Buttons need aria-label",
|
|
861
|
+
"children keep their own focus order — no roving focus"
|
|
862
|
+
]
|
|
863
|
+
},
|
|
764
864
|
{
|
|
765
865
|
"name": "Calendar",
|
|
766
866
|
"import": "@brightlocal/ui-components/calendar",
|
|
@@ -879,7 +979,9 @@
|
|
|
879
979
|
"CardTitle",
|
|
880
980
|
"CardAction",
|
|
881
981
|
"CardDescription",
|
|
982
|
+
"CardToolbar",
|
|
882
983
|
"CardMedia",
|
|
984
|
+
"CardMetric",
|
|
883
985
|
"CardContent"
|
|
884
986
|
],
|
|
885
987
|
"compound": true,
|
|
@@ -893,7 +995,8 @@
|
|
|
893
995
|
],
|
|
894
996
|
"density": [
|
|
895
997
|
"default",
|
|
896
|
-
"condensed"
|
|
998
|
+
"condensed",
|
|
999
|
+
"data"
|
|
897
1000
|
],
|
|
898
1001
|
"align": [
|
|
899
1002
|
"left",
|
|
@@ -904,7 +1007,7 @@
|
|
|
904
1007
|
"props": [
|
|
905
1008
|
"maxWidth"
|
|
906
1009
|
],
|
|
907
|
-
"description": "Content container with consistent styling. Full-width by default — constrain width via className (e.g., className='max-w-sm'). Supports a density prop: 'default' uses generous spacing (gap-8, py-section-md, px-section-md) for standalone cards; 'condensed' uses compact spacing (gap-3, py-3, px-3) for cards nested inside other cards as sub-sections, inline stat panels, or dense dashboard widgets.",
|
|
1010
|
+
"description": "Content container with consistent styling. Full-width by default — constrain width via className (e.g., className='max-w-sm'). Supports a density prop: 'default' uses generous spacing (gap-8, py-section-md, px-section-md) for standalone cards; 'condensed' uses compact spacing (gap-3, py-3, px-3) for cards nested inside other cards as sub-sections, inline stat panels, or dense dashboard widgets; 'data' uses the report-page scale (DS-989): fixed 24px horizontal padding, a header with 16px vertical padding, 24px section spacing below it (pair with CardTitle size='small'). CardHeader's divider prop closes the header with its own full-width bottom border in every density — the header pads its bottom by the density's spacing, and flush content right after sits on the line. variant='border' uses the card surface (bg-card: white in light mode, neutral-900 in dark) so it lifts off the off-white page; variant='filled' uses the muted fill (bg-muted). For cards carrying a filter row and a data view. CardContent accepts a flush prop for edge-to-edge tables/maps inside a filled or border card (the card keeps its surface and border). CardToolbar puts the filter row (search — Input, InputGroup or DataTableSearch — capped at 360px, then filters, 8px gap; styles direct children only) in the header, for everything that narrows what the card shows; pagination stays in a DataTableToolbar beside the table; CardMetric shows a value + trend badge opposite the title. CardHeader takes align ('left' | 'center' | 'right') for header layout; CardDescription takes its own align with the same values to pin the description's text alignment when it would otherwise inherit it (e.g. centred inside a button trigger) — omitted, it inherits as before. CardHeader's sticky prop pins the header while a tall card scrolls (top offset --ds-section-padding-y-sm: 16px mobile, 24px from xl), painting the card's surface so content never shows through.",
|
|
908
1011
|
"aliases": [
|
|
909
1012
|
"container",
|
|
910
1013
|
"panel",
|
|
@@ -916,7 +1019,8 @@
|
|
|
916
1019
|
"Putting a box around related content (form section, detail panel, stat summary)",
|
|
917
1020
|
"Dashboard widgets or sections separated from the page background",
|
|
918
1021
|
"Grouping content without a visible boundary (Transparent variant)",
|
|
919
|
-
"Full-bleed edge-to-edge media (Transparent Flush variant)"
|
|
1022
|
+
"Full-bleed edge-to-edge media (Transparent Flush variant)",
|
|
1023
|
+
"Report-page cards with filter rows, header metrics and edge-to-edge data views (density='data', CardToolbar, CardMetric, CardContent flush)"
|
|
920
1024
|
],
|
|
921
1025
|
"knownGaps": [],
|
|
922
1026
|
"doNotUseFor": [
|
|
@@ -1004,6 +1108,14 @@
|
|
|
1004
1108
|
{
|
|
1005
1109
|
"export": "CardAction",
|
|
1006
1110
|
"reason": "No Figma representation found (2026-08-13) — candidate designer task at rollout"
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"export": "CardToolbar",
|
|
1114
|
+
"reason": "Drawn as the 'Toolbar Slot' SLOT property on the Card set in the DS-989 Figma branch (gQkQkqVsqDRzJpkbMHR5S7); map via /figma-map Card after the branch merges (FIG-28)"
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"export": "CardMetric",
|
|
1118
|
+
"reason": "Drawn as the 'Card Metric' component on the DS-989 Figma branch; map via /figma-map Card after the branch merges (FIG-28)"
|
|
1007
1119
|
}
|
|
1008
1120
|
],
|
|
1009
1121
|
"figmaOnly": [
|
|
@@ -1219,6 +1331,8 @@
|
|
|
1219
1331
|
"ChartTooltipContent",
|
|
1220
1332
|
"ChartLegend",
|
|
1221
1333
|
"ChartLegendContent",
|
|
1334
|
+
"ChartLegendList",
|
|
1335
|
+
"ChartLegendItem",
|
|
1222
1336
|
"ChartStyle",
|
|
1223
1337
|
"ChartDot",
|
|
1224
1338
|
"ChartDotOnStroke",
|
|
@@ -1231,7 +1345,16 @@
|
|
|
1231
1345
|
],
|
|
1232
1346
|
"compound": true,
|
|
1233
1347
|
"dataHookRequired": true,
|
|
1234
|
-
"variants": {
|
|
1348
|
+
"variants": {
|
|
1349
|
+
"orientation": [
|
|
1350
|
+
"horizontal",
|
|
1351
|
+
"vertical"
|
|
1352
|
+
],
|
|
1353
|
+
"size": [
|
|
1354
|
+
"sm",
|
|
1355
|
+
"md"
|
|
1356
|
+
]
|
|
1357
|
+
},
|
|
1235
1358
|
"props": [
|
|
1236
1359
|
"config",
|
|
1237
1360
|
"id"
|
|
@@ -1239,7 +1362,23 @@
|
|
|
1239
1362
|
"hooks": [
|
|
1240
1363
|
"useChart"
|
|
1241
1364
|
],
|
|
1242
|
-
"description": "Data visualization wrapper for Recharts",
|
|
1365
|
+
"description": "Data visualization wrapper for Recharts. Legends are composable: ChartLegendContent renders Recharts' payload inside a chart (with sortBy, showValue/valueKey, renderItem); ChartLegendList + ChartLegendItem compose a legend beside a chart — vertical with values next to a donut, shared across charts, or a row of toggles/popover triggers via asChild. size sm (12px chart chrome, default) or md (14px key read as content, 10px swatch). Item states: muted = de-emphasised but still drawn (a filter focused elsewhere); hidden = switched off, faded + struck label, never colour alone.",
|
|
1366
|
+
"i18nProps": {
|
|
1367
|
+
"ChartLegendList": {
|
|
1368
|
+
"ariaLabel": "string — default: \"Chart legend\""
|
|
1369
|
+
},
|
|
1370
|
+
"ChartLegendContent": {
|
|
1371
|
+
"ariaLabel": "string — default: \"Chart legend\""
|
|
1372
|
+
}
|
|
1373
|
+
},
|
|
1374
|
+
"aliases": [
|
|
1375
|
+
"chart legend",
|
|
1376
|
+
"chart key",
|
|
1377
|
+
"vertical legend",
|
|
1378
|
+
"legend beside chart",
|
|
1379
|
+
"interactive legend",
|
|
1380
|
+
"legend with values"
|
|
1381
|
+
],
|
|
1243
1382
|
"figma": {
|
|
1244
1383
|
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
1245
1384
|
"status": "code-only",
|
|
@@ -1249,7 +1388,8 @@
|
|
|
1249
1388
|
"Trends over time (Line), or trends emphasizing total volume underneath (Area)",
|
|
1250
1389
|
"Comparing a few categories or rankings (Bar)",
|
|
1251
1390
|
"Part-of-whole proportions with 5 or fewer categories (Pie)",
|
|
1252
|
-
"Multi-measure profiles of one or two items (Radar), or a single percentage/progress value as a circular tile (Radial Bar)"
|
|
1391
|
+
"Multi-measure profiles of one or two items (Radar), or a single percentage/progress value as a circular tile (Radial Bar)",
|
|
1392
|
+
"A legend beside the plot or shared by several charts: ChartLegendList + ChartLegendItem (orientation=\"vertical\" with values; asChild makes an item a popover trigger or an aria-pressed toggle)"
|
|
1253
1393
|
],
|
|
1254
1394
|
"doNotUseFor": [
|
|
1255
1395
|
"exact values users must read precisely (pair with or use Table/DataTable)",
|
|
@@ -1298,7 +1438,8 @@
|
|
|
1298
1438
|
"import": "@brightlocal/ui-components/checkbox",
|
|
1299
1439
|
"category": "form",
|
|
1300
1440
|
"exports": [
|
|
1301
|
-
"Checkbox"
|
|
1441
|
+
"Checkbox",
|
|
1442
|
+
"checkboxVariants"
|
|
1302
1443
|
],
|
|
1303
1444
|
"compound": false,
|
|
1304
1445
|
"dataHookRequired": true,
|
|
@@ -1319,7 +1460,7 @@
|
|
|
1319
1460
|
"turning a system feature or state on or off (use Switch)",
|
|
1320
1461
|
"single-choice selection from a list (use RadioGroup)",
|
|
1321
1462
|
"pressed-button toolbar controls (use Toggle)",
|
|
1322
|
-
"more than ~7 options (use
|
|
1463
|
+
"more than ~7 options (use MultiSelectFilter)"
|
|
1323
1464
|
],
|
|
1324
1465
|
"replaces": [
|
|
1325
1466
|
"native <input type='checkbox'>"
|
|
@@ -1346,6 +1487,11 @@
|
|
|
1346
1487
|
"kind": "componentSet",
|
|
1347
1488
|
"export": "Checkbox",
|
|
1348
1489
|
"axes": [
|
|
1490
|
+
{
|
|
1491
|
+
"figma": "Variant",
|
|
1492
|
+
"exempt": "figma-only-style",
|
|
1493
|
+
"note": "Simple|Box draws the Field variant=\"box\" composition (DS-572/DS-576) — `box` is a Field prop, not a Checkbox prop"
|
|
1494
|
+
},
|
|
1349
1495
|
{
|
|
1350
1496
|
"figma": "Status",
|
|
1351
1497
|
"exempt": "interaction-state",
|
|
@@ -1366,7 +1512,12 @@
|
|
|
1366
1512
|
]
|
|
1367
1513
|
}
|
|
1368
1514
|
],
|
|
1369
|
-
"unmappedExports": [
|
|
1515
|
+
"unmappedExports": [
|
|
1516
|
+
{
|
|
1517
|
+
"export": "checkboxVariants",
|
|
1518
|
+
"reason": "cva style helper (the Checkbox look for presentational check marks, e.g. MultiSelectFilter's option rows), not a component"
|
|
1519
|
+
}
|
|
1520
|
+
],
|
|
1370
1521
|
"figmaOnly": []
|
|
1371
1522
|
},
|
|
1372
1523
|
"whenToUse": [
|
|
@@ -1399,7 +1550,8 @@
|
|
|
1399
1550
|
"i18nProps": {
|
|
1400
1551
|
"Chip": {
|
|
1401
1552
|
"loadingLabel": "string — default: \"Loading\"",
|
|
1402
|
-
"removeAriaLabel": "string — default: \"Remove {name}\""
|
|
1553
|
+
"removeAriaLabel": "string — default: \"Remove {name}\"",
|
|
1554
|
+
"removableAriaLabel": "string — default: \"{name}, press Delete to remove\""
|
|
1403
1555
|
}
|
|
1404
1556
|
},
|
|
1405
1557
|
"description": "Removable chip/tag element",
|
|
@@ -1543,7 +1695,7 @@
|
|
|
1543
1695
|
"short lists under 10 items (use Select)",
|
|
1544
1696
|
"free-text values not on the list (use InputChip)",
|
|
1545
1697
|
"options that should all be visible for comparison (use RadioGroup or ToggleGroup)",
|
|
1546
|
-
"picking several values at once — Combobox is single-value by design (use
|
|
1698
|
+
"picking several values at once — Combobox is single-value by design (use MultiSelectFilter)"
|
|
1547
1699
|
],
|
|
1548
1700
|
"alternatives": [
|
|
1549
1701
|
{
|
|
@@ -1991,6 +2143,8 @@
|
|
|
1991
2143
|
"getRowClassName",
|
|
1992
2144
|
"renderExpandedContent",
|
|
1993
2145
|
"isLoading",
|
|
2146
|
+
"refetching",
|
|
2147
|
+
"refetchingLabel",
|
|
1994
2148
|
"skeletonRowCount",
|
|
1995
2149
|
"noResultsMessage",
|
|
1996
2150
|
"layout",
|
|
@@ -2003,7 +2157,8 @@
|
|
|
2003
2157
|
"i18nProps": {
|
|
2004
2158
|
"DataTable": {
|
|
2005
2159
|
"scrollRegionLabel": "string — default: \"Scrollable table\"",
|
|
2006
|
-
"noResultsMessage": "string — default: \"No results.\""
|
|
2160
|
+
"noResultsMessage": "string — default: \"No results.\"",
|
|
2161
|
+
"refetchingLabel": "string — default: \"Loading results…\""
|
|
2007
2162
|
},
|
|
2008
2163
|
"DataTableColumnHeader": {
|
|
2009
2164
|
"getSortLabel": "(title: string, direction: \"asc\" | \"desc\" | false) => string"
|
|
@@ -2040,7 +2195,7 @@
|
|
|
2040
2195
|
"children": "React.ReactNode | ((info: { selectedCount: number; totalCount: number }) => React.ReactNode) — default: \"{selectedCount} of {totalCount} row(s) selected.\""
|
|
2041
2196
|
}
|
|
2042
2197
|
},
|
|
2043
|
-
"description": "Composable data table built on TanStack Table. Exposes `useDataTable` hook + `DataTable` / `VirtualizedDataTable` renderers + toolbar layout + pagination and search helpers. Compose the table and its companions (DataTableToolbar rows, bulk actions) as ONE slot — a single flex-column wrapper — inside gapped parents like DialogContent or Card, so the parent's gap applies around the table block, not between the toolbars and the table; the toolbars' built-in padding provides the internal spacing. noResultsMessage accepts a ReactNode as well as a string: pass an EmptyState for a collection that is empty, and keep a one-line string for a collection that is merely filtered — the reader typed the query and wants its outcome, not an onboarding block. The cell is a polite live region either way.",
|
|
2198
|
+
"description": "Composable data table built on TanStack Table. Exposes `useDataTable` hook + `DataTable` / `VirtualizedDataTable` renderers + toolbar layout + pagination and search helpers. Compose the table and its companions (DataTableToolbar rows, bulk actions) as ONE slot — a single flex-column wrapper — inside gapped parents like DialogContent or Card, so the parent's gap applies around the table block, not between the toolbars and the table; the toolbars' built-in padding provides the internal spacing. noResultsMessage accepts a ReactNode as well as a string: pass an EmptyState for a collection that is empty, and keep a one-line string for a collection that is merely filtered — the reader typed the query and wants its outcome, not an onboarding block. The cell is a polite live region either way. The component's outer wrapper is its single scroll container for both axes (DS-912): bound the height through className (`max-h-*` for a fixed cap, `min-h-0 flex-1` inside a height-capped parent like a dialog body) and stickyHeader keeps the column headers pinned while the rows scroll — no internal slot targeting needed. With stickyHeader, minWidth, or scrollRegionLabel set (and always on VirtualizedDataTable) the wrapper is a focusable scroll region (role=region + tabIndex, labelled by scrollRegionLabel) so keyboard users can scroll the rows — pass scrollRegionLabel to opt in when the height is capped via className with the header deliberately left unpinned.",
|
|
2044
2199
|
"figma": {
|
|
2045
2200
|
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
2046
2201
|
"status": "code-only",
|
|
@@ -2056,6 +2211,13 @@
|
|
|
2056
2211
|
"simple read-only data with no sorting/filtering (use Table)",
|
|
2057
2212
|
"1,000+ rows with the standard renderer (use VirtualizedDataTable)",
|
|
2058
2213
|
"simple visual lists of items with icons and actions (use List)"
|
|
2214
|
+
],
|
|
2215
|
+
"knownGaps": [
|
|
2216
|
+
{
|
|
2217
|
+
"description": "A height bound set through className without stickyHeader scrolls vertically but is not keyboard-focusable — the component cannot inspect className, so the focusable scroll-region semantics are gated on stickyHeader (or minWidth)",
|
|
2218
|
+
"ticket": "DS-912",
|
|
2219
|
+
"workaround": "Set stickyHeader on height-capped tables (almost always wanted anyway); if the header must scroll away, own the scrolling yourself: wrap the table in your own max-h-* overflow-y-auto container carrying role=\"region\", an aria-label, and tabIndex={0} (arrow keys only scroll the focused element or an ancestor, so the semantics must sit on the element that scrolls), and leave className un-capped"
|
|
2220
|
+
}
|
|
2059
2221
|
]
|
|
2060
2222
|
},
|
|
2061
2223
|
{
|
|
@@ -2063,11 +2225,12 @@
|
|
|
2063
2225
|
"import": "@brightlocal/ui-components/date-picker",
|
|
2064
2226
|
"category": "form",
|
|
2065
2227
|
"exports": [
|
|
2066
|
-
"
|
|
2228
|
+
"DatePicker",
|
|
2067
2229
|
"DatePickerTrigger",
|
|
2068
2230
|
"DatePickerContent",
|
|
2069
2231
|
"DatePickerCalendar",
|
|
2070
|
-
"DatePickerPresets"
|
|
2232
|
+
"DatePickerPresets",
|
|
2233
|
+
"DatePickerRoot"
|
|
2071
2234
|
],
|
|
2072
2235
|
"compound": true,
|
|
2073
2236
|
"dataHookRequired": true,
|
|
@@ -2101,7 +2264,7 @@
|
|
|
2101
2264
|
"nodeId": "334:4051",
|
|
2102
2265
|
"figmaName": "Date Picker",
|
|
2103
2266
|
"kind": "componentSet",
|
|
2104
|
-
"export": "
|
|
2267
|
+
"export": "DatePicker",
|
|
2105
2268
|
"note": "Draws the closed field with label/description scaffolding. Code's `mode` variant (single|range) has no axis here — the range panel is drawn as the separate 'Date Picker / Range' set (see figmaOnly).",
|
|
2106
2269
|
"axes": [
|
|
2107
2270
|
{
|
|
@@ -2137,13 +2300,17 @@
|
|
|
2137
2300
|
{
|
|
2138
2301
|
"export": "DatePickerCalendar",
|
|
2139
2302
|
"reason": "An instance of the Calendar component inside the panel (Calendar is mapped separately)"
|
|
2303
|
+
},
|
|
2304
|
+
{
|
|
2305
|
+
"export": "DatePickerRoot",
|
|
2306
|
+
"reason": "Deprecated alias of DatePicker (DS-853)"
|
|
2140
2307
|
}
|
|
2141
2308
|
],
|
|
2142
2309
|
"figmaOnly": [
|
|
2143
2310
|
{
|
|
2144
2311
|
"nodeId": "247:3751",
|
|
2145
2312
|
"figmaName": "Date Picker / Range",
|
|
2146
|
-
"reason": "Range-mode panel drawn as a separate set (code expresses mode=range on
|
|
2313
|
+
"reason": "Range-mode panel drawn as a separate set (code expresses mode=range on DatePicker); its Size md|sm axis is Figma-only"
|
|
2147
2314
|
},
|
|
2148
2315
|
{
|
|
2149
2316
|
"nodeId": "244:3640",
|
|
@@ -2611,6 +2778,286 @@
|
|
|
2611
2778
|
"Menus discoverable by clicking rather than right-click or hover"
|
|
2612
2779
|
]
|
|
2613
2780
|
},
|
|
2781
|
+
{
|
|
2782
|
+
"name": "MultiSelectFilter",
|
|
2783
|
+
"import": "@brightlocal/ui-components/multi-select-filter",
|
|
2784
|
+
"category": "form",
|
|
2785
|
+
"exports": [
|
|
2786
|
+
"MultiSelectFilter",
|
|
2787
|
+
"multiSelectFilterTriggerVariants"
|
|
2788
|
+
],
|
|
2789
|
+
"compound": false,
|
|
2790
|
+
"dataHookRequired": true,
|
|
2791
|
+
"variants": {
|
|
2792
|
+
"size": [
|
|
2793
|
+
"default",
|
|
2794
|
+
"sm"
|
|
2795
|
+
]
|
|
2796
|
+
},
|
|
2797
|
+
"props": [
|
|
2798
|
+
"label",
|
|
2799
|
+
"options",
|
|
2800
|
+
"value",
|
|
2801
|
+
"defaultValue",
|
|
2802
|
+
"onValueChange",
|
|
2803
|
+
"open",
|
|
2804
|
+
"onOpenChange",
|
|
2805
|
+
"icon",
|
|
2806
|
+
"maxVisibleLabels",
|
|
2807
|
+
"allLabel",
|
|
2808
|
+
"allCount",
|
|
2809
|
+
"searchThreshold",
|
|
2810
|
+
"searchable",
|
|
2811
|
+
"disabled",
|
|
2812
|
+
"presentation",
|
|
2813
|
+
"collapseFullSelection",
|
|
2814
|
+
"allIcon"
|
|
2815
|
+
],
|
|
2816
|
+
"description": "The Filtering pattern's faceted multi-select: one dimension, several values combining as OR, over a Popover + Command menu that stays open across picks. The trigger hugs its label in a toolbar and wears the Select field look (border, radius, focus ring, chevron) because a filter trigger holds a value, it does not act; stacked in a panel it takes className='w-full'. No error state — a filter does not validate. size='default' (h-9, text-field like Select: 14px desktop / 16px touch) or 'sm' (h-8, text-label, phone card headers). The trigger always reads its picks, like a Select shows its value: allLabel at zero (or the dimension's label, muted, as a placeholder), then the picked labels, collapsing past maxVisibleLabels (default 1) into summaryLabel ('Google +2' via the default '{labels} +{rest}'; '3 selected' via '{count} selected') — and it computes the accessible name itself with every pick spelled out. Glyphs are the consumer's, never a fixed funnel: option.icon shows before each label in the menu and drawer, allIcon marks the All row, and the trigger follows the selection (allIcon at zero, then the first pick's icon) unless icon pins one. No-match shows the compact empty form (muted chip, emptyLabel, emptyDescription) in both presentations. allLabel adds a leading reset row: 'All' means no narrowing, so it is checked when value is empty and picking it clears the selection; a pick that completes the set collapses to [] for the same reason (collapseFullSelection, default true). Picks read on the trigger in pick order. Selected values pin to the top on reopen; a zero-count option is disabled, never hidden; past searchThreshold (10) the menu grows an autofocused search input (searchable forces it) — a case-insensitive substring match on label and value, never on the count; while searching the All row and Clear step aside, and a no-match search shows emptyLabel alone. presentation='menu' (default) is the Popover + Command menu; 'drawer' is the phone form — the same trigger opens a bottom Drawer titled with the dimension, All row, options as Checkboxes in two columns, search past the threshold, Clear while something is picked, a Done button that only closes (ticks apply at once); 'auto' switches at the md breakpoint. Both render from one state. Per-filter commit model: onValueChange on every pick, run an expensive refetch on onOpenChange(false). multiSelectFilterTriggerVariants is exported for the 'Filters (n)' recipe — a trigger that opens a Sheet or Drawer of hidden filters, with a Badge srLabel count.",
|
|
2817
|
+
"i18nProps": {
|
|
2818
|
+
"MultiSelectFilter": {
|
|
2819
|
+
"clearLabel": "string — default: \"Clear filters\"",
|
|
2820
|
+
"summaryLabel": "string — default: \"{labels} +{rest}\" (placeholders: {labels}, {rest}, {count})",
|
|
2821
|
+
"searchPlaceholder": "string — default: \"Search options...\"",
|
|
2822
|
+
"emptyLabel": "string — default: \"No options found.\"",
|
|
2823
|
+
"doneLabel": "string — default: \"Done\" (the drawer's close button)",
|
|
2824
|
+
"drawerDescription": "string — default: \"Picks apply as you make them.\" (sr-only drawer description)",
|
|
2825
|
+
"emptyDescription": "string — default: \"Try another search.\" (hint under the no-match message)",
|
|
2826
|
+
"clearSearchAriaLabel": "string — default: \"Clear search\" (the menu search input's clear button; the drawer search has none)"
|
|
2827
|
+
}
|
|
2828
|
+
},
|
|
2829
|
+
"whenToUse": [
|
|
2830
|
+
"Picking several values from one dimension that combine as OR (status, source, city) in a filter bar",
|
|
2831
|
+
"A filter whose trigger reads its current picks ('All sources', 'Google +2') like a Select shows its value, with every pick in the accessible name",
|
|
2832
|
+
"Stacked in a filter panel or sidebar — className='w-full' takes the row's width; same component, no form-field variant",
|
|
2833
|
+
"Any option list past ~10 values — the menu's autofocused search input and pinned selections handle it",
|
|
2834
|
+
"Desktop: presentation='menu' (default), the Popover + Command menu beside a Select in a toolbar (size='default', h-9, text-field)",
|
|
2835
|
+
"Phone: presentation='drawer' opens the same picks as a bottom Drawer (Checkbox rows in two columns, search past the threshold, Clear, Done only closes); presentation='auto' switches at the md breakpoint; size='sm' (h-8) for card headers — no hand-rolled drawer per filter"
|
|
2836
|
+
],
|
|
2837
|
+
"doNotUseFor": [
|
|
2838
|
+
"picking exactly one value from a filter dimension (use SingleSelectFilter — it shares the trigger look and the drawer, with a DS Select on desktop and RadioGroup in the drawer)",
|
|
2839
|
+
"2–5 values with room to show them all (use ToggleGroup, or the Lab SegmentedControl quick filter)",
|
|
2840
|
+
"typing new values into the selection (use InputChip)",
|
|
2841
|
+
"a form field that validates and submits — this is a filter and has no error state; a form multi-select is a separate component",
|
|
2842
|
+
"the 'Filters (n)' trigger that opens a panel of hidden filters — compose a button with multiSelectFilterTriggerVariants and a Badge srLabel count instead",
|
|
2843
|
+
"a batch drawer of several filters behind one Apply — the Filtering page's MobileFilterDrawer recipe (Drawer + the trigger style), not one MultiSelectFilter"
|
|
2844
|
+
],
|
|
2845
|
+
"alternatives": [
|
|
2846
|
+
{
|
|
2847
|
+
"component": "Select",
|
|
2848
|
+
"rule": "Use Select for a single choice from a short, known list"
|
|
2849
|
+
},
|
|
2850
|
+
{
|
|
2851
|
+
"component": "Combobox",
|
|
2852
|
+
"rule": "Use Combobox for a single choice from a long, searchable list — it is single-value by design"
|
|
2853
|
+
},
|
|
2854
|
+
{
|
|
2855
|
+
"component": "ToggleGroup",
|
|
2856
|
+
"rule": "Use ToggleGroup (or the Lab SegmentedControl) for a quick filter kept visible in the bar"
|
|
2857
|
+
},
|
|
2858
|
+
{
|
|
2859
|
+
"component": "InputChip",
|
|
2860
|
+
"rule": "Use InputChip when the person types new values rather than picking existing ones"
|
|
2861
|
+
},
|
|
2862
|
+
{
|
|
2863
|
+
"component": "Drawer",
|
|
2864
|
+
"rule": "Use Drawer with multiSelectFilterTriggerVariants for a batch panel of several filters on a phone (MobileFilterDrawer recipe); a single filter's phone form is presentation='drawer' on MultiSelectFilter itself"
|
|
2865
|
+
},
|
|
2866
|
+
{
|
|
2867
|
+
"component": "Chip",
|
|
2868
|
+
"rule": "Use Chip for the applied-filter tokens that show what a MultiSelectFilter has picked"
|
|
2869
|
+
},
|
|
2870
|
+
{
|
|
2871
|
+
"component": "SingleSelectFilter",
|
|
2872
|
+
"rule": "Use SingleSelectFilter for one value from a dimension — it shares the trigger look and the drawer, with a DS Select on desktop"
|
|
2873
|
+
}
|
|
2874
|
+
],
|
|
2875
|
+
"figma": {
|
|
2876
|
+
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
2877
|
+
"nodes": [
|
|
2878
|
+
{
|
|
2879
|
+
"nodeId": "34233:70287",
|
|
2880
|
+
"figmaName": "Multi Select Filter",
|
|
2881
|
+
"kind": "componentSet",
|
|
2882
|
+
"export": "MultiSelectFilter",
|
|
2883
|
+
"note": "Built on branch task/DS-1023-faced-filter (2026-10-08); node ids persist on merge. Draws the trigger (Text, Show Icon + Icon swap); the menu is the figmaOnly sub-parts below.",
|
|
2884
|
+
"axes": [
|
|
2885
|
+
{
|
|
2886
|
+
"figma": "Size",
|
|
2887
|
+
"code": "size"
|
|
2888
|
+
},
|
|
2889
|
+
{
|
|
2890
|
+
"figma": "State",
|
|
2891
|
+
"exempt": "interaction-state",
|
|
2892
|
+
"valueToProp": {
|
|
2893
|
+
"Disabled": "disabled"
|
|
2894
|
+
},
|
|
2895
|
+
"note": "Focus and Open are runtime states"
|
|
2896
|
+
}
|
|
2897
|
+
]
|
|
2898
|
+
}
|
|
2899
|
+
],
|
|
2900
|
+
"unmappedExports": [
|
|
2901
|
+
{
|
|
2902
|
+
"export": "multiSelectFilterTriggerVariants",
|
|
2903
|
+
"reason": "cva style helper for the 'Filters (n)' recipe, not a component — the Multi Select Filter set's variants are its drawing"
|
|
2904
|
+
}
|
|
2905
|
+
],
|
|
2906
|
+
"figmaOnly": [
|
|
2907
|
+
{
|
|
2908
|
+
"nodeId": "34233:70355",
|
|
2909
|
+
"figmaName": "Multi Select Filter / Menu Item",
|
|
2910
|
+
"reason": "The menu row MultiSelectFilter renders internally (CommandItem + Checkbox look + count); no sub-part export by design — one component, one engine. Checked/State are runtime states."
|
|
2911
|
+
},
|
|
2912
|
+
{
|
|
2913
|
+
"nodeId": "34233:70435",
|
|
2914
|
+
"figmaName": "Multi Select Filter / Menu",
|
|
2915
|
+
"reason": "The Popover + Command menu MultiSelectFilter renders internally (search, All row, options, empty, Clear); no sub-part export by design."
|
|
2916
|
+
}
|
|
2917
|
+
]
|
|
2918
|
+
},
|
|
2919
|
+
"aliases": [
|
|
2920
|
+
"faceted filter",
|
|
2921
|
+
"facet filter",
|
|
2922
|
+
"multi-select",
|
|
2923
|
+
"multi select dropdown",
|
|
2924
|
+
"filter dropdown",
|
|
2925
|
+
"checkbox filter",
|
|
2926
|
+
"filter menu",
|
|
2927
|
+
"mobile filter drawer"
|
|
2928
|
+
],
|
|
2929
|
+
"replaces": [
|
|
2930
|
+
"Lab FacetedFilter",
|
|
2931
|
+
"Lab SearchableMultiSelect",
|
|
2932
|
+
"Lab FilterTrigger (as multiSelectFilterTriggerVariants + Badge srLabel)",
|
|
2933
|
+
"per-app faceted-filter copies in the prototypes"
|
|
2934
|
+
],
|
|
2935
|
+
"states": [
|
|
2936
|
+
"closed",
|
|
2937
|
+
"open (menu)",
|
|
2938
|
+
"open (drawer)",
|
|
2939
|
+
"searching",
|
|
2940
|
+
"no match",
|
|
2941
|
+
"disabled"
|
|
2942
|
+
],
|
|
2943
|
+
"a11yContract": {
|
|
2944
|
+
"role": "button (trigger, aria-label computed: '{label}: {every pick}') → Popover with a cmdk listbox of aria-checked options, or a Drawer dialog titled with the dimension",
|
|
2945
|
+
"requiresLabel": true,
|
|
2946
|
+
"keyboardInteraction": [
|
|
2947
|
+
"Enter/Space opens",
|
|
2948
|
+
"Arrow keys move between options (cmdk root takes focus when there is no search input)",
|
|
2949
|
+
"Enter toggles the highlighted option; the menu stays open",
|
|
2950
|
+
"Type to narrow past the search threshold",
|
|
2951
|
+
"Escape closes and returns focus to the trigger"
|
|
2952
|
+
]
|
|
2953
|
+
},
|
|
2954
|
+
"knownGaps": [
|
|
2955
|
+
{
|
|
2956
|
+
"description": "The trigger hugs its text, so its width moves with the reading ('All sources' → 'Google' → 'Google +2'); Select solves this with reserveValues, MultiSelectFilter does not yet",
|
|
2957
|
+
"workaround": "Keep maxVisibleLabels at its default of 1; where neighbours must not shift, add className='min-w-40' (a layout class) sized to the dimension's longest label"
|
|
2958
|
+
},
|
|
2959
|
+
{
|
|
2960
|
+
"description": "Picks apply at once in both presentations — there is no batch/Apply mode on a single filter",
|
|
2961
|
+
"workaround": "A batch drawer of several filters is the Filtering page's MobileFilterDrawer recipe (Drawer + multiSelectFilterTriggerVariants), to be packaged as a FilterDrawer block"
|
|
2962
|
+
}
|
|
2963
|
+
]
|
|
2964
|
+
},
|
|
2965
|
+
{
|
|
2966
|
+
"name": "SingleSelectFilter",
|
|
2967
|
+
"import": "@brightlocal/ui-components/single-select-filter",
|
|
2968
|
+
"category": "form",
|
|
2969
|
+
"exports": [
|
|
2970
|
+
"SingleSelectFilter"
|
|
2971
|
+
],
|
|
2972
|
+
"compound": false,
|
|
2973
|
+
"dataHookRequired": true,
|
|
2974
|
+
"variants": {
|
|
2975
|
+
"size": [
|
|
2976
|
+
"default",
|
|
2977
|
+
"sm"
|
|
2978
|
+
],
|
|
2979
|
+
"presentation": [
|
|
2980
|
+
"menu",
|
|
2981
|
+
"drawer",
|
|
2982
|
+
"auto"
|
|
2983
|
+
]
|
|
2984
|
+
},
|
|
2985
|
+
"props": [
|
|
2986
|
+
"label",
|
|
2987
|
+
"options",
|
|
2988
|
+
"value",
|
|
2989
|
+
"defaultValue",
|
|
2990
|
+
"onValueChange",
|
|
2991
|
+
"open",
|
|
2992
|
+
"onOpenChange",
|
|
2993
|
+
"icon",
|
|
2994
|
+
"disabled",
|
|
2995
|
+
"presentation"
|
|
2996
|
+
],
|
|
2997
|
+
"description": "The Filtering pattern's single-value dropdown filter: one value from one dimension (time period, interval, source type). Shows a DS Select (native listbox, keyboard navigation, scroll indicators) on desktop and a bottom Drawer with RadioGroup in two columns on mobile. The trigger wears the same field look as MultiSelectFilter (multiSelectFilterTriggerVariants — border, radius, focus ring, chevron) so a SingleSelectFilter sits beside a MultiSelectFilter in a toolbar row without looking different. size='default' (h-9, text-field: 14px desktop / 16px touch like Select) or 'sm' (h-8, text-label, phone card headers). The trigger always reads the selected label, or the dimension's name when nothing is picked — both in foreground text, never muted. Options may carry their own icon (option.icon) shown before the label in the menu and the drawer; the trigger wears the picked option's icon unless the icon prop pins one. Counts render in the menu only, never in the trigger. Clear resets to defaultValue — unlike MultiSelectFilter which clears to []; a single-value filter always has a value, and 'no filter' is an explicit option in the list. Drawer anatomy matches MultiSelectFilter: DrawerTitle = label, sr-only DrawerDescription, RadioGroup in grid-cols-2, Clear when value ≠ defaultValue, Done button that only closes. Per-filter commit model: onValueChange fires on every pick. presentation='menu' (default) is the DS Select; 'drawer' is the phone form; 'auto' switches at the md breakpoint.",
|
|
2998
|
+
"i18nProps": {
|
|
2999
|
+
"SingleSelectFilter": {
|
|
3000
|
+
"clearLabel": "string — default: \"Clear filters\"",
|
|
3001
|
+
"doneLabel": "string — default: \"Done\" (the drawer's close button)",
|
|
3002
|
+
"drawerDescription": "string — default: \"Pick one option.\" (sr-only drawer description)"
|
|
3003
|
+
}
|
|
3004
|
+
},
|
|
3005
|
+
"whenToUse": [
|
|
3006
|
+
"One value from a dimension in a filter toolbar (time period, interval, source type) — the Filtering pattern's dropdown filter",
|
|
3007
|
+
"A responsive filter that shows a DS Select on desktop and a radio drawer on mobile: presentation='auto' switches at md",
|
|
3008
|
+
"Sitting beside MultiSelectFilter in a filter bar — the trigger look matches exactly"
|
|
3009
|
+
],
|
|
3010
|
+
"doNotUseFor": [
|
|
3011
|
+
"picking more than one option (use MultiSelectFilter)",
|
|
3012
|
+
"a form field that validates (use Select — SingleSelectFilter has no error state)",
|
|
3013
|
+
"quick filters with 2–5 always-visible options (use ToggleGroup or SegmentedControl)",
|
|
3014
|
+
"a long, searchable single-value list in a form (use Combobox)"
|
|
3015
|
+
],
|
|
3016
|
+
"alternatives": [
|
|
3017
|
+
{
|
|
3018
|
+
"component": "MultiSelectFilter",
|
|
3019
|
+
"rule": "Use MultiSelectFilter for several values from one dimension combining as OR"
|
|
3020
|
+
},
|
|
3021
|
+
{
|
|
3022
|
+
"component": "Select",
|
|
3023
|
+
"rule": "Use Select for a form field that validates — SingleSelectFilter is a filter, not a form field"
|
|
3024
|
+
},
|
|
3025
|
+
{
|
|
3026
|
+
"component": "ToggleGroup",
|
|
3027
|
+
"rule": "Use ToggleGroup for a quick filter with 2–5 always-visible options"
|
|
3028
|
+
},
|
|
3029
|
+
{
|
|
3030
|
+
"component": "Combobox",
|
|
3031
|
+
"rule": "Use Combobox for a long, searchable single-value list in a form"
|
|
3032
|
+
}
|
|
3033
|
+
],
|
|
3034
|
+
"figma": {
|
|
3035
|
+
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
3036
|
+
"nodes": [
|
|
3037
|
+
{
|
|
3038
|
+
"nodeId": "34438:81566",
|
|
3039
|
+
"figmaName": "Single Select Filter",
|
|
3040
|
+
"kind": "componentSet",
|
|
3041
|
+
"export": "SingleSelectFilter",
|
|
3042
|
+
"note": "Built on branch task/DS-1050-sigle-select-filter (2026-10-12); node ids persist on merge. Draws the trigger (Text, Show Icon + Icon swap). The desktop menu is the Select page's `Select / Menu` (the component wraps DS Select) and the phone drawer is a Playground composition of Drawer + Radio / Item — neither is a sub-part export. `presentation` is a runtime/responsive prop with no Figma axis.",
|
|
3043
|
+
"axes": [
|
|
3044
|
+
{
|
|
3045
|
+
"figma": "Size",
|
|
3046
|
+
"code": "size"
|
|
3047
|
+
},
|
|
3048
|
+
{
|
|
3049
|
+
"figma": "State",
|
|
3050
|
+
"exempt": "interaction-state",
|
|
3051
|
+
"valueToProp": {
|
|
3052
|
+
"Disabled": "disabled"
|
|
3053
|
+
},
|
|
3054
|
+
"note": "Focus and Open are runtime states; the CVA has no hover style, so there is no Hover variant"
|
|
3055
|
+
}
|
|
3056
|
+
]
|
|
3057
|
+
}
|
|
3058
|
+
]
|
|
3059
|
+
}
|
|
3060
|
+
},
|
|
2614
3061
|
{
|
|
2615
3062
|
"name": "Field",
|
|
2616
3063
|
"import": "@brightlocal/ui-components/field",
|
|
@@ -2689,12 +3136,14 @@
|
|
|
2689
3136
|
"GlobalLayout",
|
|
2690
3137
|
"GlobalLayoutSidebar",
|
|
2691
3138
|
"GlobalLayoutContent",
|
|
2692
|
-
"
|
|
3139
|
+
"GlobalLayoutActions",
|
|
2693
3140
|
"GlobalLayoutContentHeader",
|
|
2694
3141
|
"GlobalLayoutBackLink",
|
|
2695
3142
|
"GlobalLayoutSubtitle",
|
|
2696
|
-
"
|
|
2697
|
-
"GlobalLayoutMobileHeader"
|
|
3143
|
+
"GlobalLayoutBody",
|
|
3144
|
+
"GlobalLayoutMobileHeader",
|
|
3145
|
+
"GlobalLayoutContentActions",
|
|
3146
|
+
"GlobalLayoutContentBody"
|
|
2698
3147
|
],
|
|
2699
3148
|
"compound": true,
|
|
2700
3149
|
"dataHookRequired": true,
|
|
@@ -2758,7 +3207,7 @@
|
|
|
2758
3207
|
"reason": "Drawn as a Sidebar instance inside the Global Layout composition"
|
|
2759
3208
|
},
|
|
2760
3209
|
{
|
|
2761
|
-
"export": "
|
|
3210
|
+
"export": "GlobalLayoutActions",
|
|
2762
3211
|
"reason": "Drawn inside the Content set, structural slot"
|
|
2763
3212
|
},
|
|
2764
3213
|
{
|
|
@@ -2774,12 +3223,20 @@
|
|
|
2774
3223
|
"reason": "Drawn inside the Content header composition"
|
|
2775
3224
|
},
|
|
2776
3225
|
{
|
|
2777
|
-
"export": "
|
|
3226
|
+
"export": "GlobalLayoutBody",
|
|
2778
3227
|
"reason": "Structural slot, drawn implicitly as the content area"
|
|
2779
3228
|
},
|
|
2780
3229
|
{
|
|
2781
3230
|
"export": "GlobalLayoutMobileHeader",
|
|
2782
3231
|
"reason": "No standalone Figma representation found (2026-08-18)"
|
|
3232
|
+
},
|
|
3233
|
+
{
|
|
3234
|
+
"export": "GlobalLayoutContentActions",
|
|
3235
|
+
"reason": "Deprecated alias of GlobalLayoutActions (DS-855)"
|
|
3236
|
+
},
|
|
3237
|
+
{
|
|
3238
|
+
"export": "GlobalLayoutContentBody",
|
|
3239
|
+
"reason": "Deprecated alias of GlobalLayoutBody (DS-855)"
|
|
2783
3240
|
}
|
|
2784
3241
|
],
|
|
2785
3242
|
"figmaOnly": []
|
|
@@ -2834,6 +3291,13 @@
|
|
|
2834
3291
|
"a whole standalone page like login or invite (use CentredLayout — it owns the viewport)",
|
|
2835
3292
|
"a section's empty frame (an md EmptyState fills the frame it is given, no centring wrapper)",
|
|
2836
3293
|
"a layout the vocabulary lacks (request a new variant in the DS, never a className at the call site)"
|
|
3294
|
+
],
|
|
3295
|
+
"knownGaps": [
|
|
3296
|
+
{
|
|
3297
|
+
"description": "variant=\"centered\" needs an unbroken flex chain: it stretches with flex-1, so a non-flex wrapper between the page body and the Grid collapses it to its content height — the 38/62 spacers shrink to zero and the message is centred horizontally only (it hugs the top of the body). Nothing warns about it.",
|
|
3298
|
+
"ticket": "DS-1058",
|
|
3299
|
+
"workaround": "Make every wrapper between the page body and the Grid a flex column that fills it (className=\"flex flex-1 flex-col\"), or render the Grid directly inside GlobalLayoutBody. Never compensate with a top margin (mt-*)."
|
|
3300
|
+
}
|
|
2837
3301
|
]
|
|
2838
3302
|
},
|
|
2839
3303
|
{
|
|
@@ -2986,6 +3450,66 @@
|
|
|
2986
3450
|
"single short lines of text (use Tooltip)"
|
|
2987
3451
|
]
|
|
2988
3452
|
},
|
|
3453
|
+
{
|
|
3454
|
+
"name": "InfoTooltip",
|
|
3455
|
+
"import": "@brightlocal/ui-components/info-tooltip",
|
|
3456
|
+
"category": "feedback",
|
|
3457
|
+
"exports": [
|
|
3458
|
+
"InfoTooltip"
|
|
3459
|
+
],
|
|
3460
|
+
"compound": false,
|
|
3461
|
+
"dataHookRequired": true,
|
|
3462
|
+
"variants": {},
|
|
3463
|
+
"props": [
|
|
3464
|
+
"content",
|
|
3465
|
+
"icon",
|
|
3466
|
+
"iconSize",
|
|
3467
|
+
"ariaLabel",
|
|
3468
|
+
"trackingEl",
|
|
3469
|
+
"trackingLabel"
|
|
3470
|
+
],
|
|
3471
|
+
"description": "Muted info icon that opens a tooltip (hover/tap/focus) — the standard pattern for inline hints next to labels. Composes the Tooltip component.",
|
|
3472
|
+
"aliases": [
|
|
3473
|
+
"info icon",
|
|
3474
|
+
"help icon",
|
|
3475
|
+
"hint tooltip",
|
|
3476
|
+
"info tooltip",
|
|
3477
|
+
"muted tooltip trigger"
|
|
3478
|
+
],
|
|
3479
|
+
"whenToUse": [
|
|
3480
|
+
"A small info/help icon next to a label that explains what it means",
|
|
3481
|
+
"Inline clarifications that should not take up permanent space"
|
|
3482
|
+
],
|
|
3483
|
+
"doNotUseFor": [
|
|
3484
|
+
"Clickable tooltip content — use Popover",
|
|
3485
|
+
"Content longer than a sentence or two — use HoverCard or Popover",
|
|
3486
|
+
"A button or interactive control as trigger — use Tooltip directly with asChild"
|
|
3487
|
+
],
|
|
3488
|
+
"i18nProps": {
|
|
3489
|
+
"InfoTooltip": {
|
|
3490
|
+
"ariaLabel": "string — default: \"More info\""
|
|
3491
|
+
}
|
|
3492
|
+
},
|
|
3493
|
+
"figma": {
|
|
3494
|
+
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
3495
|
+
"nodes": [
|
|
3496
|
+
{
|
|
3497
|
+
"nodeId": "34112:2577",
|
|
3498
|
+
"figmaName": "Info Tooltip",
|
|
3499
|
+
"kind": "componentSet",
|
|
3500
|
+
"export": "InfoTooltip",
|
|
3501
|
+
"axes": [
|
|
3502
|
+
{
|
|
3503
|
+
"figma": "State",
|
|
3504
|
+
"exempt": "interaction-state"
|
|
3505
|
+
}
|
|
3506
|
+
]
|
|
3507
|
+
}
|
|
3508
|
+
],
|
|
3509
|
+
"unmappedExports": [],
|
|
3510
|
+
"figmaOnly": []
|
|
3511
|
+
}
|
|
3512
|
+
},
|
|
2989
3513
|
{
|
|
2990
3514
|
"name": "Input",
|
|
2991
3515
|
"import": "@brightlocal/ui-components/input",
|
|
@@ -3147,7 +3671,8 @@
|
|
|
3147
3671
|
"InputGroup",
|
|
3148
3672
|
"InputGroupInput",
|
|
3149
3673
|
"InputGroupAddon",
|
|
3150
|
-
"InputGroupButton"
|
|
3674
|
+
"InputGroupButton",
|
|
3675
|
+
"InputGroupClear"
|
|
3151
3676
|
],
|
|
3152
3677
|
"compound": true,
|
|
3153
3678
|
"dataHookRequired": true,
|
|
@@ -3161,7 +3686,7 @@
|
|
|
3161
3686
|
"props": [
|
|
3162
3687
|
"error"
|
|
3163
3688
|
],
|
|
3164
|
-
"description": "Input with addon text or button",
|
|
3689
|
+
"description": "Input with addon text or button, and an opt-in built-in clear X",
|
|
3165
3690
|
"figma": {
|
|
3166
3691
|
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
3167
3692
|
"status": "represented-inline",
|
|
@@ -3169,6 +3694,7 @@
|
|
|
3169
3694
|
},
|
|
3170
3695
|
"whenToUse": [
|
|
3171
3696
|
"A text box with something extra attached (search icon, clear button, unit prefix)",
|
|
3697
|
+
"Search fields needing the Filtering pattern’s in-field clear X — add InputGroupClear, no hand-wiring",
|
|
3172
3698
|
"Attachments that should feel like part of the same control, not a separate element",
|
|
3173
3699
|
"Ghost variant for search fields in toolbars or dense filter bars where a border feels heavy"
|
|
3174
3700
|
],
|
|
@@ -3176,7 +3702,12 @@
|
|
|
3176
3702
|
"inputs with nothing attached (use Input)",
|
|
3177
3703
|
"password visibility toggle with strength meter (use InputPassword)",
|
|
3178
3704
|
"ghost variant on plain backgrounds with no surrounding context (can look non-interactive)"
|
|
3179
|
-
]
|
|
3705
|
+
],
|
|
3706
|
+
"i18nProps": {
|
|
3707
|
+
"InputGroupClear": {
|
|
3708
|
+
"clearSearchAriaLabel": "string — default: \"Clear search\""
|
|
3709
|
+
}
|
|
3710
|
+
}
|
|
3180
3711
|
},
|
|
3181
3712
|
{
|
|
3182
3713
|
"name": "InputOTP",
|
|
@@ -3258,10 +3789,11 @@
|
|
|
3258
3789
|
"import": "@brightlocal/ui-components/input-password",
|
|
3259
3790
|
"category": "form",
|
|
3260
3791
|
"exports": [
|
|
3261
|
-
"
|
|
3792
|
+
"InputPassword",
|
|
3262
3793
|
"InputPasswordField",
|
|
3263
3794
|
"InputPasswordToggle",
|
|
3264
|
-
"InputPasswordStrength"
|
|
3795
|
+
"InputPasswordStrength",
|
|
3796
|
+
"InputPasswordRoot"
|
|
3265
3797
|
],
|
|
3266
3798
|
"compound": false,
|
|
3267
3799
|
"dataHookRequired": true,
|
|
@@ -3285,7 +3817,7 @@
|
|
|
3285
3817
|
"nodeId": "25242:1860",
|
|
3286
3818
|
"figmaName": "Input Password",
|
|
3287
3819
|
"kind": "componentSet",
|
|
3288
|
-
"export": "
|
|
3820
|
+
"export": "InputPassword",
|
|
3289
3821
|
"note": "Draws the assembled password field; the 'Progress' BOOLEAN corresponds to the showMeter prop (booleans are globally exempt)",
|
|
3290
3822
|
"axes": [
|
|
3291
3823
|
{
|
|
@@ -3310,6 +3842,10 @@
|
|
|
3310
3842
|
{
|
|
3311
3843
|
"export": "InputPasswordStrength",
|
|
3312
3844
|
"reason": "Drawn inside the Input Password set ('Progress' BOOLEAN toggle)"
|
|
3845
|
+
},
|
|
3846
|
+
{
|
|
3847
|
+
"export": "InputPasswordRoot",
|
|
3848
|
+
"reason": "Deprecated alias of InputPassword (DS-853)"
|
|
3313
3849
|
}
|
|
3314
3850
|
],
|
|
3315
3851
|
"figmaOnly": []
|
|
@@ -4223,6 +4759,7 @@
|
|
|
4223
4759
|
"size",
|
|
4224
4760
|
"showValue",
|
|
4225
4761
|
"unit",
|
|
4762
|
+
"valueFormatter",
|
|
4226
4763
|
"ariaLabel",
|
|
4227
4764
|
"label",
|
|
4228
4765
|
"statusDescription",
|
|
@@ -4231,7 +4768,12 @@
|
|
|
4231
4768
|
"indicatorClassName",
|
|
4232
4769
|
"disabled"
|
|
4233
4770
|
],
|
|
4234
|
-
"description": "Progress bar indicator with optional inline label, numeric value, and brand color options",
|
|
4771
|
+
"description": "Progress bar indicator with optional inline label (text, or a node such as a Rating or icon), numeric value with optional custom formatting, and brand color options",
|
|
4772
|
+
"i18nProps": {
|
|
4773
|
+
"Progress": {
|
|
4774
|
+
"ariaLabel": "string — default: \"Progress\" (required when `label` is an element)"
|
|
4775
|
+
}
|
|
4776
|
+
},
|
|
4235
4777
|
"figma": {
|
|
4236
4778
|
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
4237
4779
|
"nodes": [
|
|
@@ -4240,7 +4782,7 @@
|
|
|
4240
4782
|
"figmaName": "Progress",
|
|
4241
4783
|
"kind": "componentSet",
|
|
4242
4784
|
"export": "Progress",
|
|
4243
|
-
"note": "Show label / Label text (TEXT) ↔ `label`; Show value ↔ `showValue`; `disabled` has no variant by decision — shown as a 50%-opacity instance in the Playground; Fill ↔ `value` (fill + Number text); Fraction form (BOOLEAN) / Max (TEXT) / Unit (TEXT) ↔ `unit !== \"%\"` / `max` / `unit`. Label column is the exposed nested set Progress / Label — Width Auto | 20% | 30% | 40% | 50% (default 40%) + Label text = code labelWidth (\"auto\" | \"20%\"–\"50%\", default \"40%\") + label; % values are fixed px at the 364 base since Figma has no % sizing; long labels wrap (never truncate); Value layer hugs with a 40px minimum, right-aligned (code sizes it to the widest value automatically). Indicator/Track use the brand palette by decision (green-400, brand-primary-foreground/20, brand-red/orange/yellow + /20) — Figma binds the same variables; not the chart-* tokens. Text style text-xs/leading-normal = 16px = Tailwind text-xs default line-height. DS-773.",
|
|
4785
|
+
"note": "Show label / Label text (TEXT) ↔ `label`; Show value ↔ `showValue`; `disabled` has no variant by decision — shown as a 50%-opacity instance in the Playground; Fill ↔ `value` (fill + Number text); Fraction form (BOOLEAN) / Max (TEXT) / Unit (TEXT) ↔ `unit !== \"%\"` / `max` / `unit`. Label column is the exposed nested set Progress / Label — Width Auto | 20% | 30% | 40% | 50% (default 40%) + Label text = code labelWidth (\"auto\" | \"20%\"–\"50%\", default \"40%\") + label; % values are fixed px at the 364 base since Figma has no % sizing; long labels wrap (never truncate); Value layer hugs with a 40px minimum, right-aligned (code sizes it to the widest value automatically). Indicator/Track use the brand palette by decision (green-400, brand-primary-foreground/20, brand-red/orange/yellow + /20) — Figma binds the same variables; not the chart-* tokens. Text style text-xs/leading-normal = 16px = Tailwind text-xs default line-height. DS-773. DS-1024: `label` also accepts an element (Rating, icon) with a required `ariaLabel` ↔ Progress / Label `Type = Text | Element` VARIANT (the code's two label shapes; an export-discriminator axis if the Label set is ever mapped) + `Element` INSTANCE_SWAP (default Rating Size=Small; preferred Rating, Progress / Element / Thumbs Up, Progress / Element / Thumbs Down — 16px icons in hugging frames); drawn on the DS-1024 branch (FIG-29, mapping after merge); `valueFormatter` output (e.g. a raw count) maps to the overridable Number text.",
|
|
4244
4786
|
"axes": [
|
|
4245
4787
|
{
|
|
4246
4788
|
"figma": "Colour",
|
|
@@ -4411,6 +4953,105 @@
|
|
|
4411
4953
|
"non-star scores or counts (use plain text or Badge)"
|
|
4412
4954
|
]
|
|
4413
4955
|
},
|
|
4956
|
+
{
|
|
4957
|
+
"name": "RelativeDate",
|
|
4958
|
+
"import": "@brightlocal/ui-components/relative-date",
|
|
4959
|
+
"category": "display",
|
|
4960
|
+
"exports": [
|
|
4961
|
+
"RelativeDate",
|
|
4962
|
+
"useNow",
|
|
4963
|
+
"relativeWords",
|
|
4964
|
+
"exactText",
|
|
4965
|
+
"isDateOnly",
|
|
4966
|
+
"toDate",
|
|
4967
|
+
"dateLabel",
|
|
4968
|
+
"DEFAULT_RELATIVE_DATE_LABELS"
|
|
4969
|
+
],
|
|
4970
|
+
"compound": false,
|
|
4971
|
+
"dataHookRequired": true,
|
|
4972
|
+
"variants": {},
|
|
4973
|
+
"props": [
|
|
4974
|
+
"value",
|
|
4975
|
+
"label",
|
|
4976
|
+
"labels",
|
|
4977
|
+
"className"
|
|
4978
|
+
],
|
|
4979
|
+
"description": "When something happened, in words people read at a glance (\"1 hour ago\"), with the exact date and time in a tooltip. Handles ISO timestamps, calendar dates, and null/unknown.",
|
|
4980
|
+
"aliases": [
|
|
4981
|
+
"last updated",
|
|
4982
|
+
"time ago",
|
|
4983
|
+
"timestamp",
|
|
4984
|
+
"freshness",
|
|
4985
|
+
"relative time",
|
|
4986
|
+
"date ago"
|
|
4987
|
+
],
|
|
4988
|
+
"whenToUse": [
|
|
4989
|
+
"Report page headers showing how fresh the data is (\"Last updated 1 hour ago\")",
|
|
4990
|
+
"Any line where users need a glanceable sense of how recent something is",
|
|
4991
|
+
"Calendar dates where the reader cares about recency, not the date itself (\"today\", \"yesterday\", \"3 days ago\")"
|
|
4992
|
+
],
|
|
4993
|
+
"doNotUseFor": [
|
|
4994
|
+
"Picking or entering a date (use DatePicker)",
|
|
4995
|
+
"Displaying a fixed, absolute date that does not need relative context",
|
|
4996
|
+
"Countdown timers or future dates"
|
|
4997
|
+
],
|
|
4998
|
+
"i18nProps": {
|
|
4999
|
+
"RelativeDate": {
|
|
5000
|
+
"labels.justNow": "string — default: \"just now\"",
|
|
5001
|
+
"labels.minuteAgo": "string — default: \"1 minute ago\"",
|
|
5002
|
+
"labels.minutesAgo": "string — default: \"{n} minutes ago\"",
|
|
5003
|
+
"labels.hourAgo": "string — default: \"1 hour ago\"",
|
|
5004
|
+
"labels.hoursAgo": "string — default: \"{n} hours ago\"",
|
|
5005
|
+
"labels.today": "string — default: \"today\"",
|
|
5006
|
+
"labels.yesterday": "string — default: \"yesterday\"",
|
|
5007
|
+
"labels.daysAgo": "string — default: \"{n} days ago\"",
|
|
5008
|
+
"labels.unknown": "string — default: \"unknown\""
|
|
5009
|
+
}
|
|
5010
|
+
},
|
|
5011
|
+
"figma": {
|
|
5012
|
+
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
5013
|
+
"nodes": [
|
|
5014
|
+
{
|
|
5015
|
+
"nodeId": "34279:1059",
|
|
5016
|
+
"figmaName": "Relative Date",
|
|
5017
|
+
"kind": "componentSet",
|
|
5018
|
+
"export": "RelativeDate",
|
|
5019
|
+
"axes": []
|
|
5020
|
+
}
|
|
5021
|
+
],
|
|
5022
|
+
"unmappedExports": [
|
|
5023
|
+
{
|
|
5024
|
+
"export": "useNow",
|
|
5025
|
+
"reason": "Hook — no Figma representation"
|
|
5026
|
+
},
|
|
5027
|
+
{
|
|
5028
|
+
"export": "relativeWords",
|
|
5029
|
+
"reason": "Utility function — no Figma representation"
|
|
5030
|
+
},
|
|
5031
|
+
{
|
|
5032
|
+
"export": "exactText",
|
|
5033
|
+
"reason": "Utility function — no Figma representation"
|
|
5034
|
+
},
|
|
5035
|
+
{
|
|
5036
|
+
"export": "isDateOnly",
|
|
5037
|
+
"reason": "Utility function — no Figma representation"
|
|
5038
|
+
},
|
|
5039
|
+
{
|
|
5040
|
+
"export": "toDate",
|
|
5041
|
+
"reason": "Utility function — no Figma representation"
|
|
5042
|
+
},
|
|
5043
|
+
{
|
|
5044
|
+
"export": "dateLabel",
|
|
5045
|
+
"reason": "Utility function — no Figma representation"
|
|
5046
|
+
},
|
|
5047
|
+
{
|
|
5048
|
+
"export": "DEFAULT_RELATIVE_DATE_LABELS",
|
|
5049
|
+
"reason": "Default labels constant — no Figma representation"
|
|
5050
|
+
}
|
|
5051
|
+
],
|
|
5052
|
+
"figmaOnly": []
|
|
5053
|
+
}
|
|
5054
|
+
},
|
|
4414
5055
|
{
|
|
4415
5056
|
"name": "Resizable",
|
|
4416
5057
|
"import": "@brightlocal/ui-components/resizable",
|
|
@@ -4524,6 +5165,7 @@
|
|
|
4524
5165
|
"category": "layout",
|
|
4525
5166
|
"exports": [
|
|
4526
5167
|
"ScrollArea",
|
|
5168
|
+
"ScrollAreaScrollbar",
|
|
4527
5169
|
"ScrollBar"
|
|
4528
5170
|
],
|
|
4529
5171
|
"compound": true,
|
|
@@ -4544,13 +5186,17 @@
|
|
|
4544
5186
|
"figmaName": "Scroll Area",
|
|
4545
5187
|
"kind": "component",
|
|
4546
5188
|
"export": "ScrollArea",
|
|
4547
|
-
"note": "Code's orientation variant (on
|
|
5189
|
+
"note": "Code's orientation variant (on ScrollAreaScrollbar) has no Figma axis — the scrollbar is drawn vertically only"
|
|
4548
5190
|
}
|
|
4549
5191
|
],
|
|
4550
5192
|
"unmappedExports": [
|
|
4551
5193
|
{
|
|
4552
|
-
"export": "
|
|
5194
|
+
"export": "ScrollAreaScrollbar",
|
|
4553
5195
|
"reason": "Drawn implicitly inside the Scroll Area node, not a standalone Figma component"
|
|
5196
|
+
},
|
|
5197
|
+
{
|
|
5198
|
+
"export": "ScrollBar",
|
|
5199
|
+
"reason": "Deprecated alias of ScrollAreaScrollbar (DS-853)"
|
|
4554
5200
|
}
|
|
4555
5201
|
],
|
|
4556
5202
|
"figmaOnly": []
|
|
@@ -4590,7 +5236,9 @@
|
|
|
4590
5236
|
"onOpenChange",
|
|
4591
5237
|
"onClose",
|
|
4592
5238
|
"disabled",
|
|
4593
|
-
"error"
|
|
5239
|
+
"error",
|
|
5240
|
+
"hint",
|
|
5241
|
+
"reserveValues"
|
|
4594
5242
|
],
|
|
4595
5243
|
"description": "Dropdown select input",
|
|
4596
5244
|
"aliases": [
|
|
@@ -4600,8 +5248,9 @@
|
|
|
4600
5248
|
],
|
|
4601
5249
|
"doNotUseFor": [
|
|
4602
5250
|
"long or searchable lists (use Combobox)",
|
|
4603
|
-
"picking more than one option (use
|
|
4604
|
-
"showing every option at once (use RadioGroup)"
|
|
5251
|
+
"picking more than one option (use MultiSelectFilter)",
|
|
5252
|
+
"showing every option at once (use RadioGroup)",
|
|
5253
|
+
"a single-value filter in a toolbar (use SingleSelectFilter — it wraps Select on desktop and adds a radio drawer on mobile)"
|
|
4605
5254
|
],
|
|
4606
5255
|
"replaces": [
|
|
4607
5256
|
"native <select>"
|
|
@@ -4793,6 +5442,7 @@
|
|
|
4793
5442
|
"SheetClose",
|
|
4794
5443
|
"SheetOverlay",
|
|
4795
5444
|
"SheetContent",
|
|
5445
|
+
"SheetPagination",
|
|
4796
5446
|
"SheetHeader",
|
|
4797
5447
|
"SheetBody",
|
|
4798
5448
|
"SheetFooter",
|
|
@@ -4820,6 +5470,12 @@
|
|
|
4820
5470
|
"i18nProps": {
|
|
4821
5471
|
"SheetContent": {
|
|
4822
5472
|
"closeLabel": "string — default: \"Close\""
|
|
5473
|
+
},
|
|
5474
|
+
"SheetPagination": {
|
|
5475
|
+
"ariaLabel": "string — default: \"Item navigation\"",
|
|
5476
|
+
"prevAriaLabel": "string — default: \"Previous item\"",
|
|
5477
|
+
"nextAriaLabel": "string — default: \"Next item\"",
|
|
5478
|
+
"renderPosition": "(info) => ReactNode — default: \"{current} of {total}\""
|
|
4823
5479
|
}
|
|
4824
5480
|
},
|
|
4825
5481
|
"description": "Side panel overlay",
|
|
@@ -4863,7 +5519,9 @@
|
|
|
4863
5519
|
"requiresLabel": true,
|
|
4864
5520
|
"keyboardInteraction": [
|
|
4865
5521
|
"Escape",
|
|
4866
|
-
"Tab"
|
|
5522
|
+
"Tab",
|
|
5523
|
+
"ArrowUp/ArrowLeft (SheetPagination: previous item)",
|
|
5524
|
+
"ArrowDown/ArrowRight (SheetPagination: next item)"
|
|
4867
5525
|
]
|
|
4868
5526
|
},
|
|
4869
5527
|
"figma": {
|
|
@@ -4909,6 +5567,10 @@
|
|
|
4909
5567
|
"export": "SheetContent",
|
|
4910
5568
|
"reason": "Drawn by the Sheet set (the panel); its side variant is declared on the set's Position axis"
|
|
4911
5569
|
},
|
|
5570
|
+
{
|
|
5571
|
+
"export": "SheetPagination",
|
|
5572
|
+
"reason": "Drawn as the SheetPagination component on Figma branch b5xlDa4Z8KpgCwho15fOcM (DS-1035); map with /figma-map after the branch merges"
|
|
5573
|
+
},
|
|
4912
5574
|
{
|
|
4913
5575
|
"export": "SheetHeader",
|
|
4914
5576
|
"reason": "Drawn inside the set ('Show Header' toggle)"
|
|
@@ -5415,6 +6077,10 @@
|
|
|
5415
6077
|
"layout": [
|
|
5416
6078
|
"auto",
|
|
5417
6079
|
"fixed"
|
|
6080
|
+
],
|
|
6081
|
+
"scrollOwner": [
|
|
6082
|
+
"self",
|
|
6083
|
+
"parent"
|
|
5418
6084
|
]
|
|
5419
6085
|
},
|
|
5420
6086
|
"props": [
|
|
@@ -5423,7 +6089,8 @@
|
|
|
5423
6089
|
"trackingLabel",
|
|
5424
6090
|
"layout",
|
|
5425
6091
|
"minWidth",
|
|
5426
|
-
"scrollRegionLabel"
|
|
6092
|
+
"scrollRegionLabel",
|
|
6093
|
+
"scrollOwner"
|
|
5427
6094
|
],
|
|
5428
6095
|
"i18nProps": {
|
|
5429
6096
|
"Table": {
|
|
@@ -5441,7 +6108,7 @@
|
|
|
5441
6108
|
"workaround": "Use DataTableColumnHeader from DataTable for sortable headers"
|
|
5442
6109
|
}
|
|
5443
6110
|
],
|
|
5444
|
-
"description": "Semantic HTML table with accessibility features. Text alignment is physical (left/right/center). Set layout=\"fixed\" with width on TableHead for stable columns.",
|
|
6111
|
+
"description": "Semantic HTML table with accessibility features. Text alignment is physical (left/right/center). Set layout=\"fixed\" with width on TableHead for stable columns. scrollOwner=\"parent\" keeps the table-container wrapper in the DOM as a plain positioned block but strips its scroll behavior, so a scrolling ancestor owns both axes (how DataTable renders it); default \"self\" makes the wrapper the horizontal scroll container.",
|
|
5445
6112
|
"aliases": [
|
|
5446
6113
|
"data grid",
|
|
5447
6114
|
"grid",
|
|
@@ -5584,8 +6251,14 @@
|
|
|
5584
6251
|
],
|
|
5585
6252
|
"compound": true,
|
|
5586
6253
|
"dataHookRequired": true,
|
|
5587
|
-
"variants": {
|
|
6254
|
+
"variants": {
|
|
6255
|
+
"variant": [
|
|
6256
|
+
"default",
|
|
6257
|
+
"underline"
|
|
6258
|
+
]
|
|
6259
|
+
},
|
|
5588
6260
|
"props": [
|
|
6261
|
+
"variant",
|
|
5589
6262
|
"value",
|
|
5590
6263
|
"defaultValue",
|
|
5591
6264
|
"onValueChange",
|
|
@@ -5596,7 +6269,10 @@
|
|
|
5596
6269
|
"aliases": [
|
|
5597
6270
|
"tab bar",
|
|
5598
6271
|
"tab group",
|
|
5599
|
-
"tabbed interface"
|
|
6272
|
+
"tabbed interface",
|
|
6273
|
+
"underline tabs",
|
|
6274
|
+
"promoted tab row",
|
|
6275
|
+
"promoted filter tabs"
|
|
5600
6276
|
],
|
|
5601
6277
|
"doNotUseFor": [
|
|
5602
6278
|
"sections that must be completed in order (use Stepper)",
|
|
@@ -5619,18 +6295,30 @@
|
|
|
5619
6295
|
"fileKey": "p3krmC8DBUgqpbq6cLzaal",
|
|
5620
6296
|
"nodes": [
|
|
5621
6297
|
{
|
|
5622
|
-
"nodeId": "
|
|
6298
|
+
"nodeId": "34619:82902",
|
|
5623
6299
|
"figmaName": "Tabs",
|
|
5624
|
-
"kind": "
|
|
6300
|
+
"kind": "componentSet",
|
|
5625
6301
|
"export": "Tabs",
|
|
5626
|
-
"note": "Figma
|
|
6302
|
+
"note": "Rebuilt on Figma branch task/DS-946-tab-variant (DS-946); the set draws the TabsList row with four Tabs / Trigger instances",
|
|
6303
|
+
"axes": [
|
|
6304
|
+
{
|
|
6305
|
+
"figma": "Variant",
|
|
6306
|
+
"code": "variant"
|
|
6307
|
+
}
|
|
6308
|
+
]
|
|
5627
6309
|
},
|
|
5628
6310
|
{
|
|
5629
|
-
"nodeId": "
|
|
6311
|
+
"nodeId": "34619:82769",
|
|
5630
6312
|
"figmaName": "Tabs / Trigger",
|
|
5631
6313
|
"kind": "componentSet",
|
|
5632
6314
|
"export": "TabsTrigger",
|
|
6315
|
+
"note": "Rebuilt on Figma branch task/DS-946-tab-variant (DS-946)",
|
|
5633
6316
|
"axes": [
|
|
6317
|
+
{
|
|
6318
|
+
"figma": "Variant",
|
|
6319
|
+
"code": "variant",
|
|
6320
|
+
"note": "Inherited from the Tabs root via context; the trigger has no variant prop of its own"
|
|
6321
|
+
},
|
|
5634
6322
|
{
|
|
5635
6323
|
"figma": "Active",
|
|
5636
6324
|
"exempt": "interaction-state",
|
|
@@ -5649,7 +6337,7 @@
|
|
|
5649
6337
|
"unmappedExports": [
|
|
5650
6338
|
{
|
|
5651
6339
|
"export": "TabsList",
|
|
5652
|
-
"reason": "Drawn
|
|
6340
|
+
"reason": "Drawn as the Tabs component set itself (Variant=Default pill list / Variant=Underline bordered row)"
|
|
5653
6341
|
},
|
|
5654
6342
|
{
|
|
5655
6343
|
"export": "TabsContent",
|
|
@@ -5896,7 +6584,7 @@
|
|
|
5896
6584
|
"align",
|
|
5897
6585
|
"sideOffset"
|
|
5898
6586
|
],
|
|
5899
|
-
"description": "
|
|
6587
|
+
"description": "Toggletip: hover on desktop, tap to toggle on touch (stays open for copying text), dismiss via click-outside or Escape",
|
|
5900
6588
|
"aliases": [
|
|
5901
6589
|
"hover tip",
|
|
5902
6590
|
"info tip",
|
|
@@ -5904,8 +6592,7 @@
|
|
|
5904
6592
|
],
|
|
5905
6593
|
"doNotUseFor": [
|
|
5906
6594
|
"clickable content like links or buttons (use Popover)",
|
|
5907
|
-
"content longer than a sentence (use HoverCard or Popover)"
|
|
5908
|
-
"critical info for touch-only users (hover has no touch equivalent)"
|
|
6595
|
+
"content longer than a sentence (use HoverCard or Popover)"
|
|
5909
6596
|
],
|
|
5910
6597
|
"replaces": [
|
|
5911
6598
|
"title attribute"
|
|
@@ -6081,6 +6768,7 @@
|
|
|
6081
6768
|
"color",
|
|
6082
6769
|
"align",
|
|
6083
6770
|
"tabular",
|
|
6771
|
+
"truncate",
|
|
6084
6772
|
"asChild"
|
|
6085
6773
|
],
|
|
6086
6774
|
"description": "Semantic heading with decoupled axes: level sets the h1-h6 tag (document outline), variant sets the visual style from the semantic type scale, color carries the colour role (DS-714)",
|
|
@@ -6183,6 +6871,7 @@
|
|
|
6183
6871
|
"variant",
|
|
6184
6872
|
"color",
|
|
6185
6873
|
"tabular",
|
|
6874
|
+
"truncate",
|
|
6186
6875
|
"align",
|
|
6187
6876
|
"asChild"
|
|
6188
6877
|
],
|
|
@@ -6253,7 +6942,7 @@
|
|
|
6253
6942
|
"titleLevel",
|
|
6254
6943
|
"className"
|
|
6255
6944
|
],
|
|
6256
|
-
"description": "The empty block. Four parts in reading order: a visual, a real heading, one supporting line, and the actions row — children render in source order, so the primary action goes last and lands rightmost. size sets visual prominence and nothing else — the block is pure content and owns no page layout, so position is always the consumer's composition. size=\"md\" (default) is for the box a working page gives it (a card, a panel, a zero-row table): an icon in a 40px muted chip and a
|
|
6945
|
+
"description": "The empty block. Four parts in reading order: a visual, a real heading, one supporting line, and the actions row — children render in source order, so the primary action goes last and lands rightmost. size sets visual prominence and nothing else — the block is pure content and owns no page layout, so position is always the consumer's composition. size=\"md\" (default) is for the box a working page gives it (a card, a panel, a zero-row table): an icon in a 40px muted chip and a 16/24 title. size=\"lg\" is for the moment the whole page has nothing to show: a 130px illustration and a 20/28 title, composed inside Grid variant=\"centered\" for the page body's optical centre — the same spot ProgressState uses. The props are a discriminated union on size: illustration exists only at lg and align only at md, so a 130px drawing inside a card will not compile. Pass the illustration without a size; the block sets it. titleLevel stays the consumer's, for the document outline. (sm is reserved — a compact row-level tier is not designed yet.)",
|
|
6257
6946
|
"aliases": [
|
|
6258
6947
|
"empty state",
|
|
6259
6948
|
"empty block",
|
|
@@ -6756,6 +7445,13 @@
|
|
|
6756
7445
|
"doNotUseFor": [
|
|
6757
7446
|
"simple, shallow navigation (a plain nav list may be simpler)",
|
|
6758
7447
|
"small screens with a permanently visible sidebar (prefer Offcanvas over None)"
|
|
7448
|
+
],
|
|
7449
|
+
"knownGaps": [
|
|
7450
|
+
{
|
|
7451
|
+
"description": "SidebarMenuCollapsibleContent already renders the SidebarMenuSub list; nesting another SidebarMenuSub inside it stacks both indents and leaves ~100px for labels at the default 288px width, so sub-items wrap",
|
|
7452
|
+
"ticket": "DS-1029",
|
|
7453
|
+
"workaround": "Place SidebarMenuSubItem directly inside SidebarMenuCollapsibleContent and pass variant on it; use a standalone SidebarMenuSub only outside a collapsible"
|
|
7454
|
+
}
|
|
6759
7455
|
]
|
|
6760
7456
|
}
|
|
6761
7457
|
],
|