A collection of Carbon Components implemented using React.
View available React Components here. Usage information is available when you click the blue ? icon in the top right corner of the selected component.
Run the following command using npm:
npm install -S 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
-
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
carbon-components-react/.storybook/polyfills.js
file is required.
If you just want to try out carbon-components-react
, you can also use Codesandbox.
Please refer to the Contribution Guidelines before starting any work.
We recommend the use of React Storybook for developing components.
-
(Optional) Set
true
toCARBON_USE_EXPERIMENTAL_FEATURES
environment variable to test some of the experimental features:$ export CARBON_USE_EXPERIMENTAL_FEATURES=true
-
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
.
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.
To update the Contributors
section, follow these instructions
Thanks goes to these wonderful people: