# @apideck/components

> An open-source UI component library for the efficient development of beautiful React applications.

Latest version **0.13.3** (published 2025-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @apideck/components
pnpm add @apideck/components
yarn add @apideck/components
bun add @apideck/components
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.13.3 |
| Published | 2025-10-06 |
| First published | 2021-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 650.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 5 |
| Author | Jake Prins |
| Maintainers | gdewilde, nicklloyd, ritiksingh7, samzani, lagoni, jakeprins, gmenoiaa |
| Keywords | react, tailwindcss, components, apideck |

## Links

- npm: https://www.npmjs.com/package/@apideck/components
- Repository: https://github.com/apideck-io/components
- Homepage: https://github.com/apideck-io/components#readme
- npm.io page: https://npm.io/package/@apideck/components

## Dependencies (5)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [patch-package](https://npm.io/package/patch-package.md) ^6.4.7
- [@headlessui/react](https://npm.io/package/@headlessui/react.md) ^1.6.6
- [use-clipboard-copy](https://npm.io/package/use-clipboard-copy.md) ^0.2.0
- [postinstall-postinstall](https://npm.io/package/postinstall-postinstall.md) ^2.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.13.3 (latest) — 2025-10-06
- 0.8.4-1 (next) — 2022-02-18
- 0.13.2 — 2025-04-09
- 0.13.1 — 2025-04-09
- 0.12.21 — 2024-01-24
- 0.12.20 — 2023-12-21
- 0.12.19 — 2023-12-21
- 0.12.18 — 2023-12-21
- 0.12.17 — 2023-12-21
- 0.12.16 — 2023-10-23
- 0.12.15 — 2023-10-20
- 0.12.14 — 2023-10-17
- 0.12.13 — 2023-10-17
- 0.12.12 — 2023-10-03
- 0.12.11 — 2023-10-02
- … 125 more at https://npm.io/package/@apideck/components/versions

## README

# Apideck Component Library

An open-source UI component library for the efficient development of beautiful React applications.

Go to [developers.apideck.com/components](https://developers.apideck.com/components) for the full documentation.

## Usage

Install the component library

```sh
yarn add @apideck/components
```

The styles are scoped to the `apideck` class name so add it to the top-level parent or body tag.

```tsx
import { ModalProvider, ToastProvider } from '@apideck/components'
import { AppProps } from 'next/app'

const App = ({ Component, pageProps }: AppProps) => {
  return (
    <div className="apideck">
      <ModalProvider>
        <ToastProvider>{children}</ToastProvider>
      </ModalProvider>
    </div>
  )
}

export default App
```

Use components inside your project:

```js
import { Button } from '@apideck/components'

const App = () => {
  return <Button variant="primary" size="large" text="Yo, world!" />
}

export default App
```

If you are **NOT** using Tailwind CSS in your project, make sure to include the styles in your project:

```js
import '@apideck/components/dist/styles.css'
```

The components library is styled using [Tailwind CSS](https://tailwindcss.com/). If you were to use it in a project that also uses Tailwind CSS, you do not have to include the `styles.css` file but you should include the package path in the content path of the `tailwind.config.js`.

```js
// tailwind.config.js

module.exports = {
  content: ['./node_modules/@apideck/components/**/*.js'],
  ...
}
```

If want to overwrite the primary color you can add your custom colors to the `primary` color option inside your Tailwind configuration:

```js
// tailwind.config.js

module.exports = {
  content: ['./node_modules/@apideck/components/**/*.js'],
  theme: {
    extend: {
      colors: {
        primary: {
          50:  '#faf6f9',
          100: '#fae7f7',
          200: '#f5c4f3',
          300: '#f39dee',
          400: '#f469e7',
          500: '#f53fe1',
          600: '#e909ef',
          700: '#c81ead',
          800: '#9c1a81',
          900: '#7c1762',
        }
      }
    }
  }
  ...
}
```

### Components

- [Button](https://developers.apideck.com/components/button)
- [Card](https://developers.apideck.com/components/card)
- [CheckBox](https://developers.apideck.com/components/checkbox)
- [DateInput](https://developers.apideck.com/components/dateinput)
- [Dropdown](https://developers.apideck.com/components/dropdown)
- [Modal](https://developers.apideck.com/components/modal)
- [Select](https://developers.apideck.com/components/select)
- [TextArea](https://developers.apideck.com/components/textarea)
- [TextInput](https://developers.apideck.com/components/textinput)
- [Toast](https://developers.apideck.com/components/toast)
- [Toggle](https://developers.apideck.com/components/toggle)
- [Tooltip](https://developers.apideck.com/components/tooltip)

### Utils

- `useModal` and `ModalProvider`
- `useToast` and `ToastProvider`
- `useOutsideClick`
- `usePrevious`
- `useDebounce`

Please refer to the [Apideck docs](https://developers.apideck.com/components) for the full documentation.

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