Carbon Components React
React component library for building websites and UIs with Carbon
This repository provides a collection of Carbon Components implemented using React.
Usage
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.
Getting Started
npm install -S 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.
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:
$ npm run storybook
-
Open browser to
http://localhost:8080/
. -
Develop components in their respective folders (
/components
or/internal
). -
Write stories for your components in
/.storybook
.
Contributing
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.
Contributors
Thanks goes to these wonderful people: