Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Storybook - Documentation (part 1) #118

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

Merged
merged 15 commits into from
Dec 7, 2020
Merged

Storybook - Documentation (part 1) #118

merged 15 commits into from
Dec 7, 2020

Conversation

mayashavin
Copy link
Contributor

Brief Summary of Changes

  • Remove cloudinary-video-player and core-js dependencies.
  • Upgrade storybook
  • Documentation with Storybook.

What does this PR address?

  • Github issue (Add reference - #XX)
  • Refactoring
  • New feature
  • Bug fix
  • Adds more tests
  • Documentation

Are tests included?

  • Yes
  • No

Reviewer, Please Note:

@mayashavin mayashavin changed the title WIP - Documentation Storybook - Documentation (part 1) Nov 29, 2020
@mayashavin mayashavin marked this pull request as ready for review November 29, 2020 21:23
README.md Outdated
```bash
vue add cloudinary
```
- Set up your cloudName and pick the components to use (or use all 😃)
Copy link
Contributor

Choose a reason for hiding this comment

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

did this actually change or is this is just formatting?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

just formatting. Reverted

@@ -127,7 +127,7 @@ export default {
const poster = cldPoster ? this.posterUrl : this.getPosterUrl()

return (
<video attrs={this.$attrs} poster={poster}>
<video controls attrs={this.$attrs} poster={poster}>
Copy link
Contributor

Choose a reason for hiding this comment

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

this should probably be configurable, no?
the user might choose not to pass controls. (isn't that part of this.$attrs?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

if user doesn't pass controls, it should be enabled by default, no? Else you will not see any video, only the poster, which make the whole idea of video component kind of redundant. I can remove this controls if you want to leave it for users to remember putting controls themselves

Copy link
Contributor

Choose a reason for hiding this comment

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

Controls should only determine if the html element has the video controls, if we're doing something different here it sounds like an implementation bug.

What about these situations? will these work?

No poster -> show controls?
No poster -> hide controls?
Poster -> show controls?
Poster -> hide controls?

I'm fine with it not being part of this PR, but if we need to fix this behaviour, It might be best to leave this option to the user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it wokrs for those situations but agreed to leave the option to user.

* add JSDoc comment

* add stories for CldContext

* story for CldImage

* add story for CldPlaceholder and CldPoster

* add story for CldTransformation

* add story for CldVideo

* docs: add workflow to build storybook

* build storybook script
@mayashavin mayashavin merged commit 536555f into master Dec 7, 2020
@mayashavin mayashavin deleted the documentation branch December 13, 2020 09:01
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