# @aura-ui/button

> A react button component, used to trigger an action.

Latest version **0.0.3-alpha.3** (published 2023-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @aura-ui/button
pnpm add @aura-ui/button
yarn add @aura-ui/button
bun add @aura-ui/button
```

## 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.3-alpha.3 |
| Published | 2023-01-08 |
| First published | 2023-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 51.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Greg Ogun |
| Maintainers | gregogun |

## Links

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

## Dependencies (2)

- [@aura-ui/theme](https://npm.io/package/@aura-ui/theme.md) 0.0.2
- [@aura-ui/utils](https://npm.io/package/@aura-ui/utils.md) 0.0.2

## Recent versions

- 0.0.3-alpha.3 (latest) — 2023-01-08
- 0.0.3-alpha.2 — 2023-01-08
- 0.0.3-alpha.1 — 2023-01-08
- 0.0.2 — 2023-01-08
- 0.0.1 — 2023-01-08

## README

# Button

Aura UI Button component.

## Installation

```sh
npm install @aura-ui/button
# or
yarn add @aura-ui/button
```

```## Contribution
Yes we'd love you to contribute! See the [contributing
guidelines](https://github.com/aura-ui/aura-ui/blob/main/CONTRIBUTING.md) for details. ##
Licence This project is licensed under the terms of the [MIT
license](https://github.com/aura-ui/aura-ui/blob/main/LICENSE).
```

## Import Components

```jsx
import { Button } from '@aura-ui/button';
```

## Component

`Button`: A react button component that is used to trigger an action.

## Usage

### Button Sizes

```
  <Flex>
    <Button size="1">Button</Button>
    <Button size="2">Button</Button>
    <Button size="3">Button</Button>
  </Flex>
```

### Button Variant

```
  <Flex>
    <Button variant="subtle">Subtle</Button>
    <Button variant="outline">Outline</Button>
    <Button variant="solid">Solid</Button>
    <Button variant="ghost">Ghost</Button>
  </Flex>
```

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