Add-on repositories, or repos, are components built for a specific product or experience. The repos are built on top of the core Carbon repo, and enable teams to create their own custom components that follow Carbon’s visual style and guidelines.
Please answer yes or no to the following list of questions:
- Is your team using Carbon components?
- Does your team have the need to add custom components in addition to Carbon’s core components?
- Will these components only be needed by your team?
- Do you need these custom components to match Carbon’s visual style?
then you definitely qualify for an add-on repo! Jump to the next section to learn about the required steps to create an add-on repo.
but still feel like you need an add-on repo, please reach out to the a member of the Carbon team to discuss additional options. It might be that your component need is something that can be shared across the core Carbon organization. In this case, we can talk about how you can contribute this component back to the core Carbon repo.
Carbon Design System is an open-source project and we do encourage teams using Carbon Design System to stay open-source as well. However, if your product has privacy constraints, we can discuss options for creating an add-on repo under our GitHub Enterprise account.
|Carbon custom focus states||✅|
|Visual + UX||Carbon themed||✅|
|Universal pattern |
(fits for 2-3 use cases)
|Interaction states (hover, active, focus, disabled)||✅||✅|
Once an add-on repo has been created, the team or product that requested it is in charge of maintaining and keeping it up to date. This involves carrying over specific changes from the core Carbon repo, as well as making sure it is using the latest major version of Carbon Components.
The table below shows the Carbon team’s level of support for the Core library vs. the Add-ons repo.
|Support category||Core library||Add-ons|
|General design questions||✅||✅|
|Design feedback & support||✅|