@mijn-ui/react-charts 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MijnUI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @mijn-ui/react-charts
+
+Lightweight, token-driven charts: bar, grouped bar, donut, sparkline, and legend.
+
+[Documentation](https://mijn-ui.vercel.app/react/docs/components/charts)
+
+## Installation
+
+```sh
+npm install @mijn-ui/react-charts
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license.](https://github.com/mijn-ui/mijn-ui-react/blob/main/LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,664 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as tailwind_variants from 'tailwind-variants';
+import { VariantProps } from 'tailwind-variants';
+import * as tailwind_merge from 'tailwind-merge';
+import * as React from 'react';
+import { UnstyledComponentWithSlots } from '@mijn-ui/react-core';
+
+/**
+ * The categorical hues exposed by the core theme
+ * (see `docs/foundation/colors.md` → Categorical surfaces), plus `brand`.
+ */
+type ChartHue = "brand" | "red" | "orange" | "amber" | "yellow" | "lime" | "green" | "emerald" | "teal" | "cyan" | "sky" | "blue" | "indigo" | "violet" | "purple" | "fuchsia" | "pink" | "rose" | "gray";
+/** Solid fill classes per hue (`bg-bg-<hue>`). */
+declare const HUE_BG_MAP: Record<ChartHue, string>;
+/** Subtle fill classes per hue (`bg-bg-<hue>-subtle`). */
+declare const HUE_BG_SUBTLE_MAP: Record<ChartHue, string>;
+/** SVG stroke classes per hue (`stroke-fg-<hue>`). */
+declare const HUE_STROKE_MAP: Record<ChartHue, string>;
+/**
+ * Text color classes per hue (`text-fg-<hue>`) — used to drive
+ * `stroke="currentColor"` / `stop-color="currentColor"` SVG techniques.
+ */
+declare const HUE_TEXT_MAP: Record<ChartHue, string>;
+/**
+ * SVG text-fill classes readable ON a hue's solid surface
+ * (`fill-on-bg-<hue>`) — used for labels drawn on top of chart marks.
+ */
+declare const HUE_ON_BG_FILL_MAP: Record<ChartHue, string>;
+/**
+ * Default categorical series order. Hues are assigned in this fixed order
+ * (never re-shuffled when series are added or removed) so a series keeps its
+ * color across renders and filters.
+ */
+declare const DEFAULT_PALETTE: ChartHue[];
+/** A single labeled value (BarChart), optionally with a fixed hue. */
+type ChartDatum = {
+    label: string;
+    value: number;
+    color?: ChartHue;
+};
+/** A labeled group of values, one per series (GroupedBarChart). */
+type GroupedChartDatum = {
+    label: string;
+    values: number[];
+};
+/** A labeled value with an optional fixed hue (DonutChart). */
+type DonutChartDatum = {
+    label: string;
+    value: number;
+    color?: ChartHue;
+};
+
+declare const chartTooltipStyles: tailwind_variants.TVReturnType<{
+    [key: string]: {
+        [key: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            title?: tailwind_merge.ClassNameValue;
+            row?: tailwind_merge.ClassNameValue;
+            swatch?: tailwind_merge.ClassNameValue;
+            label?: tailwind_merge.ClassNameValue;
+            value?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {
+    [x: string]: {
+        [x: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            title?: tailwind_merge.ClassNameValue;
+            row?: tailwind_merge.ClassNameValue;
+            swatch?: tailwind_merge.ClassNameValue;
+            label?: tailwind_merge.ClassNameValue;
+            value?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {}, {
+    base: string;
+    title: string;
+    row: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, undefined, {
+    [key: string]: {
+        [key: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            title?: tailwind_merge.ClassNameValue;
+            row?: tailwind_merge.ClassNameValue;
+            swatch?: tailwind_merge.ClassNameValue;
+            label?: tailwind_merge.ClassNameValue;
+            value?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {}, {
+    base: string;
+    title: string;
+    row: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, tailwind_variants.TVReturnType<unknown, {
+    base: string;
+    title: string;
+    row: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, undefined, unknown, unknown, undefined>>;
+type ChartTooltipVariantProps = VariantProps<typeof chartTooltipStyles>;
+type ChartTooltipSlots = keyof ReturnType<typeof chartTooltipStyles>;
+
+type ChartTooltipItem = {
+    value: string;
+    label?: string;
+    color?: ChartHue;
+};
+type ChartTooltipProps = UnstyledComponentWithSlots<ChartTooltipSlots> & React.ComponentPropsWithRef<"div"> & {
+    /** Heading line (usually the hovered datum's label). */
+    heading?: string;
+    /** One row per value; rows with a `color` render a hue swatch. */
+    items?: ChartTooltipItem[];
+};
+/**
+ * The floating hover bubble shared by every chart. Purely presentational —
+ * charts own the hover state and position it via `style`.
+ */
+declare const ChartTooltip: ({ className, classNames, unstyled, heading, items, children, ref, ...props }: ChartTooltipProps) => react_jsx_runtime.JSX.Element;
+
+declare const chartLegendStyles: tailwind_variants.TVReturnType<{
+    orientation: {
+        horizontal: {
+            base: string;
+        };
+        vertical: {
+            base: string;
+        };
+    };
+    clickable: {
+        true: {
+            item: string;
+        };
+    };
+    hidden: {
+        true: {
+            item: string;
+            label: string;
+        };
+    };
+}, {
+    base: string;
+    item: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, undefined, {
+    orientation: {
+        horizontal: {
+            base: string;
+        };
+        vertical: {
+            base: string;
+        };
+    };
+    clickable: {
+        true: {
+            item: string;
+        };
+    };
+    hidden: {
+        true: {
+            item: string;
+            label: string;
+        };
+    };
+}, {
+    base: string;
+    item: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, tailwind_variants.TVReturnType<{
+    orientation: {
+        horizontal: {
+            base: string;
+        };
+        vertical: {
+            base: string;
+        };
+    };
+    clickable: {
+        true: {
+            item: string;
+        };
+    };
+    hidden: {
+        true: {
+            item: string;
+            label: string;
+        };
+    };
+}, {
+    base: string;
+    item: string;
+    swatch: string;
+    label: string;
+    value: string;
+}, undefined, unknown, unknown, undefined>>;
+type ChartLegendVariantProps = VariantProps<typeof chartLegendStyles>;
+type ChartLegendSlots = keyof ReturnType<typeof chartLegendStyles>;
+
+type ChartLegendItemData = {
+    label: string;
+    color: ChartHue;
+    value?: string;
+    /** Marks the series as toggled off (dimmed swatch, struck-through label). */
+    hidden?: boolean;
+};
+type ChartLegendItemProps = UnstyledComponentWithSlots<ChartLegendSlots> & React.ComponentPropsWithRef<"div"> & ChartLegendItemData & {
+    /** When set the item renders as a button and calls this on click. */
+    onToggle?: () => void;
+};
+declare const ChartLegendItem: ({ className, classNames, unstyled, label: labelText, color, value: valueText, hidden, onToggle, ref, ...props }: ChartLegendItemProps) => react_jsx_runtime.JSX.Element;
+type ChartLegendProps = UnstyledComponentWithSlots<ChartLegendSlots> & React.ComponentPropsWithRef<"div"> & {
+    items: ChartLegendItemData[];
+    orientation?: ChartLegendVariantProps["orientation"];
+    /** When set every item becomes a toggle button (series show/hide). */
+    onItemToggle?: (index: number, item: ChartLegendItemData) => void;
+};
+declare const ChartLegend: ({ className, classNames, unstyled, items, orientation, onItemToggle, ref, ...props }: ChartLegendProps) => react_jsx_runtime.JSX.Element;
+
+declare const barChartStyles: tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, undefined, {
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, undefined, unknown, unknown, undefined>>;
+type BarChartVariantProps = VariantProps<typeof barChartStyles>;
+type BarChartSlots = keyof ReturnType<typeof barChartStyles>;
+
+type BarChartProps = UnstyledComponentWithSlots<BarChartSlots> & React.ComponentPropsWithRef<"div"> & {
+    data: ChartDatum[];
+    valueFormatter?: (value: number) => string;
+    /** Renders every bar but the last with the subtle hue, spotlighting the most recent value. */
+    emphasizeLast?: boolean;
+    /** Single hue for all bars (lowest precedence). */
+    color?: ChartHue;
+    /** Palette cycled per bar; each datum's own `color` wins over it. */
+    colors?: ChartHue[];
+    size?: BarChartVariantProps["size"];
+    /** Renders the formatted value above every bar. */
+    showValues?: boolean;
+    /** Shows a styled label+value bubble over the hovered bar (default on). */
+    showTooltip?: boolean;
+    /** Controlled hovered/highlighted bar index (`null` for none). */
+    activeIndex?: number | null;
+    onActiveIndexChange?: (activeIndex: number | null) => void;
+    onValueClick?: (index: number) => void;
+};
+declare const BarChart: ({ className, classNames, unstyled, data, valueFormatter, emphasizeLast, color, colors, size, showValues, showTooltip, activeIndex: activeIndexProp, onActiveIndexChange, onValueClick, ref, ...props }: BarChartProps) => react_jsx_runtime.JSX.Element;
+
+declare const groupedBarChartStyles: tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    legend: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, undefined, {
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    legend: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            plot: string;
+        };
+        default: {
+            plot: string;
+        };
+        lg: {
+            plot: string;
+        };
+    };
+    dimmed: {
+        true: {
+            bar: string;
+        };
+    };
+    clickable: {
+        true: {
+            barGroup: string;
+        };
+    };
+    withValues: {
+        true: {
+            plot: string;
+        };
+    };
+}, {
+    base: string;
+    legend: string;
+    plot: string;
+    barGroup: string;
+    bar: string;
+    valueLabel: string;
+    labelGroup: string;
+    label: string;
+}, undefined, unknown, unknown, undefined>>;
+type GroupedBarChartVariantProps = VariantProps<typeof groupedBarChartStyles>;
+type GroupedBarChartSlots = keyof ReturnType<typeof groupedBarChartStyles>;
+
+type GroupedBarChartProps = UnstyledComponentWithSlots<GroupedBarChartSlots> & React.ComponentPropsWithRef<"div"> & {
+    data: GroupedChartDatum[];
+    /** Series names, in the same order as each datum's `values`. */
+    series: string[];
+    /** Hues assigned to the series in fixed order. Defaults to `DEFAULT_PALETTE`. */
+    colors?: ChartHue[];
+    valueFormatter?: (value: number) => string;
+    size?: GroupedBarChartVariantProps["size"];
+    /** Renders the formatted value above every bar. */
+    showValues?: boolean;
+    /** Shows a per-series bubble over the hovered group (default on). */
+    showTooltip?: boolean;
+    /** Legend items become buttons that show/hide their series. */
+    toggleable?: boolean;
+    /** Controlled list of hidden series names (use with `toggleable`). */
+    hiddenSeries?: string[];
+    onHiddenSeriesChange?: (hiddenSeries: string[]) => void;
+    /** Controlled hovered/highlighted group index (`null` for none). */
+    activeIndex?: number | null;
+    onActiveIndexChange?: (activeIndex: number | null) => void;
+    onValueClick?: (index: number) => void;
+};
+declare const GroupedBarChart: ({ className, classNames, unstyled, data, series, colors, valueFormatter, size, showValues, showTooltip, toggleable, hiddenSeries: hiddenSeriesProp, onHiddenSeriesChange, activeIndex: activeIndexProp, onActiveIndexChange, onValueClick, ref, ...props }: GroupedBarChartProps) => react_jsx_runtime.JSX.Element;
+
+declare const donutChartStyles: tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            svg: string;
+        };
+        default: {
+            svg: string;
+        };
+        lg: {
+            svg: string;
+        };
+    };
+    thickness: {
+        thin: {
+            slice: string;
+        };
+        default: {
+            slice: string;
+        };
+        thick: {
+            slice: string;
+        };
+    };
+}, {
+    base: string;
+    svg: string;
+    slice: string;
+    sliceLabel: string;
+}, undefined, {
+    size: {
+        sm: {
+            svg: string;
+        };
+        default: {
+            svg: string;
+        };
+        lg: {
+            svg: string;
+        };
+    };
+    thickness: {
+        thin: {
+            slice: string;
+        };
+        default: {
+            slice: string;
+        };
+        thick: {
+            slice: string;
+        };
+    };
+}, {
+    base: string;
+    svg: string;
+    slice: string;
+    sliceLabel: string;
+}, tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            svg: string;
+        };
+        default: {
+            svg: string;
+        };
+        lg: {
+            svg: string;
+        };
+    };
+    thickness: {
+        thin: {
+            slice: string;
+        };
+        default: {
+            slice: string;
+        };
+        thick: {
+            slice: string;
+        };
+    };
+}, {
+    base: string;
+    svg: string;
+    slice: string;
+    sliceLabel: string;
+}, undefined, unknown, unknown, undefined>>;
+type DonutChartVariantProps = VariantProps<typeof donutChartStyles>;
+type DonutChartSlots = keyof ReturnType<typeof donutChartStyles>;
+
+type DonutChartProps = UnstyledComponentWithSlots<DonutChartSlots> & React.ComponentPropsWithRef<"div"> & {
+    data: DonutChartDatum[];
+    valueFormatter?: (value: number) => string;
+    size?: DonutChartVariantProps["size"];
+    thickness?: DonutChartVariantProps["thickness"];
+    /** Draws each slice's percentage on the ring (slices ≥ 6% only). */
+    showPercentages?: boolean;
+    /** Shows a label+value bubble at the hovered slice (default on). */
+    showTooltip?: boolean;
+};
+declare const DonutChart: ({ className, classNames, unstyled, data, valueFormatter, size, thickness, showPercentages, showTooltip, ref, ...props }: DonutChartProps) => react_jsx_runtime.JSX.Element;
+
+declare const sparklineStyles: tailwind_variants.TVReturnType<{
+    [key: string]: {
+        [key: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            area?: tailwind_merge.ClassNameValue;
+            line?: tailwind_merge.ClassNameValue;
+            marker?: tailwind_merge.ClassNameValue;
+            wrapper?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {
+    [x: string]: {
+        [x: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            area?: tailwind_merge.ClassNameValue;
+            line?: tailwind_merge.ClassNameValue;
+            marker?: tailwind_merge.ClassNameValue;
+            wrapper?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {}, {
+    wrapper: string;
+    base: string;
+    line: string;
+    area: string;
+    marker: string;
+}, undefined, {
+    [key: string]: {
+        [key: string]: tailwind_merge.ClassNameValue | {
+            base?: tailwind_merge.ClassNameValue;
+            area?: tailwind_merge.ClassNameValue;
+            line?: tailwind_merge.ClassNameValue;
+            marker?: tailwind_merge.ClassNameValue;
+            wrapper?: tailwind_merge.ClassNameValue;
+        };
+    };
+} | {}, {
+    wrapper: string;
+    base: string;
+    line: string;
+    area: string;
+    marker: string;
+}, tailwind_variants.TVReturnType<unknown, {
+    wrapper: string;
+    base: string;
+    line: string;
+    area: string;
+    marker: string;
+}, undefined, unknown, unknown, undefined>>;
+type SparklineVariantProps = VariantProps<typeof sparklineStyles>;
+type SparklineSlots = keyof ReturnType<typeof sparklineStyles>;
+
+type SparklineProps = UnstyledComponentWithSlots<SparklineSlots> & Omit<React.ComponentPropsWithRef<"svg">, "color" | "width" | "height"> & {
+    data: number[];
+    /** Hue applied as a `text-fg-<hue>` class; the line strokes `currentColor`. */
+    color?: ChartHue;
+    /** Fills the area under the line with a `currentColor` gradient. */
+    showArea?: boolean;
+    /** Point labels for the hover bubble (falls back to `#<index>`). */
+    labels?: string[];
+    valueFormatter?: (value: number) => string;
+    /** Shows a marker + label/value bubble at the nearest point (default on). */
+    showTooltip?: boolean;
+    width?: number;
+    height?: number;
+};
+declare const Sparkline: ({ className, classNames, unstyled, data, color, showArea, labels, valueFormatter, showTooltip, width, height, ref, ...props }: SparklineProps) => react_jsx_runtime.JSX.Element;
+
+export { BarChart, type BarChartProps, type BarChartSlots, type BarChartVariantProps, type ChartDatum, type ChartHue, ChartLegend, ChartLegendItem, type ChartLegendItemData, type ChartLegendItemProps, type ChartLegendProps, type ChartLegendSlots, type ChartLegendVariantProps, ChartTooltip, type ChartTooltipItem, type ChartTooltipProps, type ChartTooltipSlots, type ChartTooltipVariantProps, DEFAULT_PALETTE, DonutChart, type DonutChartDatum, type DonutChartProps, type DonutChartSlots, type DonutChartVariantProps, GroupedBarChart, type GroupedBarChartProps, type GroupedBarChartSlots, type GroupedBarChartVariantProps, type GroupedChartDatum, HUE_BG_MAP, HUE_BG_SUBTLE_MAP, HUE_ON_BG_FILL_MAP, HUE_STROKE_MAP, HUE_TEXT_MAP, Sparkline, type SparklineProps, type SparklineSlots, type SparklineVariantProps, barChartStyles, chartLegendStyles, chartTooltipStyles, donutChartStyles, groupedBarChartStyles, sparklineStyles };