A community-driven incubation space enabling rapid prototyping, development,
and deployment of Carbon-based components.
Getting started
Carbon Labs is a collection of components, offered in React and Web Component
packages. Individual components are their own package, which helps to remove any
bottlenecks in publishing and deployments. Here are some available components:
To start a new component contribution from a Carbon Labs checkout, use the
create utility:
npx @carbon-labs/create@latest <component-name>
The command runs the repo install/build/generate flow and then runs
yarn scaffold to add Carbon Labs contribution metadata, Storybook tags, and
copyright headers to generated source files. Git operations are opt-in:
When the component is ready for PR review, run the repo prep command:
yarn prep
The prep command formats the repo, dedupes dependencies, validates license
headers, and ensures added source files include the required copyright header.
This package uses IBM Telemetry to collect de-identified and anonymized metrics
data. By installing this package as a dependency you are agreeing to telemetry
collection. To opt out, see
Opting out of IBM Telemetry data collection.
For more information on the data being collected, please see the
IBM Telemetry documentation.
