badger-react-ui
v0.0.1
Published
This is a collection of React UI components using the [Badger CSS](https://abw.github.io/badger-css/) styles.
Downloads
1
Readme
Badger React UI
This is a collection of React UI components using the Badger CSS styles.
Documentation Website
See the website for documentation and demonstrations.
https://abw.github.io/badger-react-ui/
Getting Started
Add the @abw/badger-react-ui
module to your project using your favourite
package manager.
## using npm
$ npm add @abw/badger-react-ui
## using yarn
$ yarn add @abw/badger-react-ui
## using pnpm
$ pnpm add @abw/badger-react-ui
You can then import the CSS file into your site or application. You'll also need to import the Badger CSS stylesheet.
For example, to import it into a React app running under Vite, Next.js, etc., you can import the stylesheets directly into your application.
import '@abw/badger-css/styles/badger.min.css';
import '@abw/badger-react-ui/styles/badger-react-ui.min.css';
If you're using SASS / SCSS then you can import the main SCSS source file into your stylesheet.
@import '@abw/badger-css/styles/badger.scss';
@import '@abw/badger-react-ui/styles/badger-react-ui.scss';
Notes for Maintainers
Check out the repository.
$ git clone https://github.com/abw/badger-react-ui.git
$ cd badger-react-ui
Install the dependencies.
$ pnpm install
To run the development server.
$ pnpm dev
To build for production.
$ pnpm build
To build the documentation.
$ pnpm build:docs
To preview the documentation.
$ pnpm preview
Check source code for formatting errors.
$ pnpm lint
Author
Andy Wardley