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.

Sign up for GitHub

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

Jump to bottom

Feature: Introducing storybook for documentation and playground #273

Merged
merged 18 commits into from
Feb 11, 2019
Merged

Feature: Introducing storybook for documentation and playground #273

merged 18 commits into from
Feb 11, 2019

Conversation

nutboltu
Copy link
Collaborator

@nutboltu nutboltu commented Feb 9, 2019 •
edited
Loading

Description

Introducing storybook for documentation and playground

Addons used:

  • KNOBS. This addon is used in playground story to play with the props
  • INFO. This addon is used to display the props with description. This is automated. No need to add props descriptions each time you add a new props.
  • ACTIONS. This addon is used to log the function triggers. It's really helpful to see the function call and parameters

Screenshots (if appropriate):

screen shot 2019-02-09 at 12 13 33 pm

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have used ESLint & Prettier to follow the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@nutboltu nutboltu self-assigned this Feb 9, 2019
@patw0929
Copy link
Owner

patw0929 commented Feb 9, 2019

This pull request introduces 1 alert and fixes 1 when merging b4e7665 into 4494a6f - view on LGTM.com

new alerts:

  • 1 for Unused or undefined state property

fixed alerts:

  • 1 for Unused or undefined state property

Comment posted by LGTM.com

@coveralls
Copy link

coveralls commented Feb 9, 2019 •
edited
Loading

Coverage Status

Coverage remained the same at 93.401% when pulling 3243c41 on feature/storybook into 4494a6f on master.

@patw0929
Copy link
Owner

patw0929 commented Feb 9, 2019

This pull request introduces 1 alert and fixes 1 when merging 3e64f27 into 4494a6f - view on LGTM.com

new alerts:

  • 1 for Unused or undefined state property

fixed alerts:

  • 1 for Unused or undefined state property

Comment posted by LGTM.com

@patw0929
Copy link
Owner

patw0929 commented Feb 9, 2019

This pull request introduces 1 alert and fixes 1 when merging ad8f9b8 into 4494a6f - view on LGTM.com

new alerts:

  • 1 for Unused or undefined state property

fixed alerts:

  • 1 for Unused or undefined state property

Comment posted by LGTM.com

patw0929
patw0929 reviewed Feb 10, 2019
View reviewed changes
Copy link
Owner

@patw0929 patw0929 left a comment

Choose a reason for hiding this comment

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

Awesome!

Could we generate storybook static files into specific folder for deploying to github pages?

.storybook/stories/1.GettingStarted/GettingStarted.stories.js Outdated Show resolved Hide resolved
.storybook/stories/2.Props/Props.stories.js Outdated Show resolved Hide resolved
.storybook/styles/_story.scss Outdated Show resolved Hide resolved
.storybook/stories/1.GettingStarted/GettingStarted.stories.js Outdated Show resolved Hide resolved
@patw0929
Copy link
Owner

This pull request introduces 1 alert and fixes 1 when merging 3243c41 into 4494a6f - view on LGTM.com

new alerts:

  • 1 for Unused or undefined state property

fixed alerts:

  • 1 for Unused or undefined state property

Comment posted by LGTM.com

@patw0929 patw0929 merged commit 964af19 into master Feb 11, 2019
@patw0929 patw0929 deleted the feature/storybook branch February 12, 2019 02:46
patw0929 added a commit that referenced this pull request Feb 14, 2019
@patw0929
Bumped version into v7.0.1
3f9b3c7 
Bug fixes:

- #277: Fix(272): Updating Allowdropdown after mount

Docs:

- #273: Feature: Introducing storybook for documentation and playground
- #274: fix(storybook-deploy): Fixed the storybook deployment script in travis
- #275: Fix: storybook's public path
- #276: Refactor: Removing all unused files and codes for example
andrewsantarin pushed a commit to andrewsantarin/react-intl-tel-input that referenced this pull request Feb 2, 2022
@patw0929
Merge pull request patw0929#273 from patw0929/feature/storybook
fbec7d3 
Feature: Introducing storybook for documentation and playground
andrewsantarin pushed a commit to andrewsantarin/react-intl-tel-input that referenced this pull request Feb 2, 2022
@patw0929
Bumped version into v7.0.1
0a66fe9 
Bug fixes:

- patw0929#277: Fix(272): Updating Allowdropdown after mount

Docs:

- patw0929#273: Feature: Introducing storybook for documentation and playground
- patw0929#274: fix(storybook-deploy): Fixed the storybook deployment script in travis
- patw0929#275: Fix: storybook's public path
- patw0929#276: Refactor: Removing all unused files and codes for example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@patw0929 patw0929 patw0929 left review comments

Assignees

@nutboltu nutboltu

Labels
new idea
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nutboltu @patw0929 @coveralls