reactoms
v0.2.0
Published
A React Components Library made with TypeScript, Sass & Vite
Downloads
91
Maintainers
Readme
Welcome to Reactoms !
A React Components Library made with TypeScript, Sass & Vite
Download
git clone https://github.com/philippebeck/reactoms.git
or
Latest Release
Package
NPM : npm i reactoms
or
Yarn : yarn add reactoms
Installation
Install the dependencies :$ npm i
Try
Run the Welcome UI to try the components :$ npm start
Usage
If you change the components code, you need to compile them :
$ npm run build
Then use the compiles files of the dist folder for your prod UI like this :
- inside your pages :
import { Card, Collapse, Icon, Image, Link, List, Title } from 'reactoms'
for the components - inside your index.html :
<style rel="stylesheet" href="node_modules/reactoms/dist/style.css"></style>
for the style
Content
Lib Assets :
- Style => imports variables & mixins + common styles
- Style Variables => breakpoints, fonts, colors, transforms
- Style Mixins => font-face & keyframes
Lib Atoms :
- Card => figure -> (figcaption)
- Collapse => details -> summary + figure
- Icon => i
- Image => img
- Link => a
- List => ul -> li
Lib Molecules :
- Button => a -> i + (b)
- Slider => figure -> (nav) + progress
- Title => hgroup -> (p) + h1 | h2 | h3 | h4 + (p)
Src Assets :
- Logos => ts, react, sass, vite
Src App :
- App => Homepage to test the library