The library provides front-end developers & engineers a collection of reusable React components to build websites and user interfaces. Adopting the library enables developers to use consistent markup, styles, and behavior in prototype and production work.
$ npm install --save carbon-components-react carbon-components carbon-icons
$ yarn add carbon-components-react carbon-components carbon-icons
NB: March 29, 2019 - Please use the
@next tag to install Carbon v10 components. e.g.
npm i carbon-components@next.
Components do not import any of the styles themselves, use the SCSS or CSS from
carbon-components to bring in styling. You can also use the
unpkg CDN to bring in the styles wholesale -
unpkg.com/carbon-components/css/carbon-components.css aliases the latest CSS file.
For older browsers (e.g. IE11), polyfills listed in the carbon-components-react/.storybook/polyfills.js file are required.
Please refer to the Contribution Guidelines before starting any work.
We recommend the use of React Storybook for developing components.
$ yarn storybook
Open browser to
Develop components in their respective folders (
Write stories for your components in
View available React Components here. Usage information is available when you click the blue “Show Info” button in the top right corner of the selected component.
If you experience any issues while getting set up with Carbon Components React, please head over to the GitHub repo for more guidelines and support. Please create an issue if your issue does not already exist.