Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dequelabs/cauldron
https://github.com/dequelabs/cauldron
a11y accessibility component-library components css design-system javascript react react-a11y react-accessibility reactjs typescript ui-components
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dequelabs/cauldron
- Owner: dequelabs
- License: mpl-2.0
- Created: 2020-04-23T18:09:06.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T13:33:43.000Z (2 months ago)
- Last Synced: 2024-10-29T16:07:45.382Z (2 months ago)
- Topics: a11y, accessibility, component-library, components, css, design-system, javascript, react, react-a11y, react-accessibility, reactjs, typescript, ui-components
- Language: TypeScript
- Homepage: https://cauldron.dequelabs.com/
- Size: 12.1 MB
- Stars: 91
- Watchers: 11
- Forks: 21
- Open Issues: 152
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# cauldron
> The deque pattern library
This monorepo contains the following packages:
- cauldron-styles ([`packages/styles`](packages/styles/README.md))
- cauldron-react ([`packages/react`](packages/react/README.md))
It also contains the documentation/demo app (see `docs/`)
## purpose
Friends don’t let friends ship inaccessible code! These accessible packages include everything from typography and colors to components like custom form controls. The design and interactions shown throughout this site are intended to show how Deque provides accessible experiences for the users of our products - through the use of common, accessible components like these.
## usage
[Cauldron React](packages/react/README.md) is an accessible React components library. [Cauldron Styles](packages/styles/README.md) contains accessible styling for those components and more.
## contributing
See [`CONTRIBUTING.md`](./CONTRIBUTING.md)
## development
### install dependencies
```sh
$ yarn
```
### build (if first time building dev environment, must be run before yarn dev)
```sh
$ yarn build
```
### dev
(watches/rebuilds react, styles, and docs)
```sh
$ yarn dev
```
navigate the browser to http://localhost:8003/
### run tests
(runs all tests)
```sh
$ yarn test
```