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

DE-6498: Add Storybook #12

Merged
merged 12 commits into from
Oct 9, 2023
Merged

DE-6498: Add Storybook #12

merged 12 commits into from
Oct 9, 2023

Conversation

fingerartur
Copy link
Contributor

@fingerartur fingerartur commented Jul 10, 2023

I Added storybook for API docs and development of the components.

Here I also did a few drive-by fixes of some bugs and the API, but more will come in DE-6506. There I will also fix the rest of the stories, bc. some of them currently do not work.

@fingerartur fingerartur changed the title DE-6498: Storybook DE-6498: Add Storybook Jul 10, 2023
@fingerartur fingerartur requested a review from doubeka July 10, 2023 14:12
@fingerartur fingerartur force-pushed the fix/DE-6498-react-storybook branch 2 times, most recently from de27b25 to 4d414e5 Compare July 11, 2023 09:53
@fingerartur
Copy link
Contributor Author

Okay, I fixed the Jest config, now it's really ready for review :)

Add Storybook as a framework to develop and document UI.
So far this is groundwork, once the Storybook docs are finished,
`./app` folder can be deleted.

* FIXES

Several small fixes to some components such as `Duration` and
`CurrentTime`, fixes to the UI and some improvements to the API.

* FEATURES

Create `PlayPauseIndicator`.
Add CSS classes `.pp-ui-layers` and `.pp-ui-layer` intended
to stack layers of UI on top of each other (e.g. player and
its overlay).

* TOOLING

In Jest remove `transformIgnorePatterns` of `@castlabs/prestoplay`
because it is not being transformed anyway, because it is getting
mocked instead.
@fingerartur fingerartur force-pushed the fix/DE-6498-react-storybook branch from 4d414e5 to c4bd691 Compare July 26, 2023 08:48
Copy link

@doubeka doubeka left a comment

Choose a reason for hiding this comment

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

This is such an great improvement of this documentation on these components, great job 💯
I left few comments, mostly related to docs.
Some additional extended descriptions for components in stories, when it makes (IMO) sense, some of the others may need another pass later and update even examples. (like spacer).
I also checked the followup ticket, and I am happy to help and do some work on some following updates and improvements on various components APIs. I would propose to schedule some planning session to flesh that plan furter.

jest.resolver.js Show resolved Hide resolved
@@ -35,3 +35,6 @@ npm run publish
npm run test
```

## Docs
Copy link

Choose a reason for hiding this comment

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

Can we add note how to run storybook?

story/stories/components/BufferingIndicator.mdx Outdated Show resolved Hide resolved
story/stories/components/FullscreenButton.mdx Outdated Show resolved Hide resolved
story/stories/components/HorizontalBar.mdx Outdated Show resolved Hide resolved
story/stories/components/RateButton.mdx Outdated Show resolved Hide resolved
story/stories/components/RateText.mdx Outdated Show resolved Hide resolved
story/stories/components/SeekBar.mdx Outdated Show resolved Hide resolved
story/stories/components/TimeLeft.mdx Outdated Show resolved Hide resolved
story/stories/components/VolumeBar.mdx Outdated Show resolved Hide resolved
fingerartur and others added 11 commits October 9, 2023 09:26
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
Co-authored-by: doubeka <doubek.a@gmail.com>
@fingerartur
Copy link
Contributor Author

Thanks!

@fingerartur fingerartur requested a review from doubeka October 9, 2023 06:29
@fingerartur fingerartur merged commit 63a1fd8 into main Oct 9, 2023
@fingerartur fingerartur deleted the fix/DE-6498-react-storybook branch October 9, 2023 09:49
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.

2 participants