From 337dfee9c4178a6be1c43061d2935d3b580df56d Mon Sep 17 00:00:00 2001 From: Lukas Harbarth Date: Thu, 26 Sep 2024 11:16:11 +0200 Subject: [PATCH 1/4] docs(charts): improve documentation & add `tooltipConfig` stories --- .storybook/main.ts | 4 +- .../src/components/BarChart/BarChart.mdx | 3 ++ .../components/BarChart/BarChart.stories.tsx | 6 ++- .../components/BulletChart/BulletChart.mdx | 3 ++ .../BulletChart/BulletChart.stories.tsx | 6 ++- .../components/ColumnChart/ColumnChart.mdx | 3 ++ .../ColumnChart/ColumnChart.stories.tsx | 6 ++- .../ColumnChartWithTrend.tsx | 5 +- .../ComposedChart/ComposedChart.mdx | 3 ++ .../ComposedChart/ComposedChart.stories.tsx | 6 ++- .../src/components/DonutChart/DonutChart.mdx | 3 ++ .../DonutChart/DonutChart.stories.tsx | 6 ++- .../src/components/LineChart/LineChart.mdx | 3 ++ .../LineChart/LineChart.stories.tsx | 12 ++++- .../src/components/PieChart/PieChart.mdx | 3 ++ .../components/PieChart/PieChart.stories.tsx | 6 ++- .../src/components/RadarChart/RadarChart.mdx | 3 ++ .../RadarChart/RadarChart.stories.tsx | 6 ++- .../components/ScatterChart/ScatterChart.mdx | 3 ++ .../ScatterChart/ScatterChart.stories.tsx | 6 ++- packages/charts/src/resources/DemoProps.ts | 44 +++++++++++++++ .../charts/src/resources/TooltipConfig.mdx | 53 +++++++++++++++++++ 22 files changed, 181 insertions(+), 12 deletions(-) create mode 100644 packages/charts/src/resources/TooltipConfig.mdx diff --git a/.storybook/main.ts b/.storybook/main.ts index f366011e086..bbcab54a8a2 100644 --- a/.storybook/main.ts +++ b/.storybook/main.ts @@ -44,8 +44,8 @@ const config: StorybookConfig = { titlePrefix: 'Knowledge Base' }, { - directory: '../packages/charts', - files: '**/*@(.stories.tsx)', + directory: '../packages/charts/src/components', + files: '**/*.@(mdx|stories.@(mdx|tsx))', titlePrefix: 'Charts' }, { diff --git a/packages/charts/src/components/BarChart/BarChart.mdx b/packages/charts/src/components/BarChart/BarChart.mdx index 707bec3d90e..1779ebb9c6e 100644 --- a/packages/charts/src/components/BarChart/BarChart.mdx +++ b/packages/charts/src/components/BarChart/BarChart.mdx @@ -1,5 +1,6 @@ import { ControlsWithNote, DocsHeader, Footer } from '@sb/components'; import { Canvas, Meta } from '@storybook/addon-docs'; +import TooltipStory from '../../resources/TooltipConfig.mdx'; import * as ComponentStories from './BarChart.stories'; @@ -62,4 +63,6 @@ You can set a reference line to any value by using the `referenceLine` `chartCon + +