Develop
Resources
Carbon React library
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.
Install
Using npm:
$ npm install --save carbon-components-react carbon-components carbon-icons
If you prefer Yarn:
$ 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.
Getting started
These components require the use of webpack in your project. See our webpack.config.js for an example configuration.
Components do not import any of the styles themselves, use the SCSS or CSS from
carbon-componentsto bring in styling. You can also use theunpkgCDN to bring in the styles wholesale -unpkg.com/carbon-components/css/carbon-components.cssaliases the latest CSS file.For older browsers (e.g. IE11), polyfills listed in the carbon-components-react/.storybook/polyfills.js file are required.
Development
Please refer to the Contribution Guidelines before starting any work.
Using the server
We recommend the use of React Storybook for developing components.
Start the server:
$ yarn storybook
Open browser to
http://localhost:9000/.Develop components in their respective folders (
/componentsor/internal).Write stories for your components in
/.storybook.
List of available components
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.
Troubleshooting
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.