Skip to content

The Open Standard for Generative UI

Refactor mini chart components (#159)

subhamba01a5e47454
diff --git a/js/packages/react-ui/package.json b/js/packages/react-ui/package.json
index 1fdbff74a..089e748a6 100644
--- a/js/packages/react-ui/package.json
+++ b/js/packages/react-ui/package.json
@@ -2,7 +2,7 @@
"type": "module",
"name": "@crayonai/react-ui",
"license": "MIT",
- "version": "0.8.11",
+ "version": "0.8.12",
"description": "Component library for Generative UI SDK",
"main": "dist/index.js",
"types": "dist/index.d.ts",
diff --git a/js/packages/react-ui/src/components/Charts/MiniAreaChart/MiniAreaChart.tsx b/js/packages/react-ui/src/components/Charts/MiniAreaChart/MiniAreaChart.tsx
index a99407d86..f80a5a029 100644
--- a/js/packages/react-ui/src/components/Charts/MiniAreaChart/MiniAreaChart.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniAreaChart/MiniAreaChart.tsx
@@ -4,15 +4,18 @@ import { Area, AreaChart as RechartsAreaChart, XAxis } from "recharts";
import { useId } from "../../../polyfills";
import { ChartConfig, ChartContainer } from "../Charts";
import {
+ DATA_KEY,
getRecentDataThatFits,
transformDataForChart,
} from "../utils/AreaAndLine/MiniAreaAndLineUtils";
-import { getDistributedColors, getPalette, PaletteName } from "../utils/PalletUtils";
+import { useChartPalette, type PaletteName } from "../utils/PalletUtils";
+import { get2dChartConfig } from "../utils/dataUtils";
import { MiniAreaChartData } from "./types";
export interface MiniAreaChartProps {
data: MiniAreaChartData;
theme?: PaletteName;
+ customPalette?: string[];
variant?: "linear" | "natural" | "step";
opacity?: number;
isAnimationActive?: boolean;
@@ -26,6 +29,7 @@ export interface MiniAreaChartProps {
export const MiniAreaChart = ({
data,
theme = "ocean",
+ customPalette,
variant = "natural",
opacity = 0.5,
isAnimationActive = false,
@@ -67,24 +71,24 @@ export const MiniAreaChart = ({
return transformDataForChart(filteredData);
}, [filteredData]);
- const colors = useMemo(() => {
- const palette = getPalette(theme);
- return getDistributedColors(palette.colors, 1); // Single color for 1D chart
- }, [theme]);
+ const colors = useChartPalette({
+ chartThemeName: theme,
+ customPalette: customPalette || (areaColor ? [areaColor] : undefined),
+ themePaletteName: "areaChartPalette",
+ dataLength: 1,
+ });
+
+ const transformedKeys = useMemo(() => ({ [DATA_KEY]: DATA_KEY }), []);
const chartConfig: ChartConfig = useMemo(() => {
- return {
- value: {
- label: "Value",
- color: areaColor ? areaColor : colors[0],
- },
- };
- }, [colors, areaColor]);
+ return get2dChartConfig([DATA_KEY], colors, transformedKeys);
+ }, [colors, transformedKeys]);
const id = useId();
// Generate unique gradient ID to avoid conflicts when multiple charts are on the same page
const gradientId = useMemo(() => `miniAreaGradient-${id}`, [id]);
+ const color = `var(--color-${DATA_KEY})`;
return (
<ChartContainer
@@ -107,8 +111,8 @@ export const MiniAreaChart = ({
{useGradient && (
<defs>
<linearGradient id={gradientId} x1="0" y1="0" x2="0" y2="1">
- <stop offset="5%" stopColor="var(--color-value)" stopOpacity={0.6} />
- <stop offset="95%" stopColor="var(--color-value)" stopOpacity={0} />
+ <stop offset="5%" stopColor={color} stopOpacity={0.6} />
+ <stop offset="95%" stopColor={color} stopOpacity={0} />
</linearGradient>
</defs>
)}
@@ -116,10 +120,10 @@ export const MiniAreaChart = ({
<XAxis dataKey="label" hide={true} />
<Area
- dataKey="value"
+ dataKey={DATA_KEY}
type={variant}
- stroke="var(--color-value)"
- fill={useGradient ? `url(#${gradientId})` : "var(--color-value)"}
+ stroke={color}
+ fill={useGradient ? `url(#${gradientId})` : color}
fillOpacity={useGradient ? 1 : opacity}
isAnimationActive={isAnimationActive}
strokeWidth={1.5}
diff --git a/js/packages/react-ui/src/components/Charts/MiniAreaChart/stories/MiniAreaChart.stories.tsx b/js/packages/react-ui/src/components/Charts/MiniAreaChart/stories/MiniAreaChart.stories.tsx
index 73b8711e6..abfbafe11 100644
--- a/js/packages/react-ui/src/components/Charts/MiniAreaChart/stories/MiniAreaChart.stories.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniAreaChart/stories/MiniAreaChart.stories.tsx
@@ -27,7 +27,7 @@ const labeledAreaChartData = [
];
const meta: Meta<typeof MiniAreaChart> = {
- title: "Components/Charts/AreaCharts/MiniAreaChart",
+ title: "Components/Charts/MiniAreaChart",
component: MiniAreaChart,
parameters: {
layout: "centered",
@@ -38,7 +38,7 @@ const meta: Meta<typeof MiniAreaChart> = {
},
},
},
- tags: ["!dev", "!autodocs"],
+ tags: ["!autodocs"],
argTypes: {
data: {
description:
diff --git a/js/packages/react-ui/src/components/Charts/MiniBarChart/MiniBarChart.tsx b/js/packages/react-ui/src/components/Charts/MiniBarChart/MiniBarChart.tsx
index 8f9de2801..baeb8b4a8 100644
--- a/js/packages/react-ui/src/components/Charts/MiniBarChart/MiniBarChart.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniBarChart/MiniBarChart.tsx
@@ -4,9 +4,11 @@ import { Bar, BarChart, XAxis } from "recharts";
import { useTheme } from "../../ThemeProvider";
import { ChartConfig, ChartContainer } from "../Charts";
import { LineInBarShape } from "../shared";
-import { getDistributedColors, getPalette, PaletteName } from "../utils/PalletUtils";
+import { useChartPalette, type PaletteName } from "../utils/PalletUtils";
+import { get2dChartConfig } from "../utils/dataUtils";
import { type MiniBarChartData } from "./types";
import {
+ DATA_KEY,
getPadding,
getRecentDataThatFits,
MINI_BAR_WIDTH,
@@ -16,6 +18,7 @@ import {
export interface MiniBarChartProps {
data: MiniBarChartData;
theme?: PaletteName;
+ customPalette?: string[];
radius?: number;
isAnimationActive?: boolean;
onBarsClick?: (data: any) => void;
@@ -29,6 +32,7 @@ const MINI_BAR_CHART_INNER_LINE_WIDTH = 1;
export const MiniBarChart = ({
data,
theme = "ocean",
+ customPalette,
radius = 1,
isAnimationActive = false,
onBarsClick,
@@ -68,19 +72,18 @@ export const MiniBarChart = ({
return transformDataForChart(filteredData);
}, [filteredData]);
- const colors = useMemo(() => {
- const palette = getPalette(theme);
- return getDistributedColors(palette.colors, 1); // Single color for 1D chart
- }, [theme]);
+ const colors = useChartPalette({
+ chartThemeName: theme,
+ customPalette: customPalette || (barColor ? [barColor] : undefined),
+ themePaletteName: "barChartPalette",
+ dataLength: 1,
+ });
+
+ const transformedKeys = useMemo(() => ({ [DATA_KEY]: DATA_KEY }), []);
const chartConfig: ChartConfig = useMemo(() => {
- return {
- value: {
- label: "Value",
- color: barColor ? barColor : colors[0],
- },
- };
- }, [colors, barColor]);
+ return get2dChartConfig([DATA_KEY], colors, transformedKeys);
+ }, [colors, transformedKeys]);
const { mode } = useTheme();
@@ -105,8 +108,8 @@ export const MiniBarChart = ({
<BarChart accessibilityLayer data={chartData}>
<XAxis hide={true} padding={getPadding(filteredData, containerWidth)} />
<Bar
- dataKey="value"
- fill="var(--color-value)"
+ dataKey={DATA_KEY}
+ fill={`var(--color-${DATA_KEY})`}
radius={[radius, radius, 0, 0]}
isAnimationActive={isAnimationActive}
maxBarSize={MINI_BAR_WIDTH}
diff --git a/js/packages/react-ui/src/components/Charts/MiniBarChart/stories/MiniBarChart.stories.tsx b/js/packages/react-ui/src/components/Charts/MiniBarChart/stories/MiniBarChart.stories.tsx
index ecd296f68..1d8d75171 100644
--- a/js/packages/react-ui/src/components/Charts/MiniBarChart/stories/MiniBarChart.stories.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniBarChart/stories/MiniBarChart.stories.tsx
@@ -33,7 +33,7 @@ const icons = {
} as const;
const meta: Meta<MiniBarChartProps> = {
- title: "Components/Charts/BarCharts/MiniBarChart",
+ title: "Components/Charts/MiniBarChart",
component: MiniBarChart,
parameters: {
layout: "centered",
@@ -44,7 +44,7 @@ const meta: Meta<MiniBarChartProps> = {
},
},
},
- tags: ["!dev", "!autodocs"],
+ tags: ["!autodocs"],
argTypes: {
data: {
description:
diff --git a/js/packages/react-ui/src/components/Charts/MiniBarChart/utils/miniBarChartUtils.ts b/js/packages/react-ui/src/components/Charts/MiniBarChart/utils/miniBarChartUtils.ts
index 28b01f92b..e93b6fcd6 100644
--- a/js/packages/react-ui/src/components/Charts/MiniBarChart/utils/miniBarChartUtils.ts
+++ b/js/packages/react-ui/src/components/Charts/MiniBarChart/utils/miniBarChartUtils.ts
@@ -23,7 +23,7 @@ const getWidthOfData = (data: MiniBarChartData) => {
* @param containerWidth - The total width of the container in pixels
* @returns An object with left and right padding values in pixels
*/
-const getPadding = (data: MiniBarChartData, containerWidth: number) => {
+export const getPadding = (data: MiniBarChartData, containerWidth: number) => {
const availableWidth = containerWidth - CONTAINER_HORIZONTAL_PADDING;
const chartWidth = getWidthOfData(data);
const paddingValue = availableWidth - chartWidth;
@@ -48,7 +48,7 @@ const getPadding = (data: MiniBarChartData, containerWidth: number) => {
* @param containerWidth - The total width of the container in pixels
* @returns A filtered array containing only the most recent data items that fit in the container
*/
-const getRecentDataThatFits = (
+export const getRecentDataThatFits = (
data: MiniBarChartData,
containerWidth: number,
): MiniBarChartData => {
@@ -84,7 +84,7 @@ type ChartData = Array<{
* @param data - The mini bar chart data array (can contain numbers or objects with value/label)
* @returns An array of chart data objects with value and label properties
*/
-const transformDataForChart = (data: MiniBarChartData): ChartData => {
+export const transformDataForChart = (data: MiniBarChartData): ChartData => {
return data.map((item, index) => {
if (typeof item === "number") {
return { value: item, label: `Item ${index + 1}` };
@@ -94,4 +94,4 @@ const transformDataForChart = (data: MiniBarChartData): ChartData => {
});
};
-export { getPadding, getRecentDataThatFits, transformDataForChart };
+export const DATA_KEY = "value";
diff --git a/js/packages/react-ui/src/components/Charts/MiniLineChart/MiniLineChart.tsx b/js/packages/react-ui/src/components/Charts/MiniLineChart/MiniLineChart.tsx
index 36747a53c..60615eb6f 100644
--- a/js/packages/react-ui/src/components/Charts/MiniLineChart/MiniLineChart.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniLineChart/MiniLineChart.tsx
@@ -3,15 +3,18 @@ import { useEffect, useMemo, useRef, useState } from "react";
import { Line, LineChart as RechartsLineChart, XAxis } from "recharts";
import { ChartConfig, ChartContainer } from "../Charts";
import {
+ DATA_KEY,
getRecentDataThatFits,
transformDataForChart,
} from "../utils/AreaAndLine/MiniAreaAndLineUtils";
-import { getDistributedColors, getPalette, PaletteName } from "../utils/PalletUtils";
+import { useChartPalette, type PaletteName } from "../utils/PalletUtils";
+import { get2dChartConfig } from "../utils/dataUtils";
import { MiniLineChartData } from "./types";
export interface MiniLineChartProps {
data: MiniLineChartData;
theme?: PaletteName;
+ customPalette?: string[];
variant?: "linear" | "natural" | "step";
strokeWidth?: number;
isAnimationActive?: boolean;
@@ -24,6 +27,7 @@ export interface MiniLineChartProps {
export const MiniLineChart = ({
data,
theme = "ocean",
+ customPalette,
variant = "natural",
strokeWidth = 2,
isAnimationActive = true,
@@ -63,19 +67,18 @@ export const MiniLineChart = ({
return transformDataForChart(filteredData);
}, [filteredData]);
- const colors = useMemo(() => {
- const palette = getPalette(theme);
- return getDistributedColors(palette.colors, 1); // Single color for 1D chart
- }, [theme]);
+ const colors = useChartPalette({
+ chartThemeName: theme,
+ customPalette: customPalette || (lineColor ? [lineColor] : undefined),
+ themePaletteName: "lineChartPalette",
+ dataLength: 1,
+ });
+
+ const transformedKeys = useMemo(() => ({ [DATA_KEY]: DATA_KEY }), []);
const chartConfig: ChartConfig = useMemo(() => {
- return {
- value: {
- label: "Value",
- color: lineColor ? lineColor : colors[0],
- },
- };
- }, [colors, lineColor]);
+ return get2dChartConfig([DATA_KEY], colors, transformedKeys);
+ }, [colors, transformedKeys]);
return (
<ChartContainer
@@ -98,9 +101,9 @@ export const MiniLineChart = ({
<XAxis dataKey="label" hide={true} />
<Line
- dataKey="value"
+ dataKey={DATA_KEY}
type={variant}
- stroke="var(--color-value)"
+ stroke={`var(--color-${DATA_KEY})`}
strokeWidth={strokeWidth}
dot={false}
isAnimationActive={isAnimationActive}
diff --git a/js/packages/react-ui/src/components/Charts/MiniLineChart/stories/MiniLineChart.stories.tsx b/js/packages/react-ui/src/components/Charts/MiniLineChart/stories/MiniLineChart.stories.tsx
index 85230d7dd..45de90400 100644
--- a/js/packages/react-ui/src/components/Charts/MiniLineChart/stories/MiniLineChart.stories.tsx
+++ b/js/packages/react-ui/src/components/Charts/MiniLineChart/stories/MiniLineChart.stories.tsx
@@ -25,7 +25,7 @@ const labeledLineChartData = [
];
const meta: Meta<typeof MiniLineChart> = {
- title: "Components/Charts/LineCharts/MiniLineChart",
+ title: "Components/Charts/MiniLineChart",
component: MiniLineChart,
parameters: {
layout: "centered",
@@ -36,7 +36,7 @@ const meta: Meta<typeof MiniLineChart> = {
},
},
},
- tags: ["!dev", "!autodocs"],
+ tags: ["!autodocs"],
argTypes: {
data: {
description:
diff --git a/js/packages/react-ui/src/components/Charts/index.ts b/js/packages/react-ui/src/components/Charts/index.ts
index 68f02c49b..437f860ed 100644
--- a/js/packages/react-ui/src/components/Charts/index.ts
+++ b/js/packages/react-ui/src/components/Charts/index.ts
@@ -2,6 +2,9 @@ export * from "./AreaChart";
export * from "./BarChart";
export * from "./HorizontalBarChart";
export * from "./LineChart";
+export * from "./MiniAreaChart";
+export * from "./MiniBarChart";
+export * from "./MiniLineChart";
export * from "./PieChart";
export * from "./RadarChart";
export * from "./RadialChart";
diff --git a/js/packages/react-ui/src/components/Charts/utils/AreaAndLine/MiniAreaAndLineUtils.ts b/js/packages/react-ui/src/components/Charts/utils/AreaAndLine/MiniAreaAndLineUtils.ts
index f4c107ef5..31b99f79e 100644
--- a/js/packages/react-ui/src/components/Charts/utils/AreaAndLine/MiniAreaAndLineUtils.ts
+++ b/js/packages/react-ui/src/components/Charts/utils/AreaAndLine/MiniAreaAndLineUtils.ts
@@ -63,3 +63,5 @@ export const getRecentDataThatFits = (
// Return the most recent items that fit
return data.slice(-maxItems);
};
+
+export const DATA_KEY = "value";