# @committed/components

> Committed Component Library

Latest version **8.2.1** (published 2023-02-23) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.2.1 |
| Published | 2023-02-23 |
| First published | 2019-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 29 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Committed |
| Maintainers | chrisflatley, commitd_jon, stuarthendren, devil-ci |

## Links

- npm: https://www.npmjs.com/package/@committed/components
- Repository: https://github.com/commitd/components
- Homepage: https://github.com/commitd/components#readme
- Issues: https://github.com/commitd/components/issues
- npm.io page: https://npm.io/package/@committed/components

## Dependencies (29)

- [@mdi/js](https://npm.io/package/@mdi/js.md) ^6.6.96
- [@stitches/react](https://npm.io/package/@stitches/react.md) ^1.2.8
- [@committed/hooks](https://npm.io/package/@committed/hooks.md) ^0.8.0
- [@radix-ui/colors](https://npm.io/package/@radix-ui/colors.md) ^0.1.8
- [@radix-ui/react-slot](https://npm.io/package/@radix-ui/react-slot.md) ^1.0.0
- [@radix-ui/react-tabs](https://npm.io/package/@radix-ui/react-tabs.md) ^1.0.0
- [@radix-ui/react-label](https://npm.io/package/@radix-ui/react-label.md) ^1.0.0
- [@radix-ui/react-toast](https://npm.io/package/@radix-ui/react-toast.md) ^1.0.0
- [@radix-ui/react-avatar](https://npm.io/package/@radix-ui/react-avatar.md) ^1.0.0
- [@radix-ui/react-dialog](https://npm.io/package/@radix-ui/react-dialog.md) ^1.0.0
- [@radix-ui/react-select](https://npm.io/package/@radix-ui/react-select.md) ^1.0.0
- [@radix-ui/react-slider](https://npm.io/package/@radix-ui/react-slider.md) ^1.0.0
- [@radix-ui/react-switch](https://npm.io/package/@radix-ui/react-switch.md) ^1.0.0
- [@radix-ui/react-toggle](https://npm.io/package/@radix-ui/react-toggle.md) ^1.0.0
- [@radix-ui/react-popover](https://npm.io/package/@radix-ui/react-popover.md) ^1.0.0
- [@radix-ui/react-tooltip](https://npm.io/package/@radix-ui/react-tooltip.md) ^1.0.0
- [@radix-ui/react-checkbox](https://npm.io/package/@radix-ui/react-checkbox.md) ^1.0.0
- [@radix-ui/react-progress](https://npm.io/package/@radix-ui/react-progress.md) ^1.0.0
- [@radix-ui/react-accordion](https://npm.io/package/@radix-ui/react-accordion.md) ^1.0.0
- [@radix-ui/react-separator](https://npm.io/package/@radix-ui/react-separator.md) ^1.0.0
- [@radix-ui/react-hover-card](https://npm.io/package/@radix-ui/react-hover-card.md) ^1.0.0
- [@radix-ui/react-radio-group](https://npm.io/package/@radix-ui/react-radio-group.md) ^1.0.0
- [@radix-ui/react-alert-dialog](https://npm.io/package/@radix-ui/react-alert-dialog.md) ^1.0.0
- [@radix-ui/react-aspect-ratio](https://npm.io/package/@radix-ui/react-aspect-ratio.md) ^1.0.0
- [@radix-ui/react-context-menu](https://npm.io/package/@radix-ui/react-context-menu.md) ^1.0.0
- [@radix-ui/react-toggle-group](https://npm.io/package/@radix-ui/react-toggle-group.md) ^1.0.0
- [@radix-ui/react-dropdown-menu](https://npm.io/package/@radix-ui/react-dropdown-menu.md) ^1.0.0
- [@radix-ui/react-navigation-menu](https://npm.io/package/@radix-ui/react-navigation-menu.md) ^1.0.0
- [@radix-ui/react-visually-hidden](https://npm.io/package/@radix-ui/react-visually-hidden.md) ^1.0.0

## Recent versions

- 8.2.1 (latest) — 2023-02-23
- 4.3.0-beta.1 (beta) — 2021-07-20
- 8.2.0 — 2023-01-30
- 8.1.5 — 2022-10-12
- 8.1.4 — 2022-10-04
- 8.1.3 — 2022-09-28
- 8.1.2 — 2022-09-28
- 8.1.1 — 2022-09-19
- 8.1.0 — 2022-08-19
- 8.0.0 — 2022-08-08
- 7.3.0 — 2022-05-23
- 7.2.0 — 2022-05-17
- 7.1.0 — 2022-05-16
- 7.0.2 — 2022-04-22
- 7.0.1 — 2022-04-19
- … 42 more at https://npm.io/package/@committed/components/versions

## README

# Committed Components

[![Committed Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fcommitted.io%2Fbadge)](https://committed.io)
![Build Status](https://github.com/commitd/components/workflows/build/badge.svg?branch=main)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=commitd_components&metric=alert_status&token=aa002ca75e2f3a6d028af9074bceeda1ffa2f9f7)](https://sonarcloud.io/dashboard?id=commitd_components)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=commitd_components&metric=coverage&token=aa002ca75e2f3a6d028af9074bceeda1ffa2f9f7)](https://sonarcloud.io/dashboard?id=commitd_components)
![GitHub repo size](https://img.shields.io/github/repo-size/commitd/components)
[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://committed.software/components)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

For documentation see https://committed.software/components

## Install

```bash
yarn add @committed/components
```

## Usage

```tsx
import * as React from 'react'

import { Component } from '@committed/components'

class Example extends React.Component {
  render() {
    return <Component />
  }
}
```

## Development

We are using npm v7, and due to issues with peer dependencies we are currently required to do

```bash
npm install --force
```

The main build is performed using esbuild:

```bash
npm run build
```

We use storybook to develop and document the components, this is run in development using

```bash
npm run storybook
```

The tests can be run with

```bash
npm test
```

## Dev Containers

This project contains a [VSCode Dev Container Configuration](https://code.visualstudio.com/docs/remote/containers).

To use this, you must install the [VSCode Remote Container Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).

Once this is installed, you should be prompted (when opening the project in it's root directory) to `Reopen in Container`. If this prompt does not appear, open the Command Palette and run `Remote Containers: Rebuild and Reopen in Container`.

This will re-open the project, with the project files mounted in a Docker container, which will include all the VSCode extensions from the dev container (e.g. useful extensions, formatters etc).

## CI

Pull requests go through CI checks using Github Actions. Releases update the deployed documentation and update the package in the NPM registry.

## License

[MIT](/LICENSE) - © Committed Software 2019-2022 https://committed.io

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