Skip to content
This repository has been archived by the owner on Dec 26, 2018. It is now read-only.

Axes props and their docs #72

Open
jdelafon opened this issue Jul 26, 2016 · 0 comments
Open

Axes props and their docs #72

jdelafon opened this issue Jul 26, 2016 · 0 comments

Comments

@jdelafon
Copy link

The docs should indicate that props are passed as

<BarChart {...props} {...cartesianChartProps} {...axisProps} />

Then you can link to the docs for the cartesian chart mixin and Axes, and remove all stuff concerning them that is repeated for every chart - incompletely and soon inconsistently, because it needs to be maintained at many places.

Proposal: cartesianChartProps and axisProps would actually better be passed as a single object prop, e.g.

<BarChart {...props} xAxis={{tickValues, tickPadding}} />

so that prop names remain consistent across components (no prefix), for maintainability (1 prop to transfer), and to simplify the docs (1 prop to document for charts, then link to the Axes docs).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant