# @carbon/utilities

> Utilities and helpers to drive consistency across software products using the Carbon Design System

Latest version **0.27.0** (published 2026-10-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @carbon/utilities
pnpm add @carbon/utilities
yarn add @carbon/utilities
bun add @carbon/utilities
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.27.0 |
| Published | 2026-10-07 |
| First published | 2024-09-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 278.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Provenance | attested (GitHub Actions) |
| Maintainers | carbon-design-system, carbon-bot, leechase, jeffreychew, sstrubberg |
| Keywords | ibm, carbon, carbon-design-system, carbon-utilities |

## Links

- npm: https://www.npmjs.com/package/@carbon/utilities
- 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/utilities

## Dependencies (3)

- [@ibm/telemetry-js](https://npm.io/package/@ibm/telemetry-js.md) ^1.6.1
- [temporal-polyfill](https://npm.io/package/temporal-polyfill.md) ^1.0.4
- [@internationalized/number](https://npm.io/package/@internationalized/number.md) ^3.6.1

## Recent versions

- 0.27.0 (latest) — 2026-10-07
- 0.27.0-rc.0 (next) — 2026-10-05
- 1.0.0-alpha.0 (v12-alpha) — 2026-09-30
- 0.26.0 — 2026-09-23
- 0.26.0-rc.0 — 2026-09-21
- 0.25.0 — 2026-08-27
- 0.25.0-rc.0 — 2026-08-24
- 0.24.0 — 2026-08-12
- 0.24.0-rc.0 — 2026-08-10
- 0.23.0 — 2026-07-30
- 0.23.0-rc.0 — 2026-07-29
- 0.22.0 — 2026-07-15
- 0.22.0-rc.0 — 2026-07-13
- 0.21.0 — 2026-07-01
- 0.21.0-rc.0 — 2026-06-29
- … 37 more at https://npm.io/package/@carbon/utilities/versions

## README

# @carbon/utilities

> Utilities and helpers to drive consistency across software products using the
> Carbon Design System

## Getting started

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

```bash
npm install @carbon/utilities
```

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

```bash
yarn add @carbon/utilities
```

## Maintainer information

This package uses a convention-based multi-entry build. The supported public API
consists of two parts.

1. The root entrypoint

```js
import { utility } from '@carbon/utilities';
```

2. Any top-level module with a `src/<name>/index.ts` file

```js
import { utility } from '@carbon/utilities/utility';
```

Review the
[architecture decision record (ADR)](../../docs/decisions/0004-adopt-explicit-package-entrypoints-for-utilities.md)
for more detail on how and why this approach is used.

### Internal modules

Some directories under `src/` are marked as internal and are NOT exported from
the package root or as public entrypoints. These modules are intended for use
only by other Carbon packages (e.g., `@carbon/react`, `@carbon/web-components`)
and should not be used by external consumers.

Internal modules:

- `src/date-picker/` - Shared date picker primitives for React and Web
  Components

To use internal modules within Carbon packages:

```js
import { utility } from '@carbon/utilities/src/internal-module';
```

**Note**: Internal modules are not part of the public API and may change without
notice. External consumers should not depend on these modules.

### Adding a utility

1. Create a new top-level directory under `src/`
2. Export the public API for that utility from `src/<name>/index.ts`
3. Re-export it from `src/index.ts` if it should also be available from the
   package root
4. Build the package and verify the generated outputs under `es/<name>/index.*`
   and `lib/<name>/index.js`

```text
src/
  someUtility/
    index.ts
    someUtility.ts
```

## 🙌 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 de-identified and anonymized 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/utilities · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
