# carbon-components-react

> The Carbon Design System is IBM’s open-source design system for products and experiences.

Latest version **8.67.0** (published 2024-09-26) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install carbon-components-react
pnpm add carbon-components-react
yarn add carbon-components-react
bun add carbon-components-react
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.67.0 |
| Published | 2024-09-26 |
| First published | 2017-05-30 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | separate (@types/carbon-components-react) |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 93.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Provenance | attested (Unknown) |
| GitHub stars | 9624 |
| Maintainers | tay1orjones, tjegan, carbon-bot, sstrubberg, adavila, flucca |
| Keywords | react, carbon, carbon-components, ibm, carbon-design-system, components |

## Links

- npm: https://www.npmjs.com/package/carbon-components-react
- Repository: https://github.com/carbon-design-system/carbon
- Homepage: https://github.com/carbon-design-system/carbon#readme
- Issues: https://github.com/carbon-design-system/carbon/issues
- npm.io page: https://npm.io/package/carbon-components-react

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) 1.1.3
- [@carbon/react](https://npm.io/package/@carbon/react.md) ^1.67.0
- [@carbon/styles](https://npm.io/package/@carbon/styles.md) ^1.66.0
- [@ibm/telemetry-js](https://npm.io/package/@ibm/telemetry-js.md) ^1.5.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

- 8.67.0 (latest) — 2024-09-26
- 7.60.5 (v10-next) — 2025-09-23
- 8.68.0-rc.0 (next) — 2024-10-07
- 7.26.0-alpha.0 (nightly) — 2020-12-03
- 6.116.4 (6.x) — 2020-07-27
- 7.7.0-alpha.5758 (canary) — 2019-09-16
- 5.53.1 (5.x) — 2019-05-13
- 7.0.0-beta.0 (beta) — 2019-03-21
- 7.60.4 — 2025-07-30
- 7.60.3 — 2025-06-26
- 7.60.2 — 2025-06-24
- 7.60.1 — 2025-05-14
- 8.67.1 — 2024-10-02
- 7.60.0 — 2024-09-30
- 8.67.0-rc.0 — 2024-09-23
- … 1167 more at https://npm.io/package/carbon-components-react/versions

## README

# carbon-components-react

> React components for the Carbon Design System

## Getting started

To install `carbon-components-react` in your project, you will need to run the
following command using [npm](https://www.npmjs.com/):

```bash
npm install -S carbon-components-react
```

If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
instead:

```bash
yarn add carbon-components-react
```

This package requires [Dart Sass](http://npmjs.com/package/sass) in order to
compile styles.

If you're new to Sass, or are wondering how to configure Sass for your project,
we recommend checking out the following resources and links:

- [Sass Basics](https://sass-lang.com/guide)
- [Webpack with Sass](https://webpack.js.org/loaders/sass-loader/)
- [Next.js with Sass](https://nextjs.org/docs/basic-features/built-in-css-support#sass-support)
- [Create React App with Sass](https://create-react-app.dev/docs/adding-a-sass-stylesheet/)
- [Parcel with Sass](https://v2.parceljs.org/languages/sass/)
- [Vite with Sass](https://vitejs.dev/guide/features.html#css-pre-processors)
- [Snowpack with Sass](https://www.snowpack.dev/guides/sass/)

Once you get Sass up and running in your project, configure Sass to include
`node_modules` in its `includePaths` option. For more information, checkout the
[configuration](../styles/docs/sass.md#configuration) section in our Sass docs.

## Usage

The `carbon-components-react` package provides components and icons for the
Carbon Design System.

To use a component, you can import it directly from the package:

```jsx
import { Button } from 'carbon-components-react';

function MyComponent() {
  return <Button>Example usage</Button>;
}
```

To include the styles for a specific component, you can either import all the
styles from the project or include the styles for a specific component:

```scss
// Bring in all the styles for Carbon
@use 'carbon-components-react';

// Preferred: bring in the styles for one component
@use 'carbon-components-react/scss/components/button';
```

For a full list of components available, checkout our
[Storybook](https://react.carbondesignsystem.com/).

## 📖 API Documentation

If you're looking for `carbon-components-react` API documentation, check out:

- [Storybook](https://react.carbondesignsystem.com/)
- [Icon Library](https://www.carbondesignsystem.com/guidelines/icons/library/)

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).

## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this
package as a dependency you are agreeing to telemetry collection. To opt out,
see
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
For more information on the data being collected, please see the
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).

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