@pantheon-systems/pds-toolkit-react 2.0.0-alpha.3 → 2.0.0-alpha.30

package/dist/components/charts/shared/formatters.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Format a number with K/M/B suffixes for chart axis labels.
+ */
+export declare const formatCompactNumber: (value: number) => string;
+/**
+ * Format a number with locale-aware thousand separators.
+ */
+export declare const formatLocaleNumber: (value: number) => string;
+/**
+ * Format a number as a percentage.
+ */
+export declare const formatPercent: (value: number) => string;

package/dist/components/charts/shared/types.d.ts

@@ -0,0 +1,128 @@
+import type { ReactNode } from 'react';
+export interface ChartDataPoint {
+    /** One or more numeric series values, keyed by series name */
+    [key: string]: number | string;
+    /** X-axis label */
+    label: string;
+}
+export type StrokeStyle = 'dashed' | 'solid';
+export interface SeriesConfig {
+    /** Override default token color (CSS custom property or hex). Not theme-aware — use paletteIndex for theme-aware overrides. */
+    color?: string;
+    /** Key matching a property in ChartDataPoint */
+    dataKey: string;
+    /** Display label for legend/tooltip */
+    label: string;
+    /** Pick a specific color from the selected palette by position (1-based). Theme-aware — automatically adjusts for light/dark mode. */
+    paletteIndex?: number;
+    /** Line style (LineChart only) */
+    strokeStyle?: StrokeStyle;
+}
+export interface ReferenceLineConfig {
+    /** Color override */
+    color?: string;
+    /** Display label */
+    label: string;
+    /** Line style */
+    strokeStyle?: StrokeStyle;
+    /** Y-axis value where line appears */
+    value: number;
+}
+export interface AnnotationConfig {
+    /** X-axis label value to annotate */
+    atLabel: string;
+    /** Color override */
+    color?: string;
+    /** Line style */
+    strokeStyle?: StrokeStyle;
+    /** Display text */
+    text: string;
+}
+export interface TimePeriodOption {
+    /** Display label ("Last 30 Days") */
+    label: string;
+    /** Value identifier */
+    value: string;
+}
+export type ColorPalette = 'categorical' | 'diverging-a' | 'diverging-b' | 'sequential-gray' | 'sequential-iris' | 'sequential-multi' | 'single' | 'status';
+export type LegendVariant = 'inline' | 'table';
+export interface TooltipEntry {
+    /** Series bar/line color */
+    color: string;
+    /** Series data key */
+    dataKey: string;
+    /** Series display name */
+    name: string;
+    /** Data value */
+    value: number;
+}
+export interface TooltipPayload {
+    /** All series entries for this x-axis position */
+    entries: TooltipEntry[];
+    /** X-axis label */
+    label: string;
+}
+export type YAxisDomainItem = number | string | ((dataMax: number) => number);
+export type YAxisDomain = [YAxisDomainItem, YAxisDomainItem];
+export interface ChartLabelStrings {
+    /** Accessible description for the hidden data table. */
+    accessibleTableDescription?: string;
+    /** Heading for the empty state. */
+    emptyStateHeading?: string;
+    /** Message body for the empty state. */
+    emptyStateMessage?: string;
+    /** Table header for the totals column when legendVariant is 'table'. */
+    legendTableHeader?: string;
+    /** Loading label for screen readers. */
+    loadingLabel?: string;
+}
+export interface BaseChartProps {
+    /** Height of the chart area in pixels. Does not include the legend, header, or accessible table. */
+    chartHeight?: number;
+    /** Maximum width of the chart component in pixels. The chart is responsive and will shrink within this constraint. */
+    chartWidth?: number;
+    /** Color palette to use for series colors (default: 'categorical') */
+    colorPalette?: ColorPalette;
+    /** Chart data points */
+    data: ChartDataPoint[];
+    /** Show loading state */
+    isLoading?: boolean;
+    /** Thumbnail mode — hides grid, axes, legend, tooltips, and reduces chart height. Individual show* props can override. */
+    isThumbnail?: boolean;
+    /** Translatable UI strings. Provide overrides for i18n. */
+    labelStrings?: ChartLabelStrings;
+    /** Legend display style (default: 'inline') */
+    legendVariant?: LegendVariant;
+    /** Callback when time period changes */
+    onTimePeriodChange?: (value: string) => void;
+    /** Currently selected time period */
+    selectedTimePeriod?: string;
+    /** Series definitions */
+    series: SeriesConfig[];
+    /** Show accessible data table (visually hidden). Defaults to true regardless of isThumbnail. */
+    showAccessibleTable?: boolean;
+    /** Show axis baseline lines. Defaults to true; false when isThumbnail is set. */
+    showAxisLines?: boolean;
+    /** Show grid lines. Defaults to true; false when isThumbnail is set. */
+    showGrid?: boolean;
+    /** Show legend. Defaults to true; false when isThumbnail is set. */
+    showLegend?: boolean;
+    /** Show tooltip on hover. Defaults to true; false when isThumbnail is set. */
+    showTooltip?: boolean;
+    /** Time period options for built-in selector */
+    timePeriodOptions?: TimePeriodOption[];
+    /** Custom tooltip renderer. Receives normalized payload and replaces the built-in tooltip. */
+    tooltipContent?: (payload: TooltipPayload) => ReactNode;
+    /** X-axis label */
+    xAxisLabel?: string;
+    /** How often to show x-axis ticks. A number n shows every nth tick (e.g. 1 = every other). Defaults to auto. */
+    xAxisTickInterval?: number | 'preserveStart' | 'preserveEnd' | 'preserveStartEnd';
+    /** Override the Y-axis scale bounds. Accepts a tuple of [min, max] where each can be a number, 'auto', 'dataMin', 'dataMax', or a function receiving the data max. */
+    yAxisDomain?: YAxisDomain;
+    /** Custom Y-axis tick formatter */
+    yAxisFormatter?: (value: number) => string;
+    /** Y-axis label */
+    yAxisLabel?: string;
+    /** How often to show y-axis ticks. A number n shows every nth tick (e.g. 1 = every other). Defaults to auto. */
+    yAxisTickInterval?: number | 'preserveStart' | 'preserveEnd' | 'preserveStartEnd';
+}

package/dist/components/empty-states/HorizontalEmptyState/HorizontalEmptyState.d.ts

@@ -1,6 +1,6 @@
 import { ComponentPropsWithoutRef, ReactNode } from 'react';
 import { HeadingLevel } from '../../../libs/types/custom-types';
-import { VideoEmbedProps } from '../../VideoEmbed/VideoEmbed';
+import { VideoEmbedProps } from '../../media/VideoEmbed/VideoEmbed';
 import './horizontal-empty-state.css';
 /**
  * Prop types for HorizontalEmptyState