Carbon

Carbon is a React component library developed by Sage.

Getting started

Our getting started guide provides instructions on how to install and use the Carbon library.

Examples

See our docs for live examples.

Browser Support

We support and test the Carbon Library against the latest versions of the following browsers:

We provide polyfills for the latest two versions of each of these browsers to give a grace period to update.

Versioning

We follow Semantic Versioning and we use Conventional Commits.

While we make every effort to avoid breaking changes, sometimes they are necessary. We choose to take an overly cautious approach to breaking changes. That is we will mark something as a breaking change, even if it is extremely unlikely to affect any consumers.

We choose to make frequent but small breaking changes to give you the choice of making small incremental updates or by jumping multiple versions in one upgrade. Ultimately the amount of breaking changes is the same, but version number increases more frequently.

We will batch breaking changes into a single version if there is a technical reason why we can't make a small breaking change, or if the impact is extraordinarily low.

We publish release notes that include the necessary upgrade steps. We also publish a codemod when possible, this will update your code to work with the new version.

For more information please see the GitHub releases.

Contributing

Read our contributing guide to learn about our development process, how to suggest bugfixes and raise issues.

Thanks

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.

Licence

Carbon is licensed under the Apache-2.0 licence.

Sage / carbon

readme