30 lines
479 B
Markdown
30 lines
479 B
Markdown
# PortalJS React Components
|
|
|
|
**Storybook:** https://storybook.portaljs.org
|
|
**Docs**: https://portaljs.org/docs
|
|
|
|
## Usage
|
|
|
|
To install this package on your project:
|
|
|
|
```bash
|
|
npm i @portaljs/components
|
|
```
|
|
|
|
> Note: React 18 is required.
|
|
|
|
You'll also have to import the styles CSS file in your project:
|
|
|
|
```ts
|
|
// E.g.: Next.js => pages/_app.tsx
|
|
import '@portaljs/components/styles.css'
|
|
```
|
|
|
|
## Dev
|
|
|
|
Use Storybook to work on components by running:
|
|
|
|
```bash
|
|
npm run storybook
|
|
```
|