Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axafrance/react-toolkit
Flexible components html + css + react using BEM convention. Maybe, you can call it "Design System" !
https://github.com/axafrance/react-toolkit
axa bem-convention design-system front-end-development javascript reactjs software storybook tools
Last synced: 22 days ago
JSON representation
Flexible components html + css + react using BEM convention. Maybe, you can call it "Design System" !
- Host: GitHub
- URL: https://github.com/axafrance/react-toolkit
- Owner: AxaFrance
- License: mit
- Created: 2018-11-12T09:04:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T14:39:55.000Z (28 days ago)
- Last Synced: 2024-10-09T11:39:31.088Z (27 days ago)
- Topics: axa, bem-convention, design-system, front-end-development, javascript, reactjs, software, storybook, tools
- Language: TypeScript
- Homepage: https://axafrance.github.io/design-system/
- Size: 59.5 MB
- Stars: 97
- Watchers: 17
- Forks: 63
- Open Issues: 101
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# @axa-fr/react-toolkit
[](https://dev.azure.com/axaguildev/react-toolkit)
[](https://sonarcloud.io/dashboard?id=AxaGuilDEv_react-toolkit) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-toolkit&metric=reliability_rating) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-toolkit&metric=security_rating) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-toolkit&metric=Coverage)
[](https://lernajs.io/) [](https://twitter.com/intent/follow?screen_name=GuildDEvOpen)
- [About](#about)
- [Getting Started](#getting-started)
- [Packages](#packages)
- [Concept](#concept)
- [How Does It Work](#how-does-it-work)
- [List of supported browsers](#list-of-supported-browsers)
- [Contribute](#contribute)
- [Roadmap](#roadmap)
## About
A set of independent components. Awesome library based on HTML and CSS using BEM convention with the JavaScript ReactJS implementation. Each component is autonomous and extensible. Pick and use only what you need!
**How _React-toolkit_ does CSS isolation?**
Only by using [BEM (Block Element Modifier)](http://getbem.com) CSS convention. No need for intricate technologies, just pragmatism.
Components are simple to use (just drag and drop it), simple to customize (by using CSS modifier) to your own need. Each component may evaluate internally (HTML, CSS, JS) and minimize any impact on your application.
You can easily build a new app from scratch or integrate some components into an existing application.
[html+css documentation website](https://axafrance.github.io?target=react_toolkit_storybook)
[react storybook website](https://axafrance.github.io?target=react_toolkit_design)
## Getting Started
Make you sure that [sass](https://www.npmjs.com/package/sass) and [bootstrap](https://www.npmjs.com/package/bootstrap) modules are installed :
```sh
npm install -D sass
npm install [email protected]
```
After installing bootstrap, add these css imports in the root file of your components tree :
```js
import 'bootstrap/scss/bootstrap-grid.scss';
import 'bootstrap/scss/bootstrap-reboot.scss';
```
You can either install everything and use only what you need. If you do that you will be able to use tree shaking to have a smaller bundle.
However, you will need to import all the styles and not only the style related to your component.
```sh
npm install @axa-fr/react-toolkit-all --save
```
```javascript
import React from 'react';
import { Alert } from '@axa-fr/react-toolkit-all';
import '@axa-fr/react-toolkit-all/dist/style/af-toolkit-core.scss';
const MyAlertComponent = () => ;
```
Or you can install only the components you need:
```sh
npm install @axa-fr/react-toolkit-alert --save
```
```javascript
import React from 'react';
import Alert from '@axa-fr/react-toolkit-alert';
import '@axa-fr/react-toolkit-alert/dist/alert.scss';
const MyAlertComponent = () => ;
```
## Packages
- [@axa-fr/react-toolkit-all](./packages/all/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-all)
- [@axa-fr/react-toolkit-action](./packages/action/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-action)
- [@axa-fr/react-toolkit-alert](./packages/alert/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-alert)
- [@axa-fr/react-toolkit-badge](./packages/badge/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-badge)
- [@axa-fr/react-toolkit-button](./packages/button/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-button)
- [@axa-fr/react-toolkit-collapse](./packages/collapse/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-collapse)
- [@axa-fr/react-toolkit-core](./packages/core/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-core)
- [@axa-fr/react-toolkit-form-core](./packages/Form/core/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-core)
- [@axa-fr/react-toolkit-form-filter](./packages/Form/filter/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-filter)
- [@axa-fr/react-toolkit-form-filter-inline](./packages/Form/filter-inline/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-filter-inline)
- [@axa-fr/react-toolkit-form-input-card](./packages/Form/Input/card/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-card)
- [@axa-fr/react-toolkit-form-input-checkbox](./packages/Form/Input/checkbox/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-checkbox)
- [@axa-fr/react-toolkit-form-input-choice](./packages/Form/Input/choice/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-choice)
- [@axa-fr/react-toolkit-form-input-date](./packages/Form/Input/date/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-date)
- [@axa-fr/react-toolkit-form-input-file](./packages/Form/Input/file/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-file)
- [@axa-fr/react-toolkit-form-input-number](./packages/Form/Input/number/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-number)
- [@axa-fr/react-toolkit-form-input-pass](./packages/Form/Input/pass/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-pass)
- [@axa-fr/react-toolkit-form-input-radio](./packages/Form/Input/radio/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-radio)
- [@axa-fr/react-toolkit-form-input-select](./packages/Form/Input/select/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-select)
- [@axa-fr/react-toolkit-form-input-select-multi](./packages/Form/Input/select-multi/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-select-multi)
- [@axa-fr/react-toolkit-form-input-slider](./packages/Form/Input/slider/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-slider)
- [@axa-fr/react-toolkit-form-input-switch](./packages/Form/Input/switch/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-switch)
- [@axa-fr/react-toolkit-form-input-text](./packages/Form/Input/text/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-text)
- [@axa-fr/react-toolkit-form-input-textarea](./packages/Form/Input/textarea/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-input-textarea)
- [@axa-fr/react-toolkit-form-steps](./packages/Form/steps/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-steps)
- [@axa-fr/react-toolkit-form-summary](./packages/Form/summary/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-form-summary)
- [@axa-fr/react-toolkit-help](./packages/help/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-help)
- [@axa-fr/react-toolkit-icon](./packages/icon/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-icon)
- [@axa-fr/react-toolkit-layout-footer](./packages/Layout/footer/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-layout-footer)
- [@axa-fr/react-toolkit-layout-footer-client](./packages/Layout/footer-client/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-layout-footer-client)
- [@axa-fr/react-toolkit-layout-header](./packages/Layout/header/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-layout-header)
- [@axa-fr/react-toolkit-link](./packages/link/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-link)
- [@axa-fr/react-toolkit-loader](./packages/loader/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-loader)
- [@axa-fr/react-toolkit-modal-boolean](./packages/Modal/boolean/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-modal-boolean)
- [@axa-fr/react-toolkit-modal-default](./packages/Modal/default/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-modal-default)
- [@axa-fr/react-toolkit-panel](./packages/panel/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-panel)
- [@axa-fr/react-toolkit-popover](./packages/popover/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-popover)
- [@axa-fr/react-toolkit-restitution](./packages/restitution/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-restitution)
- [@axa-fr/react-toolkit-table](./packages/table/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-table)
- [@axa-fr/react-toolkit-tabs](./packages/tabs/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-tabs)
- [@axa-fr/react-toolkit-title](./packages/title/README.md) [](https://www.npmjs.com/package/@axa-fr/react-toolkit-title)
## Concept
Each component should be autonomous (HTML + CSS + JS) and extensible.
## How Does It Work
- HTML/CSS :
- BEM convention is used in order to break CSS cascading problem
- SCSS and CSS files are avalaible for every component and can be overrided or extended
- [HTML/CSS Documentation](https://axafrance.github.io?target=react_toolkit_storybook)
- React :
- Components are stateless by default
- Some Higher-Order Components (HOC) are stateful but feel free to use the stateless one if it fits your use case
- [React documentation](https://axafrance.github.io?target=react_toolkit_design)
## List of supported browsers
Here is the list of browsers we tested this toolkit on:
- Chrome 84+
- Firefox 79+
- Microsoft Edge 85+
- Internet Explorer 11
- Safari 13.1+
- Opera 71+
## Contribute
- [How to run the solution and to contribute](./CONTRIBUTING.md)
- [Please respect our code of conduct](./CODE_OF_CONDUCT.md)
## Roadmap
- Update general documentation
- Migrating to TypeScript all components
- Fix the issues and clean code. Make it simpler, faster, lighter