@vesture/react 0.2.9 → 0.3.0

package/dist/index.d.ts

@@ -539,4 +539,235 @@ interface TreeViewProps<T = unknown> {
 
 declare function TreeView<T = unknown>({ nodes, expanded: controlledExpanded, defaultExpanded, onExpandedChange, selected: controlledSelected, defaultSelected, onSelectedChange, selectable, onLoadChildren, height, rowHeight, }: TreeViewProps<T>): ReactElement;
 
-export { Accordion, AccordionContent, type AccordionContentProps, AccordionItem, type AccordionItemProps, type AccordionProps, AccordionTrigger, type AccordionTriggerProps, Alert, type AlertProps, type AlertVariant, Avatar, type AvatarProps, type AvatarSize, type AvatarStatus, Badge, type BadgeProps, type BadgeVariant, Breadcrumbs, BreadcrumbsItem, type BreadcrumbsItemProps, type BreadcrumbsProps, Button, type ButtonProps, type ButtonVariant, Calendar, type CalendarProps, Card, type CardElevation, type CardProps, Checkbox, type CheckboxProps, Combobox, type ComboboxOption, type ComboboxProps, DataGrid, type DataGridColumn, type DataGridExportOptions, type DataGridHandle, type DataGridProps, DatePicker, type DatePickerProps, type DateRange, DateRangePicker, type DateRangePickerProps, Divider, type DividerOrientation, type DividerProps, DropdownMenu, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, Input, type InputProps, Label, type LabelProps, Modal, type ModalProps, NumberInput, type NumberInputProps, Pagination, type PaginationProps, Popover, type PopoverProps, Progress, type ProgressProps, Radio, type RadioProps, Select, type SelectProps, Slider, type SliderProps, type SliderValue, type SortDirection, type SortState, Spinner, type SpinnerProps, type SpinnerSize, Stack, type StackAlign, type StackDirection, type StackGap, type StackJustify, type StackProps, Switch, type SwitchProps, Tabs, TabsList, type TabsListProps, TabsPanel, type TabsPanelProps, type TabsProps, TabsTrigger, type TabsTriggerProps, Textarea, type TextareaProps, type ToastContextValue, type ToastOptions, ToastProvider, type ToastVariant, Tooltip, type TooltipProps, type TreeNode, TreeView, type TreeViewProps, type TreeViewSelectable, useToast };
+interface CommandItem {
+    id: string;
+    label: string;
+    description?: string;
+    icon?: ReactNode;
+    /** Extra searchable terms not shown in the label. */
+    keywords?: string[];
+    /** Display-only, e.g. "⌘K". */
+    shortcut?: string;
+    /** Groups render under a section header, in the order groups first appear in `commands`. */
+    group?: string;
+    onSelect: () => void;
+    disabled?: boolean;
+}
+interface CommandPaletteProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    commands: CommandItem[];
+    placeholder?: string;
+    emptyMessage?: string;
+    /** Overrides the default case-insensitive substring match against label + keywords + group. */
+    filterCommands?: (commands: CommandItem[], query: string) => CommandItem[];
+    /** Number of rows (commands + group headers) at/above which the list switches to virtualized rendering. */
+    virtualizationThreshold?: number;
+    /** Row height (px) used for virtualized rows; defaults to the `.option` class's rendered height. */
+    rowHeight?: number;
+    "aria-label"?: string;
+}
+
+declare function CommandPalette({ open, onOpenChange, commands, placeholder, emptyMessage, filterCommands, virtualizationThreshold, rowHeight, "aria-label": ariaLabel }: CommandPaletteProps): ReactElement | null;
+
+interface UseCommandPaletteShortcutOptions {
+    key?: string;
+    metaKey?: boolean;
+    ctrlKey?: boolean;
+}
+/**
+ * Attaches a document-level Cmd+K (Mac) / Ctrl+K (elsewhere) listener that
+ * calls onOpenChange(true). Separate from CommandPalette so consumers can
+ * wire their own trigger instead.
+ */
+declare function useCommandPaletteShortcut(onOpenChange: (open: boolean) => void, options?: UseCommandPaletteShortcutOptions): void;
+
+/** A single row of chart data. `x` is the shared category/position for every series; each series' value is looked up by its `key` on this object. */
+interface LineChartDataPoint {
+    x: string | number | Date;
+    [seriesKey: string]: string | number | Date;
+}
+interface LineChartSeries {
+    key: string;
+    label: string;
+    /** Overrides the auto-assigned series1-8 token color for this series. */
+    color?: string;
+}
+type LineChartXScaleType = "linear" | "time" | "band";
+interface LineChartMargin {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+/** Props shared by the static `LineChart` and the client-only `InteractiveLineChart`. */
+interface LineChartBaseProps {
+    data: LineChartDataPoint[];
+    series: LineChartSeries[];
+    /** Defaults to inferring from the first data point's `x` type (Date -> time, number -> linear, string -> band). */
+    xScale?: LineChartXScaleType;
+    margin?: Partial<LineChartMargin>;
+}
+
+interface LineChartProps extends LineChartBaseProps {
+    width: number;
+    height: number;
+}
+/**
+ * Server-safe, zero-JS line chart. Renders a static SVG with no event handlers — use it in
+ * server components, static reports, or anywhere a hover tooltip/legend isn't needed. For a
+ * dashboard-style chart with hover tooltips and a toggleable legend, use `InteractiveLineChart`
+ * instead (it wraps this component and requires client-side JS).
+ */
+declare function LineChart({ data, series, width, height, margin, xScale }: LineChartProps): ReactElement;
+
+interface InteractiveLineChartProps extends LineChartBaseProps {
+    /** Fixed chart height; width auto-tracks the parent container's size via ResizeObserver. */
+    height?: number;
+}
+/**
+ * Client-rendered line chart for dashboards: auto-sizes to its parent (via `@visx/responsive`'s
+ * `ParentSize`), and adds a hover tooltip plus a click-to-toggle legend. Requires client-side JS
+ * ("use client") — for server components or static output where no interaction is needed, use
+ * the static `LineChart` instead.
+ */
+declare function InteractiveLineChart({ data, series, margin, xScale, height }: InteractiveLineChartProps): ReactElement;
+
+/** A single category's row of chart data. Each series' value is looked up by its `key` on this object. */
+interface BarChartDataPoint {
+    category: string;
+    [seriesKey: string]: string | number;
+}
+interface BarChartSeries {
+    key: string;
+    label: string;
+    /** Overrides the auto-assigned series1-8 token color for this series. */
+    color?: string;
+}
+/** 'grouped': series render as side-by-side bars per category. 'stacked': series stack into one bar per category. */
+type BarChartLayout = "grouped" | "stacked";
+interface BarChartMargin {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+/** Props shared by the static `BarChart` and the client-only `InteractiveBarChart`. */
+interface BarChartBaseProps {
+    data: BarChartDataPoint[];
+    series: BarChartSeries[];
+    /** Defaults to 'grouped'. */
+    layout?: BarChartLayout;
+    margin?: Partial<BarChartMargin>;
+}
+
+interface BarChartProps extends BarChartBaseProps {
+    width: number;
+    height: number;
+}
+/**
+ * Server-safe, zero-JS bar chart. Renders a static SVG with no event handlers — use it in
+ * server components, static reports, or anywhere a hover tooltip/legend isn't needed. For a
+ * dashboard-style chart with hover tooltips and a toggleable legend, use `InteractiveBarChart`
+ * instead (it wraps this component and requires client-side JS).
+ */
+declare function BarChart({ data, series, width, height, margin, layout }: BarChartProps): ReactElement;
+
+interface InteractiveBarChartProps extends BarChartBaseProps {
+    /** Fixed chart height; width auto-tracks the parent container's size via ResizeObserver. */
+    height?: number;
+}
+/**
+ * Client-rendered bar chart for dashboards: auto-sizes to its parent (via `@visx/responsive`'s
+ * `ParentSize`), and adds a per-bar hover tooltip plus a click-to-toggle legend. Requires
+ * client-side JS ("use client") — for server components or static output where no interaction
+ * is needed, use the static `BarChart` instead.
+ */
+declare function InteractiveBarChart({ data, series, margin, layout, height }: InteractiveBarChartProps): ReactElement;
+
+type AreaChartDataPoint = LineChartDataPoint;
+type AreaChartSeries = LineChartSeries;
+type AreaChartMargin = LineChartMargin;
+type AreaChartXScaleType = LineChartXScaleType;
+/** Props shared by the static `AreaChart` and the client-only `InteractiveAreaChart`. */
+interface AreaChartBaseProps {
+    data: AreaChartDataPoint[];
+    series: AreaChartSeries[];
+    /** Defaults to inferring from the first data point's `x` type (Date -> time, number -> linear, string -> band). */
+    xScale?: AreaChartXScaleType;
+    margin?: Partial<AreaChartMargin>;
+    /** When true, series stack cumulatively into one filled region per x. When false (default), series overlap with partial opacity so all remain visible. */
+    stacked?: boolean;
+}
+
+interface AreaChartProps extends AreaChartBaseProps {
+    width: number;
+    height: number;
+}
+/**
+ * Server-safe, zero-JS area chart. Renders a static SVG with no event handlers — use it in
+ * server components, static reports, or anywhere a hover tooltip/legend isn't needed. For a
+ * dashboard-style chart with hover tooltips and a toggleable legend, use `InteractiveAreaChart`
+ * instead (it wraps this component and requires client-side JS).
+ */
+declare function AreaChart({ data, series, width, height, margin, xScale, stacked }: AreaChartProps): ReactElement;
+
+interface InteractiveAreaChartProps extends AreaChartBaseProps {
+    /** Fixed chart height; width auto-tracks the parent container's size via ResizeObserver. */
+    height?: number;
+}
+/**
+ * Client-rendered area chart for dashboards: auto-sizes to its parent (via `@visx/responsive`'s
+ * `ParentSize`), and adds a nearest-point hover tooltip plus a click-to-toggle legend — the same
+ * continuous-x-axis hover technique `InteractiveLineChart` uses (an area chart behaves like a
+ * line chart for hover purposes, not like BarChart's discrete per-element hover). Requires
+ * client-side JS ("use client") — for server components or static output where no interaction
+ * is needed, use the static `AreaChart` instead.
+ */
+declare function InteractiveAreaChart({ data, series, margin, xScale, stacked, height }: InteractiveAreaChartProps): ReactElement;
+
+interface PieChartDataPoint {
+    key: string;
+    label: string;
+    value: number;
+    /** Overrides the auto-assigned series1-8 token color for this slice. */
+    color?: string;
+}
+/** Props shared by the static `PieChart` and the client-only `InteractivePieChart`. */
+interface PieChartBaseProps {
+    data: PieChartDataPoint[];
+    /** Fraction of outerRadius carved out as a center hole: 0 (default) = full pie, e.g. 0.6 = donut. */
+    innerRadius?: number;
+    /** Whether to render in-slice percentage labels on slices wide enough to fit one. Defaults to true. */
+    showLabels?: boolean;
+}
+
+interface PieChartProps extends PieChartBaseProps {
+    width: number;
+    height: number;
+}
+/**
+ * Server-safe, zero-JS pie/donut chart. Renders a static SVG with no event handlers — use it
+ * in server components, static reports, or anywhere a hover tooltip/legend isn't needed. For a
+ * dashboard-style chart with per-slice hover emphasis, a tooltip, and a toggleable legend, use
+ * `InteractivePieChart` instead (it wraps this component and requires client-side JS).
+ */
+declare function PieChart({ data, width, height, innerRadius, showLabels }: PieChartProps): ReactElement;
+
+interface InteractivePieChartProps extends PieChartBaseProps {
+    /** Fixed chart height; width auto-tracks the parent container's size via ResizeObserver. */
+    height?: number;
+}
+/**
+ * Client-rendered pie/donut chart for dashboards: auto-sizes to its parent (via
+ * `@visx/responsive`'s `ParentSize`), and adds per-slice hover emphasis, a tooltip, and a
+ * click-to-toggle legend. Requires client-side JS ("use client") — for server components or
+ * static output where no interaction is needed, use the static `PieChart` instead.
+ *
+ * Unlike Line/Bar/AreaChart's legend toggle (which just removes a series), hiding a slice here
+ * *redistributes* the remaining slices' percentages, since a pie's slices must sum to 100 — see
+ * `computePercentages` in `PieChart.render.ts`, re-run over only the still-visible slices.
+ */
+declare function InteractivePieChart({ data, innerRadius, showLabels, height }: InteractivePieChartProps): ReactElement;
+
+export { Accordion, AccordionContent, type AccordionContentProps, AccordionItem, type AccordionItemProps, type AccordionProps, AccordionTrigger, type AccordionTriggerProps, Alert, type AlertProps, type AlertVariant, AreaChart, type AreaChartBaseProps, type AreaChartDataPoint, type AreaChartMargin, type AreaChartProps, type AreaChartSeries, type AreaChartXScaleType, Avatar, type AvatarProps, type AvatarSize, type AvatarStatus, Badge, type BadgeProps, type BadgeVariant, BarChart, type BarChartBaseProps, type BarChartDataPoint, type BarChartLayout, type BarChartMargin, type BarChartProps, type BarChartSeries, Breadcrumbs, BreadcrumbsItem, type BreadcrumbsItemProps, type BreadcrumbsProps, Button, type ButtonProps, type ButtonVariant, Calendar, type CalendarProps, Card, type CardElevation, type CardProps, Checkbox, type CheckboxProps, Combobox, type ComboboxOption, type ComboboxProps, type CommandItem, CommandPalette, type CommandPaletteProps, DataGrid, type DataGridColumn, type DataGridExportOptions, type DataGridHandle, type DataGridProps, DatePicker, type DatePickerProps, type DateRange, DateRangePicker, type DateRangePickerProps, Divider, type DividerOrientation, type DividerProps, DropdownMenu, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, Input, type InputProps, InteractiveAreaChart, type InteractiveAreaChartProps, InteractiveBarChart, type InteractiveBarChartProps, InteractiveLineChart, type InteractiveLineChartProps, InteractivePieChart, type InteractivePieChartProps, Label, type LabelProps, LineChart, type LineChartBaseProps, type LineChartDataPoint, type LineChartMargin, type LineChartProps, type LineChartSeries, type LineChartXScaleType, Modal, type ModalProps, NumberInput, type NumberInputProps, Pagination, type PaginationProps, PieChart, type PieChartBaseProps, type PieChartDataPoint, type PieChartProps, Popover, type PopoverProps, Progress, type ProgressProps, Radio, type RadioProps, Select, type SelectProps, Slider, type SliderProps, type SliderValue, type SortDirection, type SortState, Spinner, type SpinnerProps, type SpinnerSize, Stack, type StackAlign, type StackDirection, type StackGap, type StackJustify, type StackProps, Switch, type SwitchProps, Tabs, TabsList, type TabsListProps, TabsPanel, type TabsPanelProps, type TabsProps, TabsTrigger, type TabsTriggerProps, Textarea, type TextareaProps, type ToastContextValue, type ToastOptions, ToastProvider, type ToastVariant, Tooltip, type TooltipProps, type TreeNode, TreeView, type TreeViewProps, type TreeViewSelectable, type UseCommandPaletteShortcutOptions, useCommandPaletteShortcut, useToast };