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

Feature/component flat list #1844

Merged
merged 119 commits into from
Jul 9, 2020
Merged

Feature/component flat list #1844

merged 119 commits into from
Jul 9, 2020

Conversation

01231
Copy link
Contributor

@01231 01231 commented Jul 2, 2020

Fixes #1777

Done is when (DoD):

  • Modifications within components are reflected by tests.
  • A self-review of the code has been performed.
  • The modified component properties have been added to the typescript typings.
  • Potential design changes have been reviewed by a designer.
  • The modifications are well documented (README.md, etc.) and showcased in the stories.
  • The modifications are documented in the code, particularly in hard-to-understand areas (focus on WHY).
  • The modifications are shortly added to CHANGELOG.md with the issue number.
  • The modifications still work in IE.
  • The modifications are according to our Best Practices

@01231 01231 added the R4R Ready for Review - Please review this PR. label Jul 6, 2020
raphaellueckl
raphaellueckl previously approved these changes Jul 6, 2020
Copy link
Contributor

@raphaellueckl raphaellueckl left a comment

Choose a reason for hiding this comment

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

LGTM, but I don't like that all the "main stories" are now called "Story" instead of by their specific component name.

Copy link
Contributor

@danyball danyball left a comment

Choose a reason for hiding this comment

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

  • can you configure Storybook to always try to open "Story" if the user clicks on a folder? Maybe the word "story" is not understood by our users. Maybe something like "Example" or "Showcase" would be better?!

  • is it possible to set the same icon on the components? It looks a little bumpy.
    image

.storybook/config.js Outdated Show resolved Hide resolved
@01231
Copy link
Contributor Author

01231 commented Jul 6, 2020

  • can you configure Storybook to always try to open "Story" if the user clicks on a folder? Maybe the word "story" is not understood by our users. Maybe something like "Example" or "Showcase" would be better?!
  • is it possible to set the same icon on the components? It looks a little bumpy.
    image
  • The folder icon appears when there are subfolders in the component and the blue one when there is no subfolder. The word examples or showcase are synonyms for demo in my opinion. Our stories are demos itself. The name story gives it a reason to be in this superordinate position from the demos.
  • Storybook seems to only open a story automatically when there is no subfolder (blue icon). In the passt they all where blue and therefore opened the story on click.

@danyball
Copy link
Contributor

danyball commented Jul 8, 2020

  • can you configure Storybook to always try to open "Story" if the user clicks on a folder? Maybe the word "story" is not understood by our users. Maybe something like "Example" or "Showcase" would be better?!
  • is it possible to set the same icon on the components? It looks a little bumpy.
    image
  • The folder icon appears when there are subfolders in the component and the blue one when there is no subfolder. The word examples or showcase are synonyms for demo in my opinion. Our stories are demos itself. The name story gives it a reason to be in this superordinate position from the demos.
  • Storybook seems to only open a story automatically when there is no subfolder (blue icon). In the passt they all where blue and therefore opened the story on click.

I dont like story. Our demos showing just special behaviour and are not "showcases" that shows all the cases of a component.

@01231
Copy link
Contributor Author

01231 commented Jul 8, 2020

  • this

Screenshot 2020-07-08 at 09 39 08

It's called storybook. If we can expect from the user to now what a storybook is we can expect from him that he will understand what a story is. And if he doesn't now what a story is, he'll probably know it as soon as he clicks on the component, because this is the first thing that opens. And due the fact that story will be used throughout the whole storybook this will not be much of a challenge for him.

If you really don't like the name story I'll need a better suggestion, because the old naming was not good and redundant. What i don't like about "examples" or "showcase" is, that this would also work for all the demos in my opinion. I know we could also say that about the name "story". What about "Nativ component" or "native story"? This would descriptive and unambiguously.

@LucaMele
Copy link
Contributor

LucaMele commented Jul 8, 2020

I personally prefer story for the reaosons Noah explained

@01231 01231 requested review from danyball and raphaellueckl July 8, 2020 12:07
@01231 01231 merged commit 00db17e into develop Jul 9, 2020
@01231 01231 deleted the feature/component-flat-list branch July 9, 2020 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R4R Ready for Review - Please review this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Child of #1773] Reorder our components to a flat list
4 participants