feat: Charts package continued #2104
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "onlyChanged": true, | ||
| "projectId": "Project:67dafea9025400b3251fa8ef", | ||
| "zip": true, | ||
| "buildScriptName": "build:storybook" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Shoreline Charts | ||
|
|
||
| `shoreline-components` and `echarts` are peer dependencies of `shoreline-charts` | ||
|
||
|
|
||
| ```sh | ||
| pnpm add @vtex/shoreline echarts @vtex/shoreline-charts | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| { | ||
| "name": "@vtex/shoreline-charts", | ||
| "description": "Shoreline datavis library", | ||
| "version": "0.0.0", | ||
| "main": "./dist/index.js", | ||
| "module": "./dist/index.mjs", | ||
| "types": "./dist/index.d.ts", | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "registry": "https://registry.npmjs.org" | ||
| }, | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "exports": { | ||
| ".": { | ||
| "require": "./dist/index.js", | ||
| "import": "./dist/index.mjs", | ||
| "types": "./dist/index.d.ts" | ||
| }, | ||
| "./css": "./dist/index.css" | ||
| }, | ||
| "engines": { | ||
| "node": ">=16" | ||
| }, | ||
| "scripts": { | ||
| "prebuild": "rm -rf dist", | ||
| "dev": "tsup --watch", | ||
| "build": "tsup" | ||
| }, | ||
| "repository": { | ||
| "directory": "packages/charts", | ||
| "type": "git", | ||
| "url": "git+https://github.com/vtex/shoreline.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/vtex/shoreline/issues" | ||
| }, | ||
| "peerDependencies": { | ||
| "@vtex/shoreline": "1.x", | ||
| "echarts": "5.x", | ||
| "react": "18.x", | ||
| "react-dom": "18.x" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/lodash": "^4.17.4", | ||
| "@vtex/shoreline": "workspace:*", | ||
| "echarts": "5.5.0" | ||
| }, | ||
| "dependencies": { | ||
| "@vtex/shoreline-utils": "workspace:*", | ||
| "echarts-for-react": "^3.0.2", | ||
| "lodash": "^4.17.21", | ||
|
||
| "vitest-canvas-mock": "^0.3.3" | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| import type { EChartsOption } from 'echarts' | ||
| import { type ComponentPropsWithRef, forwardRef, useMemo } from 'react' | ||
| import type { ChartConfig, ChartUnit } from '../../types/chart' | ||
| import { Chart, type ChartOptions } from '../chart/chart' | ||
| import { | ||
| applySeriesHook, | ||
| defaultHooks, | ||
| getDataToChartCompositor, | ||
| getTooltipChartCompositor, | ||
| } from '../../utils/chart' | ||
| import { merge } from '@vtex/shoreline-utils' | ||
| import { | ||
| DATAZOOM_DEFAULT_STYLE, | ||
| GRID_DEFAULT_STYLE, | ||
| LEGEND_DEFAULT_STYLE, | ||
| } from '../../theme/chartStyles' | ||
|
|
||
| /** | ||
| * Used to make charts with multiple different types. | ||
| * @status stable | ||
| * @example | ||
| * <ChartCompositor | ||
| * charts={[ | ||
| * { serie: { data: [1, 2, 3, 4, 5] }, config: { type: 'bar' } }, | ||
| * { serie: { data: [1, 3, 2, 5, 4] }, config: { type: 'line' } }, | ||
| * ]} | ||
| * background={{ type: 'bar' }} | ||
| * tooltip={{ type: 'line' }} | ||
| * /> | ||
| */ | ||
| export const ChartCompositor = forwardRef< | ||
| echarts.EChartsType | undefined, | ||
| ChartCompositorProps | ||
| >(function ChartCompositor(props, ref) { | ||
| const { | ||
| charts, | ||
| xAxis = { type: 'category' }, | ||
| yAxis = { type: 'value' }, | ||
| tooltip, | ||
| zoom = false, | ||
| options, | ||
| ...otherProps | ||
| } = props | ||
|
|
||
| const hookedUnits: ChartUnit[] = useMemo(() => { | ||
| return charts.map((chart) => { | ||
| const { type, variant = 'default' } = chart.chartConfig | ||
| const seriesHooks: CallableFunction[] = defaultHooks[type][variant] | ||
| if (chart.hooks === undefined) { | ||
| return { | ||
| ...chart, | ||
| series: seriesHooks.reduce( | ||
| (out, fn) => applySeriesHook(out, fn), | ||
| chart.series | ||
| ), | ||
| } | ||
| } | ||
| if (chart.hooks === null) { | ||
| return chart | ||
| } | ||
| seriesHooks.push(...chart.hooks) | ||
| return { | ||
| ...chart, | ||
| series: seriesHooks.reduce( | ||
| (out, fn) => applySeriesHook(out, fn), | ||
| chart.series | ||
| ), | ||
| } | ||
| }) | ||
| }, []) | ||
|
|
||
| const seriesOptions: EChartsOption['series'] = useMemo(() => { | ||
| return hookedUnits.map((u) => getDataToChartCompositor(u)) | ||
| }, [hookedUnits]) | ||
|
|
||
| const tooltipOptions: EChartsOption['tooltip'] = useMemo(() => { | ||
| return getTooltipChartCompositor(tooltip) | ||
| }, [tooltip]) | ||
|
|
||
| const chartOptions: EChartsOption = useMemo(() => { | ||
| const finalOptions: EChartsOption = {} | ||
|
|
||
| finalOptions.legend = LEGEND_DEFAULT_STYLE | ||
| finalOptions.grid = GRID_DEFAULT_STYLE | ||
| if (zoom) finalOptions.dataZoom = DATAZOOM_DEFAULT_STYLE | ||
|
|
||
| finalOptions.series = seriesOptions | ||
| finalOptions.tooltip = tooltipOptions | ||
| finalOptions.yAxis = yAxis | ||
| finalOptions.xAxis = xAxis | ||
|
|
||
| return options ? merge(options, finalOptions) : finalOptions | ||
| }, [charts, tooltip, xAxis, yAxis, options]) | ||
|
|
||
| return ( | ||
| <Chart | ||
| chartConfig={null} | ||
| option={chartOptions} | ||
| style={{ height: 550 }} | ||
| ref={ref} | ||
| seriesHooks={null} | ||
| {...otherProps} | ||
| /> | ||
| ) | ||
| }) | ||
|
|
||
| export interface ChartCompositorOptions { | ||
| /** | ||
| * The data that will be rendered by the Compostior. Each unit contains | ||
| * a SeriesOption from Echarts, the ChartConfig which determines the type of chart and, optionally, | ||
| * an array of hook functions that will be applied to that series data. | ||
| * | ||
| * By default certain hooks will always be applied to certain chart types. This behaviour can be disabled by explicitly passing **null** to hooks. | ||
| * @example { series: { data: [1,2,3] }, config: { type: "bar", variant: "horizontal" } } | ||
| */ | ||
| charts: ChartUnit[] | ||
| /** | ||
| * Defines the yAxis setup for the chart, using the ECharts props. | ||
| * By default it just returns the value passed in data to the axis. | ||
| * | ||
| * @default {type:'value'} | ||
| */ | ||
| yAxis?: EChartsOption['yAxis'] | ||
| /** | ||
| * Defines the xAxis setup for the chart, using the ECharts props. | ||
| * By default it just returns the value passed in data to the axis. | ||
| * | ||
| * @default {type:'category'} | ||
| */ | ||
| xAxis?: EChartsOption['xAxis'] | ||
| /** | ||
| * Defines which type of tooltip is going to be used by the chart. | ||
| * @example { type: "bar", variant: "horizontal" } | ||
| */ | ||
| tooltip: ChartConfig | ||
| /** | ||
| * Whether to enable zoom. | ||
| * @default false | ||
| * @type boolean | ||
| */ | ||
| zoom?: boolean | ||
| /** | ||
| * Merges the passed options to the final options. | ||
| * | ||
| * **series**, **xAxis**, **yAxis**, and **tooltip** | ||
| * should be configured using other props from this component. | ||
| */ | ||
| options?: EChartsOption | ||
| } | ||
|
|
||
| export type ChartCompositorProps = ChartCompositorOptions & | ||
| Omit<ChartOptions, 'chartConfig' | 'option'> & | ||
| ComponentPropsWithRef<'div'> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './chart-compositor' |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you change it for old modules?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also wrote an issue about this, but i believe the mixing of ESM and commonJS syntax in this file leads to it being read as a different kind of script in different node versions, being the only thing stopping shoreline from running in newer versions. We had a few surprise compilation errors in the lab when we didn't realize our node version was different (besides at some point this would need to be fixed anyway unless we plan to stick to node 20 forever).
As for why i changed it to just CommonJs instead of ESM, i just couldn't get it to work with just ESM for some reason, i could try again after all these months of experience.