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

add: ResponsiveContainer story #3603

Merged

Conversation

akamfoad
Copy link
Contributor

@akamfoad akamfoad commented May 24, 2023

Description

Add ResponsiveContainer story and a simple example of how to use it.

Related Issue

Follow up of #3596

Motivation and Context

Document ResponsiveContainer and how its used.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Documentation & Storybook
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@akamfoad
Copy link
Contributor Author

@ckifer could you please take a look, I'm not sure if this is the right way of doing it, not very familiar with Storybook.

Copy link
Member

@ckifer ckifer left a comment

Choose a reason for hiding this comment

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

Few nits and one change requested - we want to follow the linked pattern I think as opposed to strictly using ArgTypes

storybook/stories/API/ResponsiveContainer.mdx Outdated Show resolved Hide resolved
storybook/stories/API/ResponsiveContainer.mdx Outdated Show resolved Hide resolved
storybook/stories/API/ResponsiveContainer.mdx Outdated Show resolved Hide resolved
storybook/stories/API/ResponsiveContainer.mdx Outdated Show resolved Hide resolved
@akamfoad akamfoad marked this pull request as ready for review May 25, 2023 07:29
@akamfoad
Copy link
Contributor Author

@ckifer Thanks for the suggestions, I think its ready for another round.

Copy link
Member

@ckifer ckifer left a comment

Choose a reason for hiding this comment

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

LGTM, I would just say that in general this is a lot of text. Text tends to become outdated over time so if we make changes to behavior we need to make sure we read the docs back to ourselves and ensure the things we say here are still true.

@ckifer ckifer merged commit 8f4b999 into recharts:master May 30, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants