Carbon Components React
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-react-agave carbon-components carbon-icons
# Or, with yarn
yarn add carbon-react-agave carbon-components carbon-icons
-
These components require the use of Webpack in your project. See our
webpack.config.jsfor 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
carbon-components-react/.storybook/polyfills.jsfile is 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.
-
(Optional) Set
truetoCARBON_USE_EXPERIMENTAL_FEATURESenvironment 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 (
/componentsor/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.
To update the Contributors section, follow these instructions
Contributors
Thanks goes to these wonderful people:
