0.2.4 • Published 12 days ago

@pantheon-systems/react-kit v0.2.4

Weekly downloads
-
License
GPL-3.0-or-later
Repository
github
Last release
12 days ago

Pantheon Systems React Kit

React components built with DaisyUI, a Tailwindcss library, for use in metaframework packages like nextjs-kit and gatsby-kit, or on its own.

Installation

To install this package to use in your application, install it and its peer dependencies:

npm install @pantheon-systems/react-kit react react-dom
npm install tailwindcss daisyui -D

Usage

Modules can be imported or required from the @pantheon-systems/react-kit package. For example, to use the Button component:

import { Button } from '@pantheon-systems/react-kit/Button';

API Reference

To see the API reference for @pantheon-systems/react-kit, visit our docs site

Contributing

Please see the Contributing guide in our monorepo

Development Notes

  • the rk prefix is used for tailwindcss and daisyui classes
  • New components should be added to the src/components directory. Ensure new components are also added to the react-kit options in the web/generateTypeDocOptions.js file so that all components have their own page in the API reference.