npm package: @spwntch/components
Description: > ### This package is currently pre-release.
Author: spwntch
Latest version: 0.63.0

# Spawntech's React Ui Library

> ### This package is currently pre-release.

## What's in here?

This library includes all of Spawntech's base `react.js` components, including:

### Base Components

> **NOTE:**
>
> - In the majority of cases, the base components that we offer are standard implementations of [shadcn/ui](https://ui.shadcn.com/) components.
> - In some cases, we've added our own styling or additional features.

| Component       | Purpose                                                                                     |
| --------------- | ------------------------------------------------------------------------------------------- |
| Accordion       | Standard [shadcn/ui accordion](https://ui.shadcn.com/docs/components/accordion)             |
| Badge           | Standard [shadcn/ui badge](https://ui.shadcn.com/docs/components/badge)                     |
| Button          | Standard [shadcn/ui button](https://ui.shadcn.com/docs/components/button)                   |
| Card            | Standard [shadcn/ui card](https://ui.shadcn.com/docs/components/card)                       |
| Dropdown Menu   | Standard [shadcn/ui dropdown-menu](https://ui.shadcn.com/docs/components/dropdown-menu)     |
| Menu Bar        | Standard [shadcn/ui menubar](https://ui.shadcn.com/docs/components/menubar)                 |
| Navigation Menu | Standard [shadcn/ui navigation-menu](https://ui.shadcn.com/docs/components/navigation-menu) |
| Sheet           | Standard [shadcn/ui sheet](https://ui.shadcn.com/docs/components/sheet)                     |
| Table           | Standard [shadcn/ui table](https://ui.shadcn.com/docs/components/table)                     |

### Typography

| Component | Purpose                                                 |
| --------- | ------------------------------------------------------- |
| Code      | Use this to display a styled code tag                   |
| H1        | Use this to display a styled h1 tag                     |
| H2        | Use this to display a styled h2 tag                     |
| H3        | Use this to display a styled h3 tag                     |
| H4        | Use this to display a styled h4 tag                     |
| Large     | Use this to display styled large paragraph text         |
| Lead      | Use this to display styled lead paragraph text          |
| Li        | Use this to display a list item                         |
| Muted     | Use this to display styled muted paragraph text         |
| P         | Use this to display styled standard paragraph text      |
| Small     | Use this to display styled small paragraph text         |
| Ul        | Use this to display a unordered list containing Li tags |

### Brand Provider & Components

> **TODO**

### Nav Provider & Componentsz

> **TODO**

## Documentation & Stories

> **TODO**

## Getting Started

1. Install the package

```
npm i @spwntch/components
```

2. Import package styles

```
// app/globals.css

@import "@spwntch/components/styles";

```

3. Use our components

```
import { Button } from "@spwntch/components";

export default function MyComponent() {
  return <Button>click me</Button>;
}

```