Skip to content
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.

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

docs(xychart): add advanced usage sandbox examples #972

Merged
merged 3 commits into from
Dec 17, 2020

Conversation

williaster
Copy link
Collaborator

@williaster williaster commented Dec 16, 2020

🚀 Enhancements

  • [xychart] make EventHandlerParams event optional

📝 Documentation

This adds a few more codesandbox examples to the @visx/xychart README, some demonstrating advanced usage of context providers:

Annotation example


EventEmitterProvider example


ThemeProvider + custom theme chart background example


DataProvider/EventEmitterProvider example of linked tooltips / small multiples, closes #800


TooltipProvider example of programmatic tooltip triggering

🐛 Bug Fix

  • Fixes a missing </details> in the xychart readme

@kristw @hshoff

@coveralls
Copy link

Pull Request Test Coverage Report for Build 426653897

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 61.258%

Totals Coverage Status
Change from base Build 422190666: 0.0%
Covered Lines: 1732
Relevant Lines: 2694

💛 - Coveralls

@@ -18,7 +18,7 @@ export type EventHandlerParams<Datum> = {
/** Coordinates of the event in svg space. */
svgPoint?: { x: number; y: number };
/** The PointerEvent or FocusEvent. */
event: PointerEvent | FocusEvent;
event?: PointerEvent | FocusEvent;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added to the PR description. you had a commit message with it, but just want to make it lands in the 1.4 changelog as an enhancement

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, thanks 🙏

@williaster williaster merged commit 4365099 into master Dec 17, 2020
@williaster williaster deleted the chris--xychart-moar-docs branch December 17, 2020 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Working example / sandpit using ChartContext
3 participants