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

Storybook Component Documentation Update - Refactor the Dropdownable component story #1004

Closed
nataliepina opened this issue Sep 20, 2023 · 1 comment

Comments

@nataliepina
Copy link
Collaborator

Description

The Dropdownable component's story is configured so that it is wrapped in the <DropdownStory />. This is used to manage the state and functionality of the component.

The Code option in the component Docs page serves as a reference for how to use the component. With this HOC component wrapping it we cannot see the example of how to use this component.

To fix this, we can remove the file containing the DropdownStory wrapper component and move that logic into the component story, so that it allows for the Dropdownable component code to fully display.

Screenshot 2023-09-20 at 10 59 51 AM

For an example of how a component was refactored in a similar way you can reference this work: #989

If this is your first experience working with Storybook stories, they have great documentation to reference, along with the other story files we have throughout the project.

Acceptance Criteria
Update the Dropdownable.stories.tsx file so that the code example will display how to use the component.


Contribution Guide

If this is your first time contributing to UI Kit, please review the How to Contribute guide beforehand.

@Chirag-Nanda
Copy link
Contributor

Can this issue be assigned to me?

electron97 added a commit to electron97/ui-kit that referenced this issue Oct 5, 2023
nataliepina pushed a commit that referenced this issue Oct 5, 2023
…1047)

* docs: refactored the dropdownable component story issue number #1004

* docs: fix frozen screen issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants