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

Card: Add story and description to highlight CardMedia usage #39830

Closed
mirka opened this issue Mar 28, 2022 · 4 comments · Fixed by #50074
Closed

Card: Add story and description to highlight CardMedia usage #39830

mirka opened this issue Mar 28, 2022 · 4 comments · Fixed by #50074
Assignees
Labels
[Package] Components /packages/components Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers

Comments

@mirka
Copy link
Member

mirka commented Mar 28, 2022

What problem does this address?

An important feature of the CardMedia component is that it is overflow: hidden, meaning that it will make its content nicely match the border-radius of its parent Card. This can be hard to discover for a couple reasons:

  • The user is not necessarily looking to wrap "media" like images or video. Sometimes it is just content with a background color (related: the "smooth the corners" issue in Reviewing Global Styles main panel #38934).
  • The Storybook story for Card includes a usage of CardMedia, but it does not show rounded corners because it's placed in the middle of the card.

What is your proposed solution?

  • The non-media use case should at least be mentioned in the lede of the CardMedia readme.
  • There should be a story that makes it obvious that by using CardMedia, corners will be rounded to match the Card.
@github-actions
Copy link

Hi,
This issue has gone 180 days without any activity. This means it is time for a check-in to make sure it is still relevant. If you are still experiencing this issue with the latest versions, you can help the project by responding to confirm the problem and by providing any updated reproduction steps.
Thanks for helping out.

@github-actions github-actions bot added the Needs Testing Needs further testing to be confirmed. label Sep 27, 2022
@kathrynwp
Copy link

Heya @mirka, I'm just popping round to check whether this is still an active/planned feature, and if so, whether there's anything that can be done to move it along. Thanks for having a look! (I've left the automatically added "Needs Testing" label for now.)

@mirka mirka added [Type] Developer Documentation Documentation for developers and removed Needs Testing Needs further testing to be confirmed. labels Oct 13, 2022
@mburridge mburridge self-assigned this Apr 20, 2023
@mburridge
Copy link
Contributor

mburridge commented Apr 20, 2023

What needs doing here? What should be added to the readme? Happy to action this with some guidance from the component authors or other interested parties.

@github-actions github-actions bot added the [Status] In Progress Tracking issues with work in progress label Apr 25, 2023
@mirka
Copy link
Member Author

mirka commented Apr 25, 2023

@mburridge Thanks for the nudge, I went ahead and added the changes in #50074.

@priethor priethor removed the [Status] In Progress Tracking issues with work in progress label May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants