Skip to content

feat(xychart): add colorAccessor to AreaSeries #1903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vretamal wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −2
Open

feat(xychart): add colorAccessor to AreaSeries #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/visx-xychart/src/components/series/private/BaseAreaSeries.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ export type BaseAreaSeriesProps<
renderLine?: boolean;
/** Sets the curve factory (from @visx/curve or d3-curve) for the line generator. Defaults to curveLinear. */
curve?: AreaProps<Datum>['curve'];
/** Given a datakey, returns its color. Falls back to theme color if unspecified or if a null-ish value is returned. */
colorAccessor?: (dataKey: string) => string | undefined | null;
/** Props to be passed to the Line, if rendered. */
lineProps?: Omit<
LinePathProps<Datum> & React.SVGProps<SVGPathElement>,
Expand All @@ -38,6 +40,7 @@ export type BaseAreaSeriesProps<
function BaseAreaSeries<XScale extends AxisScale, YScale extends AxisScale, Datum extends object>({
PathComponent = 'path',
curve,
colorAccessor,
data,
dataKey,
lineProps,
Expand Down Expand Up @@ -130,7 +133,7 @@ function BaseAreaSeries<XScale extends AxisScale, YScale extends AxisScale, Datu
<PathComponent
className="visx-area"
stroke="transparent"
fill={color}
fill={colorAccessor?.(dataKey) ?? color}
strokeLinecap="round" // without this a datum surrounded by nulls will not be visible
{...areaProps}
d={path(data) || ''}
Expand All @@ -150,7 +153,7 @@ function BaseAreaSeries<XScale extends AxisScale, YScale extends AxisScale, Datu
<PathComponent
className="visx-line"
fill="transparent"
stroke={color}
stroke={colorAccessor?.(dataKey) ?? color}
strokeWidth={2}
pointerEvents="none"
strokeLinecap="round" // without this a datum surrounded by nulls will not be visible
Expand Down
12 changes: 12 additions & 0 deletions packages/visx-xychart/test/components/AreaSeries.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ describe('<AreaSeries />', () => {
{ showTooltip, hideTooltip },
);
});

it('should use colorAccessor if passed', () => {
const { container } = render(
<DataContext.Provider value={getDataContext(series)}>
<svg>
<AreaSeries dataKey={series.key} {...series} colorAccessor={(_) => 'banana'} />
</svg>
</DataContext.Provider>,
);
expect(container.querySelector('.visx-area')).toHaveAttribute('fill', 'banana');
expect(container.querySelector('.visx-line')).toHaveAttribute('stroke', 'banana');
});
});

describe('<AnimatedAreaSeries />', () => {
Expand Down