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

Doc Blocks #62

Merged
merged 7 commits into from
Jun 27, 2020
Merged

Doc Blocks #62

merged 7 commits into from
Jun 27, 2020

Conversation

pocka
Copy link
Collaborator

@pocka pocka commented Jun 20, 2020

Summary

close #61

Added Doc Blocks for each embed types.

  • Figma
  • iframe
  • image
  • PDF
  • [ ] link Just write [Text](url) 🤣
  • Design - which takes a story id then render according to the story's design parameter

Preview

https://storybook-addon-designs-git-feature-doc-blocks.pocka.vercel.app/?path=/docs/docs-advanced-usage--embed-multiple-designs#doc-blocks

@pocka pocka added the category: feature New feature or request label Jun 20, 2020
pocka added 2 commits June 21, 2020 15:13
Polished Doc Blocks behaviors and props:

* Added `showLink` to control "Open in new tab" button
* Added JSDoc for props so Docs-addon can show them in Props Table
* Changed the defaults for more ergonomic ones
* Added Docs page for Design Doc Blocks

I believe these changes improve both UX(DX) and maintainability.
@pocka pocka self-assigned this Jun 21, 2020
pocka added 3 commits June 23, 2020 15:17
It was so hard to add/modify/reuse the Wrapper component due to its
code highly coupled with Storybook's APIs. This change allos us to
render the Wrapper anywhere, includes in Docs and in stories.
Set a story ID then the Block renders based on the story's parameters.
@pocka pocka marked this pull request as ready for review June 23, 2020 16:22
@pocka pocka merged commit 1bcc6c0 into master Jun 27, 2020
@pocka pocka deleted the feature/doc-blocks branch June 27, 2020 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc Blocks
1 participant