# @novem-ui/badge

> Badge component from novem-ui

Latest version **0.0.2-alpha.5** (published 2022-01-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install @novem-ui/badge
pnpm add @novem-ui/badge
yarn add @novem-ui/badge
bun add @novem-ui/badge
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2-alpha.5 |
| Published | 2022-01-18 |
| First published | 2022-01-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Leonel Vieyra |
| Maintainers | leonelv |

## Links

- npm: https://www.npmjs.com/package/@novem-ui/badge
- Repository: https://github.com/jdrets/novem-ui
- Homepage: https://github.com/jdrets/novem-ui/tree/main/packages/badge#readme
- Issues: https://github.com/jdrets/novem-ui/issues
- npm.io page: https://npm.io/package/@novem-ui/badge

## Dependencies (2)

- [@novem-ui/base](https://npm.io/package/@novem-ui/base.md) ^0.0.2-alpha.5
- [@novem-ui/theme](https://npm.io/package/@novem-ui/theme.md) ^0.0.2-alpha.4

## Recent versions

- 0.0.2-alpha.5 (latest) — 2022-01-18
- 0.0.2-alpha.4 — 2022-01-18
- 0.0.2-alpha.3 — 2022-01-18
- 0.0.2-alpha.2 — 2022-01-18
- 0.0.2-alpha.1 — 2022-01-18
- 0.0.2-alpha.0 — 2022-01-18

## README

# @novem-ui/badge


## Usage

Both components have [SpacingProps](../base/src/spacing/README.md)

### `<Badge />`

The component has the following props:
- `baseColor` (Optional): It can be any color from the theme, uses `orange` by default.
- `size` (Optional): It can be `sm` or `lg`, uses `lg` by default. 
- `hierarchy` (Optional): It can be `loud` or `quiet`, uses `loud` by default. 

```tsx
import { Badge, ThemeProvider } from '@novem-ui/core'
// or
import { Badge } from '@novem-ui/badge'
import { ThemeProvider } from '@novem-ui/theme'

function App() {
  return (
    <ThemeProvider>
        <Badge>
            Example badge
        </Badge>
    </ThemeProvider>
  )
}
```

### `<FeedbackBadge />`

The component has the following props:
- `variant` (Required): It can be `error` or `success`.


```tsx
import { FeedbackBadge, ThemeProvider } from '@novem-ui/core'
// or
import { FeedbackBadge } from '@novem-ui/badge'
import { ThemeProvider } from '@novem-ui/theme'

function App() {
  return (
    <ThemeProvider>
        <FeedbackBadge variant="success" />
    </ThemeProvider>
  )
}
```

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