@timefoldai/viz-react 0.0.0-stage → 0.1.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/LICENSE +202 -0
- package/README.md +240 -2
- package/dist/THIRD-PARTY-NOTICES.txt +99 -0
- package/dist/a11y/AccessibleTable.d.mts +42 -0
- package/dist/a11y/AccessibleTable.mjs +82 -0
- package/dist/a11y/activation.d.mts +4 -0
- package/dist/a11y/activation.mjs +0 -0
- package/dist/analytics/AnalyticsProvider.d.mts +16 -0
- package/dist/analytics/AnalyticsProvider.mjs +32 -0
- package/dist/assets/Inter-latin-ext.woff2 +0 -0
- package/dist/badge/Badge.css +122 -0
- package/dist/badge/Badge.d.mts +50 -0
- package/dist/badge/Badge.mjs +145 -0
- package/dist/badge/Badge.module.css.mjs +15 -0
- package/dist/badge/BadgeFacetGroup.d.mts +23 -0
- package/dist/badge/BadgeFacetGroup.mjs +220 -0
- package/dist/badge/BadgeGroup.d.mts +13 -0
- package/dist/badge/BadgeGroup.mjs +53 -0
- package/dist/badge/BadgeList.d.mts +14 -0
- package/dist/badge/BadgeList.mjs +15 -0
- package/dist/badge/badge-facet-fit.d.mts +18 -0
- package/dist/badge/badge-facet-fit.mjs +50 -0
- package/dist/badge/badge-item.d.mts +19 -0
- package/dist/badge/badge-item.mjs +23 -0
- package/dist/button/CopyButton.d.mts +12 -0
- package/dist/button/CopyButton.mjs +52 -0
- package/dist/button/ShowAllButton.d.mts +14 -0
- package/dist/button/ShowAllButton.mjs +61 -0
- package/dist/button/ShowMoreButton.d.mts +13 -0
- package/dist/button/ShowMoreButton.mjs +51 -0
- package/dist/button/SolveButton.d.mts +16 -0
- package/dist/button/SolveButton.mjs +56 -0
- package/dist/charts/BarChart.css +59 -0
- package/dist/charts/BarChart.d.mts +26 -0
- package/dist/charts/BarChart.mjs +167 -0
- package/dist/charts/BarChart.module.css.mjs +10 -0
- package/dist/charts/ChartGrid.d.mts +8 -0
- package/dist/charts/ChartGrid.mjs +47 -0
- package/dist/charts/DistributionChart.d.mts +60 -0
- package/dist/charts/DistributionChart.mjs +151 -0
- package/dist/code/CodeBlock.d.mts +13 -0
- package/dist/code/CodeBlock.mjs +71 -0
- package/dist/composition-bar/CompositionBar.d.mts +24 -0
- package/dist/composition-bar/CompositionBar.mjs +124 -0
- package/dist/composition-bar/composition-shares.d.mts +8 -0
- package/dist/composition-bar/composition-shares.mjs +30 -0
- package/dist/data-gate/DataGate.d.mts +34 -0
- package/dist/data-gate/DataGate.mjs +80 -0
- package/dist/date-scope/DateScope.d.mts +30 -0
- package/dist/date-scope/DateScope.mjs +285 -0
- package/dist/design-system/part-props.d.mts +39 -0
- package/dist/design-system/part-props.mjs +0 -0
- package/dist/detail-panel/DetailPanel.d.mts +22 -0
- package/dist/detail-panel/DetailPanel.mjs +80 -0
- package/dist/detail-panel/DetailPanelSection.d.mts +20 -0
- package/dist/detail-panel/DetailPanelSection.mjs +27 -0
- package/dist/detail-panel/micro-label.d.mts +7 -0
- package/dist/detail-panel/micro-label.mjs +9 -0
- package/dist/env.d.mts +2 -0
- package/dist/env.mjs +4 -0
- package/dist/export/ExportCsvButton.d.mts +19 -0
- package/dist/export/ExportCsvButton.mjs +73 -0
- package/dist/export/download-csv.d.mts +5 -0
- package/dist/export/download-csv.mjs +11 -0
- package/dist/export/download-file.d.mts +11 -0
- package/dist/export/download-file.mjs +32 -0
- package/dist/export/download-json.d.mts +2 -0
- package/dist/export/download-json.mjs +8 -0
- package/dist/filter/FilterGroup.d.mts +24 -0
- package/dist/filter/FilterGroup.mjs +71 -0
- package/dist/filter/FilterGroupTitle.d.mts +3 -0
- package/dist/filter/FilterGroupTitle.mjs +18 -0
- package/dist/filter/FilterItem.d.mts +17 -0
- package/dist/filter/FilterItem.mjs +94 -0
- package/dist/filter/FilterPanel.d.mts +22 -0
- package/dist/filter/FilterPanel.mjs +158 -0
- package/dist/filter/FilterToggleButton.d.mts +15 -0
- package/dist/filter/FilterToggleButton.mjs +30 -0
- package/dist/filter/date-range.d.mts +8 -0
- package/dist/filter/date-range.mjs +13 -0
- package/dist/filter/filter-facet.d.mts +7 -0
- package/dist/filter/filter-facet.mjs +0 -0
- package/dist/heatmap/Heatmap.css +138 -0
- package/dist/heatmap/Heatmap.d.mts +10 -0
- package/dist/heatmap/Heatmap.mjs +370 -0
- package/dist/heatmap/Heatmap.module.css.mjs +17 -0
- package/dist/heatmap/HeatmapCell.d.mts +25 -0
- package/dist/heatmap/HeatmapCell.mjs +124 -0
- package/dist/heatmap/heatmap-scale.d.mts +19 -0
- package/dist/heatmap/heatmap-scale.mjs +43 -0
- package/dist/heatmap/heatmap-types.d.mts +49 -0
- package/dist/heatmap/heatmap-types.mjs +0 -0
- package/dist/hooks/use-controllable-state.d.mts +9 -0
- package/dist/hooks/use-controllable-state.mjs +44 -0
- package/dist/hooks/use-debounced-value.d.mts +1 -0
- package/dist/hooks/use-debounced-value.mjs +27 -0
- package/dist/hooks/use-detail-panel-layout.d.mts +18 -0
- package/dist/hooks/use-detail-panel-layout.mjs +94 -0
- package/dist/hooks/use-hover-card.d.mts +47 -0
- package/dist/hooks/use-hover-card.mjs +190 -0
- package/dist/hooks/use-hover-focus-card.d.mts +38 -0
- package/dist/hooks/use-hover-focus-card.mjs +321 -0
- package/dist/hooks/use-hover-intent.d.mts +6 -0
- package/dist/hooks/use-hover-intent.mjs +55 -0
- package/dist/hooks/use-merged-ref.d.mts +2 -0
- package/dist/hooks/use-merged-ref.mjs +36 -0
- package/dist/hooks/use-tracked-anchor.d.mts +14 -0
- package/dist/hooks/use-tracked-anchor.mjs +42 -0
- package/dist/index.d.mts +97 -0
- package/dist/index.mjs +88 -0
- package/dist/input/MenuButton.d.mts +47 -0
- package/dist/input/MenuButton.mjs +152 -0
- package/dist/interval-strip/IntervalStrip.css +7 -0
- package/dist/interval-strip/IntervalStrip.d.mts +39 -0
- package/dist/interval-strip/IntervalStrip.mjs +233 -0
- package/dist/interval-strip/IntervalStrip.module.css.mjs +4 -0
- package/dist/interval-strip/IntervalStripAxis.d.mts +18 -0
- package/dist/interval-strip/IntervalStripAxis.mjs +73 -0
- package/dist/interval-strip/interval-fill.d.mts +2 -0
- package/dist/interval-strip/interval-fill.mjs +13 -0
- package/dist/interval-strip/interval-layout.d.mts +33 -0
- package/dist/interval-strip/interval-layout.mjs +79 -0
- package/dist/layout/AppShell.css +103 -0
- package/dist/layout/AppShell.d.mts +73 -0
- package/dist/layout/AppShell.mjs +397 -0
- package/dist/layout/AppShell.module.css.mjs +16 -0
- package/dist/layout/ColorSchemeMenu.d.mts +14 -0
- package/dist/layout/ColorSchemeMenu.mjs +92 -0
- package/dist/layout/DemoDataPicker.d.mts +17 -0
- package/dist/layout/DemoDataPicker.mjs +150 -0
- package/dist/layout/OverflowMenu.d.mts +11 -0
- package/dist/layout/OverflowMenu.mjs +94 -0
- package/dist/layout/SidebarLayout.css +70 -0
- package/dist/layout/SidebarLayout.d.mts +33 -0
- package/dist/layout/SidebarLayout.mjs +129 -0
- package/dist/layout/SidebarLayout.module.css.mjs +8 -0
- package/dist/layout/use-date-scope-day.d.mts +23 -0
- package/dist/layout/use-date-scope-day.mjs +63 -0
- package/dist/layout/use-fill-height.d.mts +7 -0
- package/dist/layout/use-fill-height.mjs +50 -0
- package/dist/layout/use-followed-state.d.mts +5 -0
- package/dist/layout/use-followed-state.mjs +75 -0
- package/dist/layout/use-page-route.d.mts +10 -0
- package/dist/layout/use-page-route.mjs +65 -0
- package/dist/legend/Legend.d.mts +54 -0
- package/dist/legend/Legend.mjs +132 -0
- package/dist/map/MapLayersControl.d.mts +11 -0
- package/dist/map/MapLayersControl.mjs +157 -0
- package/dist/map/MapLocator.css +9 -0
- package/dist/map/MapLocator.d.mts +18 -0
- package/dist/map/MapLocator.mjs +97 -0
- package/dist/map/MapLocator.module.css.mjs +4 -0
- package/dist/map/MapMarker.d.mts +29 -0
- package/dist/map/MapMarker.mjs +265 -0
- package/dist/map/MapStops.d.mts +19 -0
- package/dist/map/MapStops.mjs +355 -0
- package/dist/map/MapView.css +24 -0
- package/dist/map/MapView.d.mts +11 -0
- package/dist/map/MapView.mjs +141 -0
- package/dist/map/MapWebgl.d.mts +9 -0
- package/dist/map/MapWebgl.mjs +727 -0
- package/dist/map/area-layers.d.mts +33 -0
- package/dist/map/area-layers.mjs +96 -0
- package/dist/map/control-group.d.mts +6 -0
- package/dist/map/control-group.mjs +12 -0
- package/dist/map/for-each-chunk.d.mts +4 -0
- package/dist/map/for-each-chunk.mjs +14 -0
- package/dist/map/highlight.d.mts +30 -0
- package/dist/map/highlight.mjs +99 -0
- package/dist/map/locator-tile.d.mts +24 -0
- package/dist/map/locator-tile.mjs +41 -0
- package/dist/map/map-sites.d.mts +12 -0
- package/dist/map/map-sites.mjs +39 -0
- package/dist/map/map-style.d.mts +24 -0
- package/dist/map/map-style.mjs +79 -0
- package/dist/map/marker-geometry.d.mts +5 -0
- package/dist/map/marker-geometry.mjs +13 -0
- package/dist/map/marker-icon.d.mts +26 -0
- package/dist/map/marker-icon.mjs +223 -0
- package/dist/map/observe-color-scheme.d.mts +5 -0
- package/dist/map/observe-color-scheme.mjs +19 -0
- package/dist/map/popup-placement.d.mts +20 -0
- package/dist/map/popup-placement.mjs +20 -0
- package/dist/map/route-layers.d.mts +28 -0
- package/dist/map/route-layers.mjs +73 -0
- package/dist/map/types.d.mts +97 -0
- package/dist/map/types.mjs +0 -0
- package/dist/map/use-painted-color-scheme.d.mts +6 -0
- package/dist/map/use-painted-color-scheme.mjs +43 -0
- package/dist/map/use-resolved-colors.d.mts +5 -0
- package/dist/map/use-resolved-colors.mjs +63 -0
- package/dist/pagination/paginationLabels.d.mts +6 -0
- package/dist/pagination/paginationLabels.mjs +8 -0
- package/dist/popover/Popover.css +176 -0
- package/dist/popover/Popover.d.mts +239 -0
- package/dist/popover/Popover.mjs +672 -0
- package/dist/popover/Popover.module.css.mjs +18 -0
- package/dist/popover/PopoverFacts.d.mts +24 -0
- package/dist/popover/PopoverFacts.mjs +63 -0
- package/dist/readout/Readout.d.mts +15 -0
- package/dist/readout/Readout.mjs +53 -0
- package/dist/readout/TimeZoneReadout.d.mts +11 -0
- package/dist/readout/TimeZoneReadout.mjs +46 -0
- package/dist/score-box/ScoreBox.css +62 -0
- package/dist/score-box/ScoreBox.d.mts +12 -0
- package/dist/score-box/ScoreBox.mjs +143 -0
- package/dist/score-box/ScoreBox.module.css.mjs +15 -0
- package/dist/segment-bar/Segment.d.mts +23 -0
- package/dist/segment-bar/Segment.mjs +27 -0
- package/dist/segment-bar/SegmentBar.css +44 -0
- package/dist/segment-bar/SegmentBar.d.mts +35 -0
- package/dist/segment-bar/SegmentBar.mjs +57 -0
- package/dist/segment-bar/SegmentBar.module.css.mjs +9 -0
- package/dist/segment-bar/segment-box.d.mts +10 -0
- package/dist/segment-bar/segment-box.mjs +30 -0
- package/dist/stat/Stat.d.mts +25 -0
- package/dist/stat/Stat.mjs +36 -0
- package/dist/stat/StatTile.d.mts +18 -0
- package/dist/stat/StatTile.mjs +37 -0
- package/dist/styles.css +1 -0
- package/dist/swatch/Swatch.d.mts +8 -0
- package/dist/swatch/Swatch.mjs +30 -0
- package/dist/swatch/legend-swatch.d.mts +3 -0
- package/dist/swatch/legend-swatch.mjs +0 -0
- package/dist/tab-bar/FilteredTabBar.d.mts +32 -0
- package/dist/tab-bar/FilteredTabBar.mjs +181 -0
- package/dist/tab-bar/TabBar.d.mts +22 -0
- package/dist/tab-bar/TabBar.mjs +151 -0
- package/dist/tab-bar/TabPanel.d.mts +9 -0
- package/dist/tab-bar/TabPanel.mjs +55 -0
- package/dist/tab-bar/assert-named-value.d.mts +4 -0
- package/dist/tab-bar/assert-named-value.mjs +6 -0
- package/dist/table/DataTable.d.mts +31 -0
- package/dist/table/DataTable.mjs +43 -0
- package/dist/theme/use-color-scheme.d.mts +14 -0
- package/dist/theme/use-color-scheme.mjs +92 -0
- package/dist/theme.css +58 -0
- package/dist/timeline/Timeline.d.mts +54 -0
- package/dist/timeline/Timeline.mjs +220 -0
- package/dist/timeline/TimelineBand.d.mts +18 -0
- package/dist/timeline/TimelineBand.mjs +30 -0
- package/dist/timeline/TimelineGroup.d.mts +7 -0
- package/dist/timeline/TimelineGroup.mjs +50 -0
- package/dist/timeline/TimelineItem.d.mts +19 -0
- package/dist/timeline/TimelineItem.mjs +64 -0
- package/dist/timeline/TimelineItemChip.css +153 -0
- package/dist/timeline/TimelineItemChip.d.mts +23 -0
- package/dist/timeline/TimelineItemChip.mjs +74 -0
- package/dist/timeline/TimelineItemChip.module.css.mjs +15 -0
- package/dist/timeline/TimelineItemMark.css +38 -0
- package/dist/timeline/TimelineItemMark.d.mts +15 -0
- package/dist/timeline/TimelineItemMark.mjs +129 -0
- package/dist/timeline/TimelineItemMark.module.css.mjs +4 -0
- package/dist/timeline/TimelineRoot.d.mts +19 -0
- package/dist/timeline/TimelineRoot.mjs +742 -0
- package/dist/timeline/TimelineRowHeader.d.mts +23 -0
- package/dist/timeline/TimelineRowHeader.mjs +244 -0
- package/dist/timeline/TimelineZoomHint.d.mts +9 -0
- package/dist/timeline/TimelineZoomHint.mjs +32 -0
- package/dist/timeline/axis-label.d.mts +5 -0
- package/dist/timeline/axis-label.mjs +53 -0
- package/dist/timeline/batched-dataset-writer.d.mts +29 -0
- package/dist/timeline/batched-dataset-writer.mjs +58 -0
- package/dist/timeline/row-card-side.d.mts +7 -0
- package/dist/timeline/row-card-side.mjs +6 -0
- package/dist/timeline/timeline-a11y.d.mts +33 -0
- package/dist/timeline/timeline-a11y.mjs +96 -0
- package/dist/timeline/timeline-context.d.mts +33 -0
- package/dist/timeline/timeline-context.mjs +40 -0
- package/dist/timeline/timeline-types.d.mts +126 -0
- package/dist/timeline/timeline-types.mjs +0 -0
- package/dist/timeline/timeline-utils.d.mts +52 -0
- package/dist/timeline/timeline-utils.mjs +130 -0
- package/dist/timeline/zoom-modifier.d.mts +21 -0
- package/dist/timeline/zoom-modifier.mjs +25 -0
- package/dist/toast/ToastProvider.d.mts +33 -0
- package/dist/toast/ToastProvider.mjs +257 -0
- package/dist/toast/toast-context.d.mts +2 -0
- package/dist/toast/toast-context.mjs +5 -0
- package/dist/tokens.css +1 -0
- package/dist/tooltip/Tooltip.d.mts +17 -0
- package/dist/tooltip/Tooltip.mjs +41 -0
- package/dist/tooltip/hover-open-delay.d.mts +2 -0
- package/dist/tooltip/hover-open-delay.mjs +4 -0
- package/dist/tooltip/is-text-cut.d.mts +1 -0
- package/dist/tooltip/is-text-cut.mjs +5 -0
- package/dist/vendor/components.d.mts +664 -0
- package/dist/vendor/components.mjs +2060 -0
- package/package.json +61 -3
|
@@ -0,0 +1,664 @@
|
|
|
1
|
+
import * as React from "react";
|
|
2
|
+
import * as PopoverPrimitive from "@radix-ui/react-popover";
|
|
3
|
+
import * as DropdownMenuPrimitive from "@radix-ui/react-dropdown-menu";
|
|
4
|
+
import * as TooltipPrimitive from "@radix-ui/react-tooltip";
|
|
5
|
+
type AlertVariant = "info" | "warning" | "error" | "success";
|
|
6
|
+
interface AlertProps extends React.ComponentPropsWithRef<"div"> {
|
|
7
|
+
/**
|
|
8
|
+
* Tone of the message. `error` and `warning` render as an assertive
|
|
9
|
+
* `role="alert"`; `info` and `success` as a polite `role="status"`.
|
|
10
|
+
*
|
|
11
|
+
* @defaultValue "info"
|
|
12
|
+
*/
|
|
13
|
+
variant?: AlertVariant;
|
|
14
|
+
/** Shows a close button in the top-right corner; called when it's pressed. */
|
|
15
|
+
onDismiss?: () => void;
|
|
16
|
+
/**
|
|
17
|
+
* Accessible name of the close button.
|
|
18
|
+
*
|
|
19
|
+
* @defaultValue "Dismiss"
|
|
20
|
+
*/
|
|
21
|
+
dismissLabel?: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Inline banner for feedback that belongs to the surrounding content: a
|
|
25
|
+
* failed save, a read-only notice, an expired trial.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* Plain children render as the message body; compose `AlertTitle` and
|
|
29
|
+
* `AlertDescription` when the message needs a heading.
|
|
30
|
+
*/
|
|
31
|
+
declare function Alert({ className, variant, onDismiss, dismissLabel, children, ...props }: AlertProps): React.JSX.Element;
|
|
32
|
+
interface AlertTitleProps extends React.ComponentPropsWithRef<"p"> {}
|
|
33
|
+
declare function AlertTitle({ className, ...props }: AlertTitleProps): React.JSX.Element;
|
|
34
|
+
interface AlertDescriptionProps extends React.ComponentPropsWithRef<"div"> {}
|
|
35
|
+
declare function AlertDescription(props: AlertDescriptionProps): React.JSX.Element;
|
|
36
|
+
/**
|
|
37
|
+
* An icon placed before or after a label (`leadingIcon` / `trailingIcon` on
|
|
38
|
+
* Button, Badge, menu items, tabs, select items and side-nav items). Any icon
|
|
39
|
+
* component that takes a pixel `size` fits, such as the icons of `react-icons/tb`.
|
|
40
|
+
*/
|
|
41
|
+
type SlotIcon = React.ComponentType<{
|
|
42
|
+
size?: number | string;
|
|
43
|
+
className?: string;
|
|
44
|
+
"aria-hidden"?: boolean | "true" | "false";
|
|
45
|
+
strokeWidth?: number | string;
|
|
46
|
+
}>;
|
|
47
|
+
type BadgeColor = "green" | "yellow" | "purple" | "red" | "neutral";
|
|
48
|
+
/** @see SlotIcon */
|
|
49
|
+
type BadgeIcon = SlotIcon;
|
|
50
|
+
interface BadgeProps extends React.ComponentPropsWithRef<"span"> {
|
|
51
|
+
color?: BadgeColor;
|
|
52
|
+
border?: boolean;
|
|
53
|
+
/** Icon in front of the label. */
|
|
54
|
+
leadingIcon?: BadgeIcon;
|
|
55
|
+
/** Icon after the label. Set both for an icon on each side. */
|
|
56
|
+
trailingIcon?: BadgeIcon;
|
|
57
|
+
}
|
|
58
|
+
declare function Badge({ className, color, border, leadingIcon: LeadingIcon, trailingIcon: TrailingIcon, children, ...props }: BadgeProps): React.JSX.Element;
|
|
59
|
+
type ButtonVariant = "default" | "destructive" | "outline" | "ghost" | "soft";
|
|
60
|
+
type ButtonSize = "default" | "sm" | "xs";
|
|
61
|
+
interface ButtonProps extends React.ComponentPropsWithRef<"button"> {
|
|
62
|
+
asChild?: boolean;
|
|
63
|
+
variant?: ButtonVariant;
|
|
64
|
+
/**
|
|
65
|
+
* Control height: default 40px, `sm` 28px, `xs` 24px. A solo icon
|
|
66
|
+
* becomes a square of the same side.
|
|
67
|
+
*
|
|
68
|
+
* @defaultValue "default"
|
|
69
|
+
*/
|
|
70
|
+
size?: ButtonSize;
|
|
71
|
+
/** Icon in front of the label (inside the child with `asChild`). */
|
|
72
|
+
leadingIcon?: SlotIcon;
|
|
73
|
+
/** Icon after the label. Set both for an icon on each side. */
|
|
74
|
+
trailingIcon?: SlotIcon;
|
|
75
|
+
/**
|
|
76
|
+
* Solo icon: an icon-only square (40×40, or the `size` side) with just this icon (18px, 16px for `sm` and `xs`).
|
|
77
|
+
* Give it a name with `aria-label`; children, if any, become a visually
|
|
78
|
+
* hidden label. Leading and trailing icons are ignored.
|
|
79
|
+
*/
|
|
80
|
+
soloIcon?: SlotIcon;
|
|
81
|
+
/**
|
|
82
|
+
* Busy, e.g. while a form saves: a spinner takes the place of the
|
|
83
|
+
* leading or solo icon, or covers a label-only button without changing
|
|
84
|
+
* its width; the label stays the accessible name. Clicks are ignored and
|
|
85
|
+
* `aria-busy` is set, but the button keeps focus (it isn't `disabled`).
|
|
86
|
+
*/
|
|
87
|
+
loading?: boolean;
|
|
88
|
+
}
|
|
89
|
+
declare function Button({ className, variant, size, asChild, leadingIcon, trailingIcon, soloIcon: SoloIcon, loading: loadingProp, children, ref, onClick, ...props }: ButtonProps): React.JSX.Element;
|
|
90
|
+
declare namespace Button {
|
|
91
|
+
var displayName: string;
|
|
92
|
+
}
|
|
93
|
+
interface CheckboxProps extends Omit<React.ComponentPropsWithRef<"input">, "type" | "checked" | "defaultChecked" | "onChange"> {
|
|
94
|
+
/** Controlled state; `"indeterminate"` renders the mixed glyph and reports `true` when clicked. */
|
|
95
|
+
checked?: boolean | "indeterminate";
|
|
96
|
+
/** @defaultValue false */
|
|
97
|
+
defaultChecked?: boolean;
|
|
98
|
+
onCheckedChange?: (checked: boolean) => void;
|
|
99
|
+
/** Native onChange is still forwarded for form libraries. */
|
|
100
|
+
onChange?: React.ChangeEventHandler<HTMLInputElement>;
|
|
101
|
+
}
|
|
102
|
+
/** Native checkbox styled with design tokens; supports controlled, uncontrolled and indeterminate state. */
|
|
103
|
+
declare function Checkbox({ className, checked, defaultChecked, onCheckedChange, onChange, ref, ...props }: CheckboxProps): React.JSX.Element;
|
|
104
|
+
type ControlRowAlign = "center" | "start";
|
|
105
|
+
interface ControlRowProps extends React.ComponentPropsWithRef<"div"> {
|
|
106
|
+
/**
|
|
107
|
+
* `center` suits a one-line label; `start` lines the control up with the first line of a label that wraps or
|
|
108
|
+
* carries a description.
|
|
109
|
+
*
|
|
110
|
+
* @defaultValue "center"
|
|
111
|
+
*/
|
|
112
|
+
align?: ControlRowAlign;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Row that puts a `RadioGroupItem` or `Checkbox` before its label, with the design system's spacing between them.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* <ControlRow>
|
|
119
|
+
* <Checkbox id="terms" />
|
|
120
|
+
* <label htmlFor="terms">Accept the terms</label>
|
|
121
|
+
* </ControlRow>
|
|
122
|
+
*/
|
|
123
|
+
declare function ControlRow({ className, align, ...props }: ControlRowProps): React.JSX.Element;
|
|
124
|
+
interface CopyValueFeedbackProps {
|
|
125
|
+
/**
|
|
126
|
+
* Called with the rejection when the clipboard refuses the copy; without
|
|
127
|
+
* it the error is reported to the window's error handlers.
|
|
128
|
+
*/
|
|
129
|
+
onError?: (error: unknown) => void;
|
|
130
|
+
/**
|
|
131
|
+
* Text a polite live region announces after a successful copy.
|
|
132
|
+
*
|
|
133
|
+
* @defaultValue "Copied"
|
|
134
|
+
*/
|
|
135
|
+
copiedLabel?: string;
|
|
136
|
+
}
|
|
137
|
+
interface CopyValueButtonProps extends Omit<ButtonProps, "onError">, CopyValueFeedbackProps {
|
|
138
|
+
/** Text written to the clipboard. */
|
|
139
|
+
value: string;
|
|
140
|
+
/** Accessible name of the button. */
|
|
141
|
+
label: string;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Button that copies a value to the clipboard and shows copied feedback.
|
|
145
|
+
* Children render as the visible click target in front of the copy icon,
|
|
146
|
+
* so a whole label (e.g. an id) can be made copyable, not just the icon.
|
|
147
|
+
*/
|
|
148
|
+
declare function CopyValueButton({ value, label, children, variant, onClick, onError, copiedLabel, ...props }: CopyValueButtonProps): React.JSX.Element;
|
|
149
|
+
type InputWidth = "full" | "content";
|
|
150
|
+
interface InputProps extends Omit<React.ComponentPropsWithRef<"input">, "width"> {
|
|
151
|
+
/**
|
|
152
|
+
* `full` stretches to the container; `content` sizes the field to its
|
|
153
|
+
* value (with a 4rem floor) for compact numeric settings that sit inline
|
|
154
|
+
* with their label or unit.
|
|
155
|
+
*
|
|
156
|
+
* @defaultValue "full"
|
|
157
|
+
*/
|
|
158
|
+
width?: InputWidth;
|
|
159
|
+
}
|
|
160
|
+
declare const Popover: React.FC<PopoverPrimitive.PopoverProps>;
|
|
161
|
+
declare const PopoverTrigger: React.ForwardRefExoticComponent<PopoverPrimitive.PopoverTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
162
|
+
declare const PopoverAnchor: React.ForwardRefExoticComponent<PopoverPrimitive.PopoverAnchorProps & React.RefAttributes<HTMLDivElement>>;
|
|
163
|
+
type PopoverPadding = "default" | "none";
|
|
164
|
+
interface PopoverContentProps extends React.ComponentPropsWithRef<typeof PopoverPrimitive.Content> {
|
|
165
|
+
/**
|
|
166
|
+
* `none` removes the inner padding so list content (listboxes, filter
|
|
167
|
+
* rows) can manage its own spacing edge to edge.
|
|
168
|
+
*
|
|
169
|
+
* @defaultValue "default"
|
|
170
|
+
*/
|
|
171
|
+
padding?: PopoverPadding;
|
|
172
|
+
}
|
|
173
|
+
/** Non-modal floating panel anchored to its trigger. */
|
|
174
|
+
declare function PopoverContent({ className, align, sideOffset, padding, ...props }: PopoverContentProps): React.JSX.Element;
|
|
175
|
+
type WeekdayStyle = "short" | "long";
|
|
176
|
+
/** Attributes for a date field's calendar popover, such as a `data-*` marker that the host page reads. */
|
|
177
|
+
type CalendarPopoverProps = Omit<PopoverContentProps, "ref" | "id" | "children" | "align" | "padding" | "onOpenAutoFocus"> & {
|
|
178
|
+
[attribute: `data-${string}`]: string | boolean | undefined;
|
|
179
|
+
};
|
|
180
|
+
type DateFieldWidth = InputWidth | "fixed";
|
|
181
|
+
interface DateFieldProps extends Omit<React.ComponentPropsWithRef<"input">, "value" | "defaultValue" | "onChange" | "type" | "min" | "max" | "size" | "width"> {
|
|
182
|
+
/**
|
|
183
|
+
* The date as an ISO string: `YYYY-MM-DD`, or `YYYY-MM-DDTHH:mm` (local
|
|
184
|
+
* time, like `datetime-local`) with `withTime`. `null` is empty.
|
|
185
|
+
*/
|
|
186
|
+
value?: string | null;
|
|
187
|
+
defaultValue?: string | null;
|
|
188
|
+
/** Called with the new ISO string, or `null` when the field is cleared. */
|
|
189
|
+
onValueChange?: (value: string | null) => void;
|
|
190
|
+
/** Adds a time field after the date; the value becomes `YYYY-MM-DDTHH:mm`. */
|
|
191
|
+
withTime?: boolean;
|
|
192
|
+
/** Earliest allowed value, in the same ISO format as `value`. */
|
|
193
|
+
min?: string;
|
|
194
|
+
/** Latest allowed value, in the same ISO format as `value`. */
|
|
195
|
+
max?: string;
|
|
196
|
+
/** Shows a clear button while there is a value. */
|
|
197
|
+
clearable?: boolean;
|
|
198
|
+
/**
|
|
199
|
+
* `full` stretches to the container; `content` sizes the field to its text, like `Input`'s `width`;
|
|
200
|
+
* `fixed` fits the widest date of the locale, so the field keeps its width as the date changes.
|
|
201
|
+
*
|
|
202
|
+
* @defaultValue "full"
|
|
203
|
+
*/
|
|
204
|
+
width?: DateFieldWidth;
|
|
205
|
+
/**
|
|
206
|
+
* Formats the date and time and reads typed dates in this locale's order
|
|
207
|
+
* (12/31/2026 in en-US, 31/12/2026 in en-GB).
|
|
208
|
+
*
|
|
209
|
+
* @defaultValue "en-US"
|
|
210
|
+
*/
|
|
211
|
+
locale?: string;
|
|
212
|
+
/**
|
|
213
|
+
* Leads the shown date with the weekday ("Mon 5 Oct 2026" in en-GB). Typed dates may include it.
|
|
214
|
+
*/
|
|
215
|
+
weekday?: WeekdayStyle;
|
|
216
|
+
/**
|
|
217
|
+
* First column of the calendar: 0 is Sunday, 1 is Monday.
|
|
218
|
+
*
|
|
219
|
+
* @defaultValue 1
|
|
220
|
+
*/
|
|
221
|
+
weekStartsOn?: 0 | 1;
|
|
222
|
+
/**
|
|
223
|
+
* Time used when a date is picked while the time field is empty.
|
|
224
|
+
*
|
|
225
|
+
* @defaultValue "00:00"
|
|
226
|
+
*/
|
|
227
|
+
defaultTime?: string;
|
|
228
|
+
/** @defaultValue "Choose date" */
|
|
229
|
+
calendarLabel?: string;
|
|
230
|
+
calendarProps?: CalendarPopoverProps;
|
|
231
|
+
/** @defaultValue "Clear date" */
|
|
232
|
+
clearLabel?: string;
|
|
233
|
+
/** @defaultValue "Time" */
|
|
234
|
+
timeLabel?: string;
|
|
235
|
+
/** @defaultValue "Previous month" */
|
|
236
|
+
previousMonthLabel?: string;
|
|
237
|
+
/** @defaultValue "Next month" */
|
|
238
|
+
nextMonthLabel?: string;
|
|
239
|
+
/** @defaultValue "Today" */
|
|
240
|
+
todayLabel?: string;
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* A date field with a calendar, or date and time with `withTime`. People can
|
|
244
|
+
* type a date (ISO, 12/31/2026 in the locale's order, or "31 Dec 2026") or
|
|
245
|
+
* pick one; the value stays an ISO string, so forms that store `YYYY-MM-DD` /
|
|
246
|
+
* `YYYY-MM-DDTHH:mm` keep working. Pass `name` to submit it with a form.
|
|
247
|
+
*/
|
|
248
|
+
declare function DateField({ value: valueProp, defaultValue, onValueChange, withTime, min, max, clearable, width, locale, weekday, weekStartsOn, defaultTime, calendarLabel, calendarProps, clearLabel, timeLabel, previousMonthLabel, nextMonthLabel, todayLabel, name, id, disabled, readOnly, className, style, onBlur, onKeyDown, "aria-invalid": ariaInvalid, ...props }: DateFieldProps): React.JSX.Element;
|
|
249
|
+
/** Inclusive start and end dates as `YYYY-MM-DD`; one day is `[day, day]`. */
|
|
250
|
+
type DateRange = readonly [start: string, end: string];
|
|
251
|
+
type DateRangeFieldWidth = "content" | "fixed";
|
|
252
|
+
interface DateRangeFieldProps extends Omit<React.ComponentPropsWithRef<"div">, "defaultValue" | "onChange"> {
|
|
253
|
+
value?: DateRange | null;
|
|
254
|
+
defaultValue?: DateRange | null;
|
|
255
|
+
/** Called with the new range, or `null` when the field is cleared. */
|
|
256
|
+
onValueChange?: (value: DateRange | null) => void;
|
|
257
|
+
/** Earliest allowed date, `YYYY-MM-DD`. */
|
|
258
|
+
min?: string;
|
|
259
|
+
/** Latest allowed date, `YYYY-MM-DD`. */
|
|
260
|
+
max?: string;
|
|
261
|
+
/** Longest range in days, both ends included. */
|
|
262
|
+
maxDays?: number;
|
|
263
|
+
/** Days that cannot start or end a range, such as days without data. */
|
|
264
|
+
isDateDisabled?: (date: string) => boolean;
|
|
265
|
+
/** Shows a clear button while there is a value. */
|
|
266
|
+
clearable?: boolean;
|
|
267
|
+
disabled?: boolean;
|
|
268
|
+
readOnly?: boolean;
|
|
269
|
+
placeholder?: string;
|
|
270
|
+
/**
|
|
271
|
+
* `content` sizes each date to its text; `fixed` fits the widest date of the locale, so the field keeps its
|
|
272
|
+
* width as the range changes.
|
|
273
|
+
*
|
|
274
|
+
* @defaultValue "content"
|
|
275
|
+
*/
|
|
276
|
+
width?: DateRangeFieldWidth;
|
|
277
|
+
/**
|
|
278
|
+
* Formats the dates and reads typed dates in this locale's order.
|
|
279
|
+
*
|
|
280
|
+
* @defaultValue "en-US"
|
|
281
|
+
*/
|
|
282
|
+
locale?: string;
|
|
283
|
+
/**
|
|
284
|
+
* First column of the calendar: 0 is Sunday, 1 is Monday.
|
|
285
|
+
*
|
|
286
|
+
* @defaultValue 1
|
|
287
|
+
*/
|
|
288
|
+
weekStartsOn?: 0 | 1;
|
|
289
|
+
/** @defaultValue "Start date" */
|
|
290
|
+
startLabel?: string;
|
|
291
|
+
/** @defaultValue "End date" */
|
|
292
|
+
endLabel?: string;
|
|
293
|
+
/** @defaultValue "Choose dates" */
|
|
294
|
+
calendarLabel?: string;
|
|
295
|
+
calendarProps?: CalendarPopoverProps;
|
|
296
|
+
/** @defaultValue "Clear dates" */
|
|
297
|
+
clearLabel?: string;
|
|
298
|
+
/** @defaultValue "Previous month" */
|
|
299
|
+
previousMonthLabel?: string;
|
|
300
|
+
/** @defaultValue "Next month" */
|
|
301
|
+
nextMonthLabel?: string;
|
|
302
|
+
/** @defaultValue "Today" */
|
|
303
|
+
todayLabel?: string;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* A start and an end date in one field, typed or picked in a calendar (first click starts, second ends).
|
|
307
|
+
* Name it with `aria-labelledby` or `aria-label`; a `Label` whose `htmlFor` is `id` focuses the start.
|
|
308
|
+
*/
|
|
309
|
+
declare function DateRangeField({ value: valueProp, defaultValue, onValueChange, min, max, maxDays, isDateDisabled, clearable, disabled, readOnly, placeholder, width, locale, weekStartsOn, startLabel, endLabel, calendarLabel, calendarProps, clearLabel, previousMonthLabel, nextMonthLabel, todayLabel, id, className, "aria-invalid": ariaInvalid, ...props }: DateRangeFieldProps): React.JSX.Element;
|
|
310
|
+
/**
|
|
311
|
+
* A modal menu (the default) locks page scroll and sets `pointer-events: none` on `body`.
|
|
312
|
+
* Pass `modal={false}` inside an iframe sized to its content.
|
|
313
|
+
*/
|
|
314
|
+
declare const DropdownMenu: React.FC<DropdownMenuPrimitive.DropdownMenuProps>;
|
|
315
|
+
declare const DropdownMenuTrigger: React.ForwardRefExoticComponent<DropdownMenuPrimitive.DropdownMenuTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
316
|
+
declare const DropdownMenuGroup: React.ForwardRefExoticComponent<DropdownMenuPrimitive.DropdownMenuGroupProps & React.RefAttributes<HTMLDivElement>>;
|
|
317
|
+
declare const DropdownMenuPortal: React.FC<DropdownMenuPrimitive.DropdownMenuPortalProps>;
|
|
318
|
+
declare const DropdownMenuSub: React.FC<DropdownMenuPrimitive.DropdownMenuSubProps>;
|
|
319
|
+
type DropdownMenuContentProps = React.ComponentPropsWithRef<typeof DropdownMenuPrimitive.Content>;
|
|
320
|
+
/** Menu surface, portalled and positioned against the trigger. */
|
|
321
|
+
declare function DropdownMenuContent({ className, sideOffset, ref, onPointerDownOutside, ...props }: DropdownMenuContentProps): React.JSX.Element;
|
|
322
|
+
type DropdownMenuSubContentProps = React.ComponentPropsWithRef<typeof DropdownMenuPrimitive.SubContent>;
|
|
323
|
+
declare function DropdownMenuSubContent({ className, ...props }: DropdownMenuSubContentProps): React.JSX.Element;
|
|
324
|
+
type DropdownMenuSubTriggerProps = React.ComponentPropsWithRef<typeof DropdownMenuPrimitive.SubTrigger>;
|
|
325
|
+
declare function DropdownMenuSubTrigger({ className, children, ...props }: DropdownMenuSubTriggerProps): React.JSX.Element;
|
|
326
|
+
type DropdownMenuItemVariant = "default" | "destructive";
|
|
327
|
+
interface DropdownMenuItemProps extends React.ComponentPropsWithRef<typeof DropdownMenuPrimitive.Item> {
|
|
328
|
+
/** Icon in front of the label. */
|
|
329
|
+
leadingIcon?: SlotIcon;
|
|
330
|
+
/** Icon after the label. Set both for an icon on each side. */
|
|
331
|
+
trailingIcon?: SlotIcon;
|
|
332
|
+
/**
|
|
333
|
+
* `destructive` colours the item for irreversible actions such as
|
|
334
|
+
* delete or remove.
|
|
335
|
+
*
|
|
336
|
+
* @defaultValue "default"
|
|
337
|
+
*/
|
|
338
|
+
variant?: DropdownMenuItemVariant;
|
|
339
|
+
/**
|
|
340
|
+
* Marks the item that represents the current choice (the active tenant,
|
|
341
|
+
* the open model) and exposes it as `aria-current`.
|
|
342
|
+
*
|
|
343
|
+
* @defaultValue false
|
|
344
|
+
*/
|
|
345
|
+
selected?: boolean;
|
|
346
|
+
}
|
|
347
|
+
declare function DropdownMenuItem({ className, variant, selected, leadingIcon, trailingIcon, children, ...props }: DropdownMenuItemProps): React.JSX.Element;
|
|
348
|
+
type DropdownMenuSeparatorProps = React.ComponentPropsWithRef<typeof DropdownMenuPrimitive.Separator>;
|
|
349
|
+
declare function DropdownMenuSeparator({ className, ...props }: DropdownMenuSeparatorProps): React.JSX.Element;
|
|
350
|
+
type TooltipProviderProps = React.ComponentProps<typeof TooltipPrimitive.Provider>;
|
|
351
|
+
/**
|
|
352
|
+
* Shares the show delay across every tooltip below it and lets a neighbouring
|
|
353
|
+
* tooltip open instantly while one is already showing. Mount one near the app
|
|
354
|
+
* root; a `Tooltip` rendered outside any provider falls back to its own.
|
|
355
|
+
*/
|
|
356
|
+
declare function TooltipProvider(props: TooltipProviderProps): React.JSX.Element;
|
|
357
|
+
type TooltipProps = React.ComponentProps<typeof TooltipPrimitive.Root>;
|
|
358
|
+
declare function Tooltip(props: TooltipProps): React.JSX.Element;
|
|
359
|
+
/**
|
|
360
|
+
* Element that opens the tooltip on hover or focus. While open, it points to the content
|
|
361
|
+
* with `aria-describedby`, so do not repeat the same fact in `sr-only` text.
|
|
362
|
+
*/
|
|
363
|
+
declare const TooltipTrigger: React.ForwardRefExoticComponent<TooltipPrimitive.TooltipTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
364
|
+
type TooltipContentProps = React.ComponentPropsWithRef<typeof TooltipPrimitive.Content>;
|
|
365
|
+
/** Light surface hint shown on hover or focus of its trigger. */
|
|
366
|
+
declare function TooltipContent({ className, sideOffset, children, ...props }: TooltipContentProps): React.JSX.Element;
|
|
367
|
+
type HelpIconSize = "xs" | "sm" | "md";
|
|
368
|
+
interface HelpIconProps {
|
|
369
|
+
/** Explanation shown in the tooltip; doubles as the button's accessible name. */
|
|
370
|
+
text: string;
|
|
371
|
+
/**
|
|
372
|
+
* Icon size, in step with the text it sits next to.
|
|
373
|
+
*
|
|
374
|
+
* @defaultValue "xs"
|
|
375
|
+
*/
|
|
376
|
+
size?: HelpIconSize;
|
|
377
|
+
/**
|
|
378
|
+
* @defaultValue "top"
|
|
379
|
+
*/
|
|
380
|
+
side?: TooltipContentProps["side"];
|
|
381
|
+
/**
|
|
382
|
+
* @defaultValue "end"
|
|
383
|
+
*/
|
|
384
|
+
align?: TooltipContentProps["align"];
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Help icon that explains its subject in a tooltip; a real button, so the
|
|
388
|
+
* explanation is reachable by keyboard as well as on hover.
|
|
389
|
+
*/
|
|
390
|
+
declare function HelpIcon({ text, size, side, align }: HelpIconProps): React.JSX.Element;
|
|
391
|
+
interface InputGroupProps extends React.ComponentPropsWithRef<"div"> {}
|
|
392
|
+
/**
|
|
393
|
+
* Puts adornments (icons, small buttons) inside an Input's frame, or a text prefix before a NativeSelect's value.
|
|
394
|
+
* With a NativeSelect the frame fits its content; a `Label` in the prefix names the select:
|
|
395
|
+
*
|
|
396
|
+
* <InputGroup>
|
|
397
|
+
* <InputGroupPrefix><Label htmlFor="group-by">Group by</Label></InputGroupPrefix>
|
|
398
|
+
* <NativeSelect id="group-by">…</NativeSelect>
|
|
399
|
+
* </InputGroup>
|
|
400
|
+
*/
|
|
401
|
+
declare function InputGroup({ className, ...props }: InputGroupProps): React.JSX.Element;
|
|
402
|
+
interface InputGroupSlotProps extends React.ComponentPropsWithRef<"div"> {}
|
|
403
|
+
declare function InputGroupPrefix({ className, onMouseDown, ...props }: InputGroupSlotProps): React.JSX.Element;
|
|
404
|
+
interface LabelProps extends React.ComponentPropsWithRef<"label"> {
|
|
405
|
+
/**
|
|
406
|
+
* Appends the required marker after the label text.
|
|
407
|
+
*
|
|
408
|
+
* @defaultValue false
|
|
409
|
+
*/
|
|
410
|
+
required?: boolean;
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* Text label for a form control. Use it on its own next to any control, or
|
|
414
|
+
* inside `Field`, which adds the description and error around it.
|
|
415
|
+
*/
|
|
416
|
+
declare function Label({ className, required, children, ...props }: LabelProps): React.JSX.Element;
|
|
417
|
+
type LinkColor = "primary" | "inherit";
|
|
418
|
+
interface LinkStyleProps {
|
|
419
|
+
/**
|
|
420
|
+
* `primary` is the link colour; `inherit` keeps the surrounding text
|
|
421
|
+
* colour and relies on the underline (in muted copy, or a link per row).
|
|
422
|
+
*
|
|
423
|
+
* @defaultValue "primary"
|
|
424
|
+
*/
|
|
425
|
+
color?: LinkColor;
|
|
426
|
+
}
|
|
427
|
+
interface LinkProps extends LinkStyleProps, Omit<React.ComponentPropsWithRef<"a">, "color"> {
|
|
428
|
+
/** Renders the child (e.g. Next.js `Link`) with the link styles instead of an `<a>`. */
|
|
429
|
+
asChild?: boolean;
|
|
430
|
+
/**
|
|
431
|
+
* Opens in a new tab: adds `target="_blank"`, `rel="noopener noreferrer"`
|
|
432
|
+
* and an external-link icon, and appends `externalLabel` for screen readers.
|
|
433
|
+
*/
|
|
434
|
+
external?: boolean;
|
|
435
|
+
/** @defaultValue "(opens in a new tab)" */
|
|
436
|
+
externalLabel?: string;
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* A link inside text: the link colour, an underline that strengthens on
|
|
440
|
+
* hover, and the focus ring. Use `asChild` for a router link, `external` for
|
|
441
|
+
* another site. For an action inside a sentence (opening a dialog), use
|
|
442
|
+
* `LinkButton`.
|
|
443
|
+
*/
|
|
444
|
+
declare function Link({ className, color, asChild, external, externalLabel, target, rel, children, ...props }: LinkProps): React.JSX.Element;
|
|
445
|
+
interface NativeSelectProps extends React.ComponentPropsWithRef<"select"> {
|
|
446
|
+
/** Shows the value at full contrast but won't open or change; a native `<select>` ignores `readonly`. */
|
|
447
|
+
readOnly?: boolean;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Styled native `<select>`; the browser owns the option list.
|
|
451
|
+
*
|
|
452
|
+
* @remarks
|
|
453
|
+
* `className` lands on the wrapping element so callers can size the control;
|
|
454
|
+
* every other prop goes to the `<select>`. An `aria-invalid` select shows the
|
|
455
|
+
* error border. Use `Select` when the option list needs custom rendering.
|
|
456
|
+
*/
|
|
457
|
+
declare function NativeSelect({ className, children, readOnly, ...props }: NativeSelectProps): React.JSX.Element;
|
|
458
|
+
interface NativeSelectOptionProps extends React.ComponentPropsWithRef<"option"> {}
|
|
459
|
+
declare function NativeSelectOption(props: NativeSelectOptionProps): React.JSX.Element;
|
|
460
|
+
interface PaginationBaseProps extends Omit<React.ComponentPropsWithRef<"nav">, "onChange"> {
|
|
461
|
+
/** The current page, 1-based. */
|
|
462
|
+
current: number;
|
|
463
|
+
onPageChange: (page: number) => void;
|
|
464
|
+
previousLabel: string;
|
|
465
|
+
nextLabel: string;
|
|
466
|
+
/** Accessible label for a numbered page button. */
|
|
467
|
+
pageLabel: (page: number) => string;
|
|
468
|
+
}
|
|
469
|
+
interface CursorPaginationProps extends PaginationBaseProps {
|
|
470
|
+
hasPrevious: boolean;
|
|
471
|
+
hasNext: boolean;
|
|
472
|
+
pageCount?: never;
|
|
473
|
+
}
|
|
474
|
+
interface CountedPaginationProps extends PaginationBaseProps {
|
|
475
|
+
/** Total number of pages: shows the first and last page, the pages next to `current`, and an ellipsis for skipped pages. */
|
|
476
|
+
pageCount: number;
|
|
477
|
+
hasPrevious?: never;
|
|
478
|
+
hasNext?: never;
|
|
479
|
+
}
|
|
480
|
+
type PaginationProps = CursorPaginationProps | CountedPaginationProps;
|
|
481
|
+
/**
|
|
482
|
+
* Previous/next page navigation, with the first and last page when `pageCount` is set.
|
|
483
|
+
* Renders nothing for one page; the end buttons stay focusable (`aria-disabled`).
|
|
484
|
+
*/
|
|
485
|
+
declare function Pagination({ className, current, pageCount, hasPrevious: cursorHasPrevious, hasNext: cursorHasNext, onPageChange, previousLabel, nextLabel, pageLabel, ...props }: PaginationProps): React.JSX.Element | null;
|
|
486
|
+
interface SearchInputProps extends InputProps {
|
|
487
|
+
containerProps?: React.ComponentPropsWithoutRef<"div">;
|
|
488
|
+
}
|
|
489
|
+
declare function SearchInput({ className, containerProps, ...props }: SearchInputProps): React.JSX.Element;
|
|
490
|
+
declare namespace SearchInput {
|
|
491
|
+
var displayName: string;
|
|
492
|
+
}
|
|
493
|
+
type SkeletonShape = "rounded" | "pill";
|
|
494
|
+
interface SkeletonProps extends React.ComponentPropsWithRef<"div"> {
|
|
495
|
+
/**
|
|
496
|
+
* `rounded` stands in for blocks of text and controls; `pill` for badges,
|
|
497
|
+
* chips and avatars.
|
|
498
|
+
*
|
|
499
|
+
* @defaultValue "rounded"
|
|
500
|
+
*/
|
|
501
|
+
shape?: SkeletonShape;
|
|
502
|
+
}
|
|
503
|
+
/** Pulsing placeholder block for content that is still loading; size it with `className`. */
|
|
504
|
+
declare function Skeleton({ className, shape, ...props }: SkeletonProps): React.JSX.Element;
|
|
505
|
+
type StatusScreenVariant = "page" | "inline";
|
|
506
|
+
interface StatusScreenProps extends React.ComponentPropsWithRef<"div"> {
|
|
507
|
+
/**
|
|
508
|
+
* `page` fills the available height and centres the content in it (page
|
|
509
|
+
* states such as not-found, forbidden, no-access). `inline` renders the
|
|
510
|
+
* same composition compactly inside content that already has a header —
|
|
511
|
+
* an empty table body, an empty list.
|
|
512
|
+
*
|
|
513
|
+
* @defaultValue "page"
|
|
514
|
+
*/
|
|
515
|
+
variant?: StatusScreenVariant;
|
|
516
|
+
/** Extra class names for the centred content column, e.g. to widen it. */
|
|
517
|
+
contentClassName?: string;
|
|
518
|
+
}
|
|
519
|
+
/**
|
|
520
|
+
* Centred status/empty state: icon tile, title, description and actions.
|
|
521
|
+
*
|
|
522
|
+
* @remarks
|
|
523
|
+
* Compose with `StatusScreenIcon`, `StatusScreenTitle`,
|
|
524
|
+
* `StatusScreenDescription` and `StatusScreenActions` (plus any extra
|
|
525
|
+
* children). The sub-components are named exports, not `StatusScreen.Icon`
|
|
526
|
+
* static properties: the module is shared by React Server and Client
|
|
527
|
+
* Components, and properties assigned onto a function do not survive an RSC
|
|
528
|
+
* client-reference boundary (they arrive as `undefined` and crash the render
|
|
529
|
+
* with React error #130).
|
|
530
|
+
*/
|
|
531
|
+
declare function StatusScreen({ className, contentClassName, variant, children, ...props }: StatusScreenProps): React.JSX.Element;
|
|
532
|
+
interface StatusScreenIconProps extends React.ComponentPropsWithRef<"div"> {}
|
|
533
|
+
/** Bordered tile that frames the status glyph passed as children. */
|
|
534
|
+
declare function StatusScreenIcon({ className, ...props }: StatusScreenIconProps): React.JSX.Element;
|
|
535
|
+
type StatusScreenTitleLevel = "h1" | "h2" | "h3";
|
|
536
|
+
interface StatusScreenTitleProps extends React.ComponentPropsWithRef<"h1"> {
|
|
537
|
+
/**
|
|
538
|
+
* Heading element to render. Page states own the page and use `h1`;
|
|
539
|
+
* inline states sit under an existing heading and should step down.
|
|
540
|
+
*
|
|
541
|
+
* @defaultValue "h1"
|
|
542
|
+
*/
|
|
543
|
+
as?: StatusScreenTitleLevel;
|
|
544
|
+
}
|
|
545
|
+
declare function StatusScreenTitle({ as: Heading, className, ...props }: StatusScreenTitleProps): React.JSX.Element;
|
|
546
|
+
interface StatusScreenDescriptionProps extends React.ComponentPropsWithRef<"p"> {}
|
|
547
|
+
declare function StatusScreenDescription({ className, ...props }: StatusScreenDescriptionProps): React.JSX.Element;
|
|
548
|
+
interface StatusScreenActionsProps extends React.ComponentPropsWithRef<"div"> {}
|
|
549
|
+
/** Row of calls to action below the description; stacks on narrow viewports. */
|
|
550
|
+
declare function StatusScreenActions({ className, ...props }: StatusScreenActionsProps): React.JSX.Element;
|
|
551
|
+
interface SwitchProps extends Omit<React.ComponentPropsWithRef<"button">, "type" | "role" | "aria-checked"> {
|
|
552
|
+
checked?: boolean;
|
|
553
|
+
defaultChecked?: boolean;
|
|
554
|
+
onCheckedChange?: (checked: boolean) => void;
|
|
555
|
+
/** Shows the state at full contrast but won't toggle; a `<button>` ignores `readonly`. */
|
|
556
|
+
readOnly?: boolean;
|
|
557
|
+
}
|
|
558
|
+
declare function Switch({ className, checked, defaultChecked, onCheckedChange, onClick, readOnly, ...props }: SwitchProps): React.JSX.Element;
|
|
559
|
+
type TableVariant = "default" | "plain";
|
|
560
|
+
interface TableProps extends React.ComponentPropsWithRef<"table"> {
|
|
561
|
+
containerProps?: React.ComponentPropsWithRef<"div">;
|
|
562
|
+
/**
|
|
563
|
+
* Set to false when the table sits inside a `TableCard`, which already
|
|
564
|
+
* draws the border and radius.
|
|
565
|
+
*/
|
|
566
|
+
bordered?: boolean;
|
|
567
|
+
/**
|
|
568
|
+
* `default` applies the design-system look (header bar, zebra rows,
|
|
569
|
+
* hover, cell padding). `plain` keeps only the frame and semantics so a
|
|
570
|
+
* table can lay out its own cells — sticky columns, dense rows, custom
|
|
571
|
+
* hover.
|
|
572
|
+
*
|
|
573
|
+
* @defaultValue "default"
|
|
574
|
+
*/
|
|
575
|
+
variant?: TableVariant;
|
|
576
|
+
}
|
|
577
|
+
declare function Table({ className, containerProps, bordered, variant, ...props }: TableProps): React.JSX.Element;
|
|
578
|
+
interface TableHeaderProps extends React.ComponentPropsWithRef<"thead"> {}
|
|
579
|
+
declare function TableHeader({ className, ...props }: TableHeaderProps): React.JSX.Element;
|
|
580
|
+
interface TableBodyProps extends React.ComponentPropsWithRef<"tbody"> {}
|
|
581
|
+
declare function TableBody({ className, ...props }: TableBodyProps): React.JSX.Element;
|
|
582
|
+
interface TableRowProps extends React.ComponentPropsWithRef<"tr"> {
|
|
583
|
+
/** Paints the row in the primary color, for multi-select tables. */
|
|
584
|
+
selected?: boolean;
|
|
585
|
+
}
|
|
586
|
+
declare function TableRow({ className, selected, ...props }: TableRowProps): React.JSX.Element;
|
|
587
|
+
interface TableHeadCellProps extends React.ComponentPropsWithRef<"th"> {}
|
|
588
|
+
declare function TableHeadCell({ className, ...props }: TableHeadCellProps): React.JSX.Element;
|
|
589
|
+
interface TableCellProps extends React.ComponentPropsWithRef<"td"> {}
|
|
590
|
+
declare function TableCell({ className, ...props }: TableCellProps): React.JSX.Element;
|
|
591
|
+
type TabsOrientation = "horizontal" | "vertical";
|
|
592
|
+
interface TabsProps extends Omit<React.ComponentPropsWithRef<"div">, "defaultValue"> {
|
|
593
|
+
value?: string;
|
|
594
|
+
defaultValue?: string;
|
|
595
|
+
onValueChange?: (value: string) => void;
|
|
596
|
+
/** @defaultValue "horizontal" */
|
|
597
|
+
orientation?: TabsOrientation;
|
|
598
|
+
}
|
|
599
|
+
interface TabsListProps extends React.ComponentPropsWithRef<"div"> {}
|
|
600
|
+
interface TabsTriggerProps extends Omit<React.ComponentPropsWithRef<"button">, "value"> {
|
|
601
|
+
value: string;
|
|
602
|
+
/** Icon in front of the label. */
|
|
603
|
+
leadingIcon?: SlotIcon;
|
|
604
|
+
/** Icon after the label. Set both for an icon on each side. */
|
|
605
|
+
trailingIcon?: SlotIcon;
|
|
606
|
+
}
|
|
607
|
+
interface TabsContentProps extends Omit<React.ComponentPropsWithRef<"div">, "value"> {
|
|
608
|
+
value: string;
|
|
609
|
+
/**
|
|
610
|
+
* Keeps the panel in the DOM while inactive (as `hidden`) instead of
|
|
611
|
+
* unmounting it.
|
|
612
|
+
*
|
|
613
|
+
* @defaultValue false
|
|
614
|
+
*/
|
|
615
|
+
forceMount?: boolean;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* Accessible tab set with automatic activation: arrow keys, Home and End
|
|
619
|
+
* move focus and select in one step.
|
|
620
|
+
*/
|
|
621
|
+
declare function Tabs({ className, value, defaultValue, onValueChange, orientation, ...props }: TabsProps): React.JSX.Element;
|
|
622
|
+
declare function TabsList({ className, onKeyDown, ...props }: TabsListProps): React.JSX.Element;
|
|
623
|
+
declare function TabsTrigger({ className, value, onClick, leadingIcon, trailingIcon, children, ...props }: TabsTriggerProps): React.JSX.Element;
|
|
624
|
+
declare function TabsContent({ className, value, forceMount, ...props }: TabsContentProps): React.JSX.Element | null;
|
|
625
|
+
type ToastVariant = "info" | "success" | "error";
|
|
626
|
+
type ToastPosition = "top-right" | "top-left" | "bottom-right" | "bottom-left";
|
|
627
|
+
interface ToastViewportProps extends React.ComponentPropsWithRef<"ol"> {
|
|
628
|
+
/** Accessible name of the notifications region. */
|
|
629
|
+
label: string;
|
|
630
|
+
/**
|
|
631
|
+
* Screen corner the stack is pinned to.
|
|
632
|
+
*
|
|
633
|
+
* @defaultValue "bottom-right"
|
|
634
|
+
*/
|
|
635
|
+
position?: ToastPosition;
|
|
636
|
+
}
|
|
637
|
+
interface ToastProps extends React.ComponentPropsWithRef<"li"> {
|
|
638
|
+
/**
|
|
639
|
+
* @defaultValue "info"
|
|
640
|
+
*/
|
|
641
|
+
variant?: ToastVariant;
|
|
642
|
+
/**
|
|
643
|
+
* `false` plays the exit animation; the owner removes the toast once it
|
|
644
|
+
* has finished.
|
|
645
|
+
*
|
|
646
|
+
* @defaultValue true
|
|
647
|
+
*/
|
|
648
|
+
open?: boolean;
|
|
649
|
+
}
|
|
650
|
+
type ToastDescriptionProps = Omit<React.ComponentPropsWithRef<"div">, "ref">;
|
|
651
|
+
type ToastCloseProps = React.ComponentPropsWithRef<"button">;
|
|
652
|
+
/**
|
|
653
|
+
* Fixed-position stack that holds the app's toasts; render the open toasts as its children.
|
|
654
|
+
* Mount it before the first toast: its live regions must be in the page before a message arrives.
|
|
655
|
+
*/
|
|
656
|
+
declare function ToastViewport({ label, position, className, ...props }: ToastViewportProps): React.JSX.Element;
|
|
657
|
+
/**
|
|
658
|
+
* Brief message; the viewport announces the text of its `ToastDescription` when it opens,
|
|
659
|
+
* an error assertively and every other variant politely.
|
|
660
|
+
*/
|
|
661
|
+
declare function Toast({ variant, open, className, children, ...props }: ToastProps): React.JSX.Element;
|
|
662
|
+
declare function ToastDescription({ className, ...props }: ToastDescriptionProps): React.JSX.Element;
|
|
663
|
+
declare function ToastClose({ className, ...props }: ToastCloseProps): React.JSX.Element;
|
|
664
|
+
export { Alert, AlertDescription, type AlertDescriptionProps, type AlertProps, AlertTitle, type AlertTitleProps, type AlertVariant, Badge, type BadgeColor, Button, type ButtonProps, type ButtonSize, type ButtonVariant, Checkbox, ControlRow, type ControlRowAlign, type ControlRowProps, CopyValueButton, DateField, DateRangeField, DropdownMenu, DropdownMenuContent, type DropdownMenuContentProps, DropdownMenuGroup, DropdownMenuItem, DropdownMenuPortal, DropdownMenuSeparator, type DropdownMenuSeparatorProps, DropdownMenuSub, DropdownMenuSubContent, type DropdownMenuSubContentProps, DropdownMenuSubTrigger, type DropdownMenuSubTriggerProps, DropdownMenuTrigger, HelpIcon, InputGroup, InputGroupPrefix, type InputGroupProps, type InputGroupSlotProps, Label, type LabelProps, Link, type LinkProps, NativeSelect, NativeSelectOption, type NativeSelectOptionProps, type NativeSelectProps, Pagination, Popover, PopoverAnchor, PopoverContent, PopoverTrigger, SearchInput, Skeleton, type SkeletonProps, type SkeletonShape, type SlotIcon, StatusScreen, StatusScreenActions, type StatusScreenActionsProps, StatusScreenDescription, type StatusScreenDescriptionProps, StatusScreenIcon, type StatusScreenIconProps, type StatusScreenProps, StatusScreenTitle, type StatusScreenTitleLevel, type StatusScreenTitleProps, type StatusScreenVariant, Switch, type SwitchProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableHeadCell, type TableHeadCellProps, TableHeader, type TableHeaderProps, TableRow, type TableRowProps, Tabs, TabsContent, type TabsContentProps, TabsList, TabsTrigger, Toast, ToastClose, ToastDescription, type ToastVariant, ToastViewport, Tooltip, TooltipContent, type TooltipContentProps, TooltipProvider, TooltipTrigger };
|