mungwin-react-elements
v1.0.4
Published
A react component library for mungwin
Downloads
3
Readme
Mungwin React Elements
A React components library for Mungwin
Your Design counts
If you have a component you love and want to build, this is the place to build it before using it in any mungwin project.
Proposed workflow
- Checkout
development
branch - Pull the latest changes from
development
withgit pull
- Install the latest changes in
development
withnpm install
- Create and checkout your new branch, name it as
issue_name-issue_number/component_name
or any other relevant name you choose - Design your component
- Your component should be reusable and customizable
- You can use
css file imports
or@emotion/styled
whichever you choose is up to you - Put your components in
src/components/your_component_folder/YourComponent.component.js
- If you choose to use styled components with
@emotion/styled
, put your styles insrc/components/your_component_folder/YourComponent.styles.js
and export them, then import them inYourComponent.js
- If you choose to use css, put your styles in
src/components/your_component_folder/YourComponent.styles.css
, then import them inYourComponent.js
- Test your component with storybook
- Put your component stories in
src/components/your_component_folder/YourCompnent.stories.js
- Test their functionality, it should look
great
- Export your component for public consumption in
src/index.js
use the formatexport {default as YourComponent} from './components/your_component_folder/YourComponent'
- Lint your code
- Run
npm run lint:fix
- Commit your changes
- Push your code create a
PR