# @britannica/ui

> Consumer style system

Latest version **1.21.2** (published 2025-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @britannica/ui
pnpm add @britannica/ui
yarn add @britannica/ui
bun add @britannica/ui
```

## Health

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

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

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.21.2 |
| Published | 2025-08-29 |
| First published | 2020-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 636.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ryan Walters |
| Maintainers | ryanwalters, jsmykil, arminbro, schembri, britannicabot |
| Keywords | britannica, consumer, style, system |

## Links

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

## Dependencies (2)

- [sass](https://npm.io/package/sass.md) ^1.33.0 || ^2
- [classnames](https://npm.io/package/classnames.md) 2.5.1

## Recent versions

- 1.21.2 (latest) — 2025-08-29
- 1.22.0-beta.3 (beta) — 2026-11-19
- 2.0.0-v2.14 (alpha) — 2024-07-01
- 1.22.0-beta.2 — 2025-09-24
- 1.22.0-beta.1 — 2025-08-29
- 1.21.2-beta.1 — 2025-06-04
- 1.21.1-beta.2 — 2025-06-04
- 1.21.1 — 2025-05-15
- 1.21.1-beta.1 — 2025-05-15
- 1.21.0-beta.1 — 2025-05-15
- 1.21.0 — 2025-05-05
- 1.20.5-beta.1 — 2025-05-05
- 1.20.4-beta.1 — 2025-04-09
- 1.20.4 — 2024-08-26
- 1.20.3 — 2024-08-26
- … 190 more at https://npm.io/package/@britannica/ui/versions

## README

# @britannica/ui

> Consumer style system and React component library

**Storybook:** https://britannica.github.io/consumer-ui

## Installation and Basic Usage

```
npm install @britannica/ui
```

### Include the CSS

Via JavaScript:

```js
// Your app's main application file. e.g. index.js or App.js
import '@britannica/ui/dist/britannica-ui.css';
```

Via CSS:

```css
@import '~@britannica/ui/dist/britannica-ui.css';
```

Via HTML:

```html
<!-- You can specify a specific version -->
<link href="https://unpkg.com/@britannica/ui@0.2.5/dist/britannica-ui.css" rel="stylesheet" />

<!-- Or if you always want the latest -->
<link href="https://unpkg.com/@britannica/ui@latest/dist/britannica-ui.css" rel="stylesheet" />
```

_Note:_ More documentation is on the way, but for now we recommend looking at a couple different places for relevant style information:

- [CSS Variables](https://github.com/britannica/consumer-ui/blob/master/src/scss/_variables.scss)
- [Utility Classes](https://github.com/britannica/consumer-ui/blob/master/src/scss/_utilities.scss)

### Import a component

```js
import { Button } from '@britannica/ui';

const MyComponent = () => <Button label="Enable Bat-Signal">Enable Bat-Signal</Button>;
```

_Note:_ More documentation is on the way, but for now we recommend looking at the `propTypes` within each of [the components](https://github.com/britannica/consumer-ui/tree/master/src/components) to see which components exist as well as which props they accept.

testing

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