components-fast
v0.0.4
Published
✨ Fast and customizable ✨ Easy to use ✨ It doesn't weigh too much ✨ [Github project](https://github.com/dariomvg/components-ui) ## Getting started ### Installation ```bash npm install components-fast ``` ### Usage Import your component and use it.
Downloads
6
Readme
Components fast
✨ Fast and customizable
✨ Easy to use
✨ It doesn't weigh too much
✨ Github project
Getting started
Installation
npm install components-fast
Usage
Import your component and use it.
import {Button} from 'components-fast'
export default function GetButton () {
return (
<Button bg="blue" onClick={yourFunction}>Send</Button>
)
}
Command run and view in localhost
npm run dev
Table of Contents
Installation
npm install components-fast
check if it has been installed correctly in your package.json
{
"name": "your-project",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build",
},
"dependencies": {
"components-fast": "^0.0.1", // ← here
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {...}
}
Imports
import {Button, Badge} from "components-fast"
Components
Badge
<Badge variant="blue">React</Badge>
Button
<Button bg="orange" onClick={yourFunction}>Send</Button>
Card
<Card bg="dark"><h1>Hello world</h1></Card>
Loader
<Loader />
CarrouselImages
<CarrouselImages array={images} width="500px" height="450px" />
Collapse
<Collapse title="box title" bg="dark"><p>Hello world</p></Collapse>
Modal
<Modal titleButton="open modal"><p>Hello world</p></Modal>
Toggle
<Toggle onClick={yourFunction} />
Props
| Components | props | Details
| ------------- | ------------- | -------------
| Badge | bg/width/variant | Variant and bg cannot be both together |
| Button | bg/onClick| bg = colors |
| Card | bg | bg = dark / light |
| CarrouselImages| array/auto/time/width/height| only images |
| Collapse| title/bg/width | bg = dark / light |
| Modal | titleButton| button title |
| Loader | without props | - |
| Toggle | without props| onClick |
Colors
- violet
- blue
- green
- orange
- yellow
- purple
- red
- teal
- transparent
colors for card and Collapse
- dark
- light
Badge variant colors
- bg and variant cannot be together in Badge component
- violet
- blue
- green
- gray
- yellow
- orange
- red
- teal
- pink