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

1. Checkout development branch
2. Pull the latest changes from development with git pull
3. Install the latest changes in development with npm install
4. Create and checkout your new branch, name it as issue_name-issue_number/component_name or any other relevant name you choose
5. 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 in src/components/your_component_folder/YourComponent.styles.js and export them, then import them in YourComponent.js
• If you choose to use css, put your styles in src/components/your_component_folder/YourComponent.styles.css , then import them in YourComponent.js

6. 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

7. Export your component for public consumption in src/index.js use the format export {default as YourComponent} from './components/your_component_folder/YourComponent'
8. Lint your code

• Run npm run lint:fix

9. Commit your changes
10. Push your code create a PR