# cauldron-react

> Fully accessible react components library for Deque Cauldron

Latest version **5.0.0** (published 2019-09-05) · MPL-2.0 license · 0 weekly downloads

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

## Install

```sh
npm install cauldron-react
pnpm add cauldron-react
yarn add cauldron-react
bun add cauldron-react
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2019-09-05 |
| First published | 2018-03-02 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 214.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Harris Schneiderman |
| Maintainers | dqlabs |

## Links

- npm: https://www.npmjs.com/package/cauldron-react
- Repository: https://github.com/dequelabs/cauldron-react
- Homepage: https://github.com/dequelabs/cauldron-react#readme
- Issues: https://github.com/dequelabs/cauldron-react/issues
- npm.io page: https://npm.io/package/cauldron-react

## Dependencies (7)

- [keyname](https://npm.io/package/keyname.md) ^0.1.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [rc-tooltip](https://npm.io/package/rc-tooltip.md) ^3.7.2
- [unique-string](https://npm.io/package/unique-string.md) ^1.0.0
- [focus-trap-react](https://npm.io/package/focus-trap-react.md) ^3.0.5
- [react-syntax-highlighter](https://npm.io/package/react-syntax-highlighter.md) ^6.1.1

## Recent versions

- 5.0.0 (latest) — 2019-09-05
- 5.0.0-canary.f6d4e3c4 (next) — 2021-03-09
- 5.0.0-canary.f3e8e039 — 2020-09-09
- 5.0.0-canary.fb67bb86 — 2020-09-08
- 5.0.0-canary.441e5e63 — 2020-07-17
- 5.0.0-canary.01956ec3 — 2020-07-14
- 5.0.0-canary.2d7fb166 — 2020-04-20
- 5.0.0-canary.539e7579 — 2020-04-20
- 5.0.0-canary.cc9ec84e — 2020-04-17
- 5.0.0-canary.4f411d67 — 2020-04-07
- 5.0.0-canary.e7fdc112 — 2020-04-07
- 5.0.0-canary.497a1bb7 — 2020-04-06
- 5.0.0-canary.29d9722f — 2020-03-11
- 5.0.0-canary.c95dd0e0 — 2020-02-28
- 5.0.0-canary.6933ea60 — 2020-02-14
- … 117 more at https://npm.io/package/cauldron-react/versions

## README

# Cauldron React

[![CircleCI](https://circleci.com/gh/dequelabs/cauldron-react.svg?style=svg)](https://circleci.com/gh/dequelabs/cauldron-react)

## Installation

```sh
$ npm install cauldron-react --save
```

**NOTE:** it is expected that you include the css from [deque-pattern-library](https://github.com/dequelabs/pattern-library)

## Demo App

To document through example and make development / manual testing easy, there is a demo app which can be started by executing:

```sh
$ yarn dev
```

_see the `demo/` directory_

## Build

```sh
$ yarn build
```

NOTE: for production build run `$ yarn prepack`

## Test

```sh
$ yarn test
```

or to have tests automagically re-run when files change

```sh
$ yarn test --watch
```

## Publishing

Publishing `cauldron-react` to the npm registry is handled by CircleCI. All (green) commits that land in the `develop` branch will be released as a "canary" version (eg `1.2.3-canary.GIT_SHA`) and will be available with the `@next` dist tag. Additionally, all (green) `master` commits will be published as stable versions (eg `1.2.3`) and available with the `@latest` dist tag.

To install the latest canary version, do: `npm install cauldron-react@next`. To install the latest stable version, do `npm install cauldron-react`.

To publish a stable version, you'll do something like this:

```
# Ensure you have the latest code
$ git checkout develop
$ git pull
# Create a release branch
$ git create-branch release-<YYYY-MM-DD>
# Run the release script
$ npm run release
# push it
$ git push --follow-tags origin release-<YYYY-MM-DD>
```

Then open a release PR into the `master` branch.

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