# @bold-ui/react

> Modern, fast, and accessible React component library

Latest version **0.0.2** (published 2023-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bold-ui/react
pnpm add @bold-ui/react
yarn add @bold-ui/react
bun add @bold-ui/react
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-07-11 |
| First published | 2023-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 3 |
| Unpacked size | 118.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Pawan Kolhe |
| Maintainers | pawankolhe |
| Keywords | react, react-components, design-system, ui, accessible, boldui |

## Links

- npm: https://www.npmjs.com/package/@bold-ui/react
- Repository: https://github.com/PawanKolhe/bold-ui
- Homepage: https://github.com/PawanKolhe/bold-ui#readme
- Issues: https://github.com/PawanKolhe/bold-ui/issues
- npm.io page: https://npm.io/package/@bold-ui/react

## Dependencies (3)

- [clsx](https://npm.io/package/clsx.md) ^1.2.1
- [react-uid](https://npm.io/package/react-uid.md) ^2.3.3
- [react-icons](https://npm.io/package/react-icons.md) ^4.9.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2023-07-11
- 0.0.1 — 2023-06-02

## README

# Bold UI

<p>
  <a href="https://www.npmjs.com/package/@bold-ui/react">
    <img src="https://img.shields.io/npm/v/@bold-ui/react?style=flat-square" alt="npm version" />
  </a>
  <!-- <a href="https://www.npmjs.com/package/@bold-ui/react">
    <img src="https://img.shields.io/npm/dw/@bold-ui/react?style=flat-square" alt="npm downloads" />
  </a>
  <img src="https://img.shields.io/bundlephobia/minzip/@bold-ui/react?style=flat-square" alt="size" />
  <a href="https://www.jsdelivr.com/package/npm/@bold-ui/react">
    <img src="https://data.jsdelivr.com/v1/package/npm/@bold-ui/react/badge" alt="jsdelivr" />
  </a> -->
  <img src="https://img.shields.io/npm/l/@bold-ui/react?style=flat-square" alt="license" />
</p>

Modern, fast, and accessible React component library

## ✨ Features

- 📦 A set of high-quality React components out of the box
- 🌲 Tree-shakeable - Include only the components you use
- ⚡ Prebuild CSS - No dependency on any CSS library (Emotion, styled-components, etc)
- 🚀 Fast & Small - Light-weight components. Check [bundle size](https://bundlephobia.com/package/@bold-ui/react).
- ♿ Accessible - Follows Web Accessibility Initiative (WAI) standards
- 🛡️ Types included - Written in TypeScript with predictable static types

## 💻 Demo

- [Storybook](https://main--64797a8b450504bdbcae2912.chromatic.com)

## 📦 Installation

```
# npm
npm i @bold-ui/react

# yarn
yarn add @bold-ui/react

# pnpm
pnpm add @bold-ui/react
```

## 🔨 Usage

Just one step required before you can use this library:

1. Import core CSS (`core.css`) in your project root file (`App.js` or `index.js`). This css file contains CSS Variables required by the library.

   ```javascript
   // App.js
   import "@bold-ui/react/dist/css/core.css"; // Imports CSS Variables required by the library
   ...
   ```

1. Ready to use components 🎉

   ```javascript
   // MyComponent.jsx
   import { Button, Input } from "@bold-ui/react";

   const MyComponent = () => {
     return (
       <div>
         <Input kind="outline" />
         <Button kind="fill">Bold UI</Button>
       </div>
     );
   };
   ```

> **Note:** You'll need a CSS loader in your module bundler for styles to load. If you use [Vite](https://vitejs.dev/guide/features.html#css) or [create-react-app](https://create-react-app.dev/), it already comes with a CSS loader.

## 🗂 Components

### Inputs

- [**Button**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Button/Button.types.ts)
- [**Checkbox**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Checkbox/Checkbox.types.ts)
  - [**CheckboxGroup**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Checkbox/CheckboxGroup/CheckboxGroup.types.ts)
- [**Input**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Input/Input.types.ts)
- [**Radio**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Radio/Radio.types.ts)
  - [**RadioGroup**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Radio/RadioGroup/RadioGroup.types.ts)

### Layout

- [**Stack**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Stack/Stack.types.ts)
- [**Grid**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Grid/Grid.types.ts)
  - [**GridItem**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Grid/GridItem.types.ts)

### Overlays

- [**Modal**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Modal/Modal.types.ts)
- [**Drawer**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Drawer/Drawer.types.ts)

### Data Display

- [**Avatar**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Avatar/Avatar.types.ts)
  - [**AvatarGroup**](https://github.com/PawanKolhe/bold-ui/blob/main/packages/react/src/components/Avatar/AvatarGroup.types.ts)

_Feel free to request a new component by [opening an issue](https://github.com/PawanKolhe/bold-ui/issues)._

## 🖱 Environment Support

- Modern browsers
- [Browserslist](https://browsersl.ist/#q=defaults)
  - all browser versions with > 0.5% of the audience worldwide
  - last 2 versions of each browser
  - exclude dead browser versions

## 💙 Inspiration

Bold UI is inspired by [Mantine UI](https://mantine.dev/) and [Chakra UI](https://chakra-ui.com/).

## 📜 License

This software is open source, licensed under the [MIT License](https://github.com/PawanKolhe/bold-ui/blob/main/LICENSE).

---
_Source: https://npm.io/package/@bold-ui/react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
