chore: add storybook, basic story and documentation example #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
storyworks
commented
Jul 4, 2022
.storybook/preview.js
Outdated
| @@ -0,0 +1,77 @@ | |||
|
|
|||
| import React from 'react'; | |||
There was a problem hiding this comment.
Configuration derived from https://dev.to/aaronksaunders/how-to-use-storybook-with-ionic-and-reactjs-57f3 and ionic-team/ionic-framework#25409
storyworks
commented
Jul 4, 2022
| "danger": "^11.0.7", | ||
| "eslint": "^8.19.0", | ||
| "eslint-config-prettier": "^8.5.0", | ||
| "eslint-config-standard": "^17.0.0", | ||
| "eslint-plugin-import": "^2.26.0", | ||
| "eslint-plugin-n": "^15.2.4", |
There was a problem hiding this comment.
Only this import was added manually, storybook threw an error since eslint-config-standard depended on it but it was never imported
storyworks
added
effort: 2
priority:2day
type: chore
tataihono
requested changes
Jul 5, 2022
Can try but it's .js in core |
storyworks
commented
Jul 5, 2022
| @@ -0,0 +1,38 @@ | |||
| // Imports the Storybook's configuration API | |||
There was a problem hiding this comment.
storyworks
commented
Jul 5, 2022
| "include": ["src"] | ||
| "include": ["src"], | ||
|
|
||
| "ts-node": { |
There was a problem hiding this comment.
To fix typescript issue with storybook main
tataihono
approved these changes
Jul 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently I've created only a basic IonWrapper which wraps pages in .
We may later discover a need for an IconPageWrapper which also includes for smaller components.
I've modified the default introduction but kept it just as an example for how to write documentation
Will add Chromatic separately