Cauldron is Deque's design system / pattern library for building accessible ui as part of our products as Deque. Cauldron consists of several parts, react, styles, and documentation.
As Cauldron is first and foremost a design system for building products at Deque, this means we won't necessarily have 1:1 parity with other design systems. Patterns that don't exist in Deque product UI won't be added as a component within the design system.
This is a public repo, so care needs to be taken to not include details or screenshots for unannounced or unreleased features in Deque products. Any issues or pull requests need to describe work without including specific business logic or feature details directly related to Deque products. If context is necessary to implement a specific Cauldron feature, please open an issue in the private cauldron-team repo and link to it via the issue or pull request.
Local development setup is documented in this project's readme
General component guidelines and style guidelines live within our documentation.
- Use well-structured semantic markup over
aria-*attributes - Don't specify units for zero values, e.g.
padding: 0px;, instead you can omit the unit, e.g.padding: 0; - Avoid using CSS prefixes (e.g.
-webkitor-moz) unless absolutely necessary. autoprefixer should automatically handle prefixes.
- React
- Typescript
- Webpack
- Jest
- axe-core
- React Testing Library
- enzymejs
- MDXJS
- ESLint
- Prettier
- Puppeteer
├─ packages/react/src/components
│ └─ Combobox/
│ ├─ index.ts # exports the component and subcomponents
│ ├─ Combobox.tsx # main component file
│ ├─ ComboboxItem.tsx # subcomponent file
│ └─ Combobox.test.tsx # unit/behavior tests
└─ packages/react/styles
├─ index.css # global styles export
└─ combobox.css # component styles
Cauldron does not have a dedicated quality assurance (QA) individual. Having a full-time dedicated QA individual is a luxury most design systems do not have, ours included. In order to deliver components with high quality it is expected that everyone participating as a part of a component's development lifecycle wear different hats to help ensure we meet that high level of quality. Both an individual developing a component and a reviewer reviewing a component are accountable for considering the following checklist:
- Does the component follow general component guidelines?
- Does the component follow general style guidelines?
- Does the component cover all of the necessary variations within scope? (i.e. default, primary, secondary)
- Does the component cover all of the necessary interactive states? (i.e. active, focus, expanded, disabled)
- Does the component account for different layouts within different viewports? (i.e. responsiveness, media queries, overflow)
- Does the component API match the current design patterns of components? (i.e. props, events, callbacks)
- Does the component only implement features that fall within our browser support or implement these features via progressive enhancement?
- Does the component support both light and dark themes?
- Does the component have appropriate documentation?
- Does the component support customizing text labels or content for translations?
- Does the component need usability testing?
Every Cauldron component needs to be compatible with server-side rendering (SSR). A component should be able to render in an SSR environment such as Gatsby.js or Next.js while avoiding DOM globals like document or window that are not available in these environments.
Cauldron uses eslint-plugin-ssr-friendly to help prevent the accidental misuse of DOM globals. An additional utility is available to help guard against using DOM globals:
import { isBrowser } from '../../utils/is-browser';
export default function SomeComponent() {
if (!isBrowser()) {
return null;
}
// do browser/DOM things
}The files in this project are formatted by Prettier and linted with ESLint. Both are run when code is committed (as a pre-commit hook).
| Command | Description |
|---|---|
yarn lint |
Runs eslint against everything |
yarn lint --fix |
Automatically fixes some linting errors |
Icons are located in packages/react/src/components/Icon/icons. To add a new icon, follow the following steps:
- Change any
fill,stroke, or any color related attributes in the SVG to usecurrentColor. - Remove any namespace attributes (such as
xmlns:*) from the SVG. - Save your icon in the above location with the proposed name of your icon, e.g.
[your-name].svg. Theyour-nameportion will be how the icon is used in the React Component, e.g.<Icon type="your-name" />.
Cauldron follows the conventional commit specification and is enforced via semantic-pr-title. When submitting a pull request, please ensure your initial commit message or pull request title follows the spec.
Cauldron aims to avoid shipping breaking changes on a regular basis, instead opting to use fix or feat for a majority of changes mapping to patch and minor semver bumps respectively. The following changes below map to their corresponding semver bumps:
| Category | Type of Change | Semver |
|---|---|---|
| Components | A component is added | minor |
| A component is deprecated | minor |
|
| A component is removed | major (breaking) |
|
| A change is made that does not affect the public API of the component | patch |
|
| Component Props | An optional prop is added | minor |
| A required prop is added | major (breaking) |
|
| A prop's type is expanded | minor |
|
| A prop's type is narrowed | major (breaking) |
|
| A prop is deprecated | minor |
|
| A prop is removed | major (breaking) |
|
| Component Styles/CSS | Adding a new css selector | minor |
| Removing a css selector | major (breaking) |
|
| Adding a css variable | minor |
|
| Removing a css variable | major (breaking) |
|
| Modifying css properties | patch or minor |
We aim to review pull requests within a day or two. If your changes are time-sensitive, feel free to request an expedited review on GitHub or reach out in the private #cauldron slack channel.
Once approved by a member of the Cauldron team, your pull request can be merged at any time but must be squash merged.
Cauldron documentation is deployed automatically via amplify web previews for pull requests with each commit to a PR. To view the preview of your changes, navigate to your PR and find the comment from the aws-amplify bot, which will include a link to the preview site for that PR. The preview site will only persist for as long as the PR remains opened and will be deleted when closed.
The testing methodology should account for both testing the interface of a component as input/output testing and how an end-user would interact with the component. Ideally, implementation details are avoided unless necessary. Examples below of things to consider when writing tests for a component:
- Including all variants in tests (i.e. default, primary, secondary)
- Including different interactive states (i.e. focus, expanded, disabled)
- Including testing different behaviors for functionality related to different layouts (i.e. responsiveness, media queries, overflow)
- Component api and events (i.e. callbacks, click / keyboard events)
- Running axe against various variants and states
Cauldron uses Jest as its test runner to run unit tests along with React Testing Library.
Important
We are currently in the process of migrating existing tests away from Enzyme to React Testing Library. New tests should not be written in Enzyme.
We use jest-axe to run axe in our unit tests. It is expected that you run axe in all states of your component.
test('should return no axe violations', async () => {
render(<SomeCauldronComponent ref={ref} />);
const component = screen.getByRole('button');
expect(await axe(component)).toHaveNoViolations();
});| Command | Description |
|---|---|
yarn test |
Runs all unit tests |
yarn test ComponentName |
Runs tests matching component name |
yarn test:a11y |
Runs e2e accessibility tests against documentation |
Component documentation guidelines are outlined in docs/readme.md.
Cauldron is constantly evolving, and it's inevitable that breaking changes will need to be introduced. Before a breaking change is released, other alternatives should be considered and allow for a deprecation period before the breaking change is released.
For cauldron's component library, any of the following would be considered breaking changes:
- Renaming (exported name) or removing a Component
- Changing a prop that would break usage of an existing component
- Adding a new required prop to an existing component
Some examples of implementing non-breaking changes for components:
export { NewName, OldName: NewName }function Component({ oldProp: newProp, newProp }) { ... }For cauldron's styles library, any of the following would be considered breaking changes:
- Changing or removing a class name
- Changing or removing a global css custom property name (see
variables.css) - Changing or removing a component css custom property name
Some examples of implementing non-breaking changes for styles:
/* Usage of .Foo is deprecated, please use .Bar */
.Foo,
.Bar {
...;
}/* Usage of --red is deprecated, please use --better-red */
--red: var(--better-red);
--better-red: red;In addition, changing a css custom property may be a breaking change for the following:
- Changing a global css custom property value (see
variables.css) - Changing a component css custom property value
For the latter, the change must be reviewed by a member of the cauldron team to ensure there are no breaking changes.
Before a breaking change can be released, the breaking change should be documented with the component, property, or style being changed getting flagged as Deprecated. This could mean warning the consumer that a component or property is now deprecated, or including a deprecated comment next to a css class name. This deprecation must exist for at least two months. If a change is additive (e.g. making a new property required), the new property must be optional until the deprecation period has passed.
Once the deprecation period has passed, the breaking change can be implemented by removing the deprecation and including BREAKING CHANGE: in the body of your commit message with the description of the breaking change.