search

lifeomic / chroma-react

Open source design system from LifeOmic, built with React
https://lifeomic.github.io/chroma-react/
MIT License
48 stars 9 forks source link

Update DescriptionList Components to Storybook CSF3 #377

Closed MMFane closed 1 year ago

MMFane commented 1 year ago

What Was Changed

Questions for the Team

  • Removed titles from ungrouped components whose name is the same as their filename
  • @dexterca, this has caused the stories for DescriptionList as the parent to ungroup. I think this makes more semantic sense, but what's your opinion? I could see it burying the other story folders for our users as well, which would be a bummer. (See screenshot below)
  • @dexterca, Second question: do you think the stories for the sub-components are helpful or could we do without them? I noticed the -Divider, -Details, and -Terms stories look very similar, and I'm not sure if the -Divider one is illustrating the divider at all. Since you just made this component, I'm curious to learn your thinking behind making these stories.

Screenshot 2023-08-23 at 2 12 04 PM

Screenshots

There should be no visual changes to these components

dexterca commented 1 year ago

@dexterca, this has caused the stories for DescriptionList as the parent to ungroup. I think this makes more semantic sense, but what's your opinion? I could see it burying the other story folders for our users as well, which would be a bummer.

@MMFane I favor the way you have things setup here. True, some items might get buried but there are accordions to help with that. Another added benefit is that users can more quickly jump to see specific examples in the side nav because you've removed one level of nesting in the side nav.

dexterca commented 1 year ago

@dexterca, Second question: do you think the stories for the sub-components are helpful or could we do without them? I noticed the -Divider, -Details, and -Terms stories look very similar, and I'm not sure if the -Divider one is illustrating the divider at all. Since you just made this component, I'm curious to learn your thinking behind making these stories.

@MMFane If I'm being honest, I didn't put much thought into this. I was just following the convention we had for <List. Stripping out the stories works for me because I'm not sure how much value they actually provide.

MMFane commented 1 year ago

@dexterca, Second question: do you think the stories for the sub-components are helpful or could we do without them? I noticed the -Divider, -Details, and -Terms stories look very similar, and I'm not sure if the -Divider one is illustrating the divider at all. Since you just made this component, I'm curious to learn your thinking behind making these stories.

@MMFane If I'm being honest, I didn't put much thought into this. I was just following the convention we had for <List. Stripping out the stories works for me because I'm not sure how much value they actually provide.

@dexterca I'm going to strip them out then - my thinking is we put any subcomponent stories we need under the parent and skipping boilerplate subcomponent ones will save us story maintenance time and effort

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 5.1.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket: