OnielN14 / paper-component

React Component wrapper for PaperCSS. A monorepo study case.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Paper Component (React)

React component wrapper for PaperCSS.

The purpose of this project is to learn about building an npm package, monorepo, and npm workspace.

Currently, the packages is not intented to be using on production.

Installing Paper Component

To use Paper Component, you just need to install @paper-component/react package

npm install @paper-component/react
#or
yarn add @paper-component/react

Usage

To start using the components, please follow these steps:

  1. Import papercss on your application root:
import 'papercss';

function App() {
  ...
}
  1. Then, you can start using components:
import { Button } from "@paper-component/react"

function Example() {
  return <Button>Click Me!</Button>
}

Publishing

There is no plan to publish the packages publicly. You can try to publish the packages to your private registry such as Verdaccio.

Credit and License

MIT

Thanks to PaperCSS team!!

About

React Component wrapper for PaperCSS. A monorepo study case.

License:MIT License


Languages

Language:TypeScript 62.8%Language:JavaScript 19.1%Language:Handlebars 18.0%