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

[DSS-183]: Storybook Components Not Displaying Code Examples #1612

Merged
merged 11 commits into from
Oct 4, 2022

Conversation

pixelflips
Copy link
Member

@pixelflips pixelflips commented Oct 3, 2022

Description

Code examples for the following components do not display properly in Storybook.
Most are returning <No Display Name /> instead of markup.

  • FormSection
  • IconCard
  • Loader
  • Popover
  • Select
  • Table
  • Tooltip
  • Topbar
  • Type
  • UploadCard

Updates included using the {Story()} function when using decorators in the component story.

Screenshots

Before After
Screen Shot 2022-10-03 at 4 01 03 PM Screen Shot 2022-10-03 at 4 00 33 PM

Testing in sage-lib

Navigate to Storybook
Visit each component listed above.
Verify code examples now display on Docs tab.

Testing in kajabi-products

  1. (LOW) Fixes code examples not displaying in Storybook. Documentation update only, no effect on KP expected.

Related

https://kajabi.atlassian.net/browse/DSS-183

@pixelflips pixelflips added the improvement Improve on existing work label Oct 3, 2022
@pixelflips pixelflips self-assigned this Oct 3, 2022
@pixelflips pixelflips marked this pull request as ready for review October 3, 2022 23:20
@pixelflips pixelflips requested a review from a team October 3, 2022 23:20
@pixelflips pixelflips added the bug Something isn't working label Oct 3, 2022
Copy link
Contributor

@anechol anechol left a comment

Choose a reason for hiding this comment

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

LGTM! Just one non-blocking change: the Popover story is gigantic. Can we remove the defined height in that story?

@pixelflips
Copy link
Member Author

LGTM! Just one non-blocking change: the Popover story is gigantic. Can we remove the defined height in that story?

@anechol If we completely remove it, the popover gets cut off when it's opened. I'll find a height that still allows it to display properly. Right now it's 100vh, I'll find a better value. Thanks for pointing that out!

@pixelflips pixelflips requested a review from a team October 4, 2022 15:49
@pixelflips pixelflips merged commit 4d6e62f into develop Oct 4, 2022
@pixelflips pixelflips mentioned this pull request Oct 4, 2022
1 task
@pixelflips pixelflips deleted the DSS-183_pl-storybook-code-examples branch October 4, 2022 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working improvement Improve on existing work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants