Install
Using npm:
$ npm install --save carbon-components-react carbon-components carbon-icons
If you prefer Yarn, use the following command instead:
$ yarn add carbon-components-react carbon-components carbon-icons
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-components
to bring in styling. You can also use theunpkg
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.
If you just want to try out carbon-components-react
, you can also use CodeSandbox.
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 (
/components
or/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 ? icon 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.