Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.57 KB

README.md

File metadata and controls

33 lines (19 loc) · 1.57 KB

Cauldron React

Friends don’t let friends ship inaccessible code! Cauldron is designed with accessibility in mind, including styles covering everything from typography to colors, and React components that are designed to be inclusive of all users. Additionally, Cauldron's React components are designed to include full screen reader and keyboard navigation support.

Installation

To start using Cauldron React, install the packages with your package manager of choice:

npm

npm install @deque/cauldron-react @deque/cauldron-styles

yarn

yarn add @deque/cauldron-react @deque/cauldron-styles

Getting Started

To get started, follow our usage guide that includes setup instructions and necessary dependencies. Further documentation is also available at cauldron.dequelabs.com that includes documentation for every available Cauldron component.

Attribution

Some Cauldron icons use Font Awesome Free and Font Awesome Pro. Their licenses can be found here: Font Awesome Free License and Font Awesome Pro License.

Contribute

If you're interested in contributing to Cauldron, you can check out our contribution guide as well as our code of conduct.

Did you find a bug or have a feature request? Open an issue!