carbon-components-react

carbon-components-react

A collection of Carbon Components built with React.

If you're new to React.js or Carbon, check out our guide to help get you up and running.

Getting started

To install carbon-components-react in your project, you will need to run the following command using npm:

npm install -S carbon-components carbon-components-react carbon-icons

If you prefer Yarn, use the following command instead:

yarn add carbon-components carbon-components-react carbon-icons

If you want to try out carbon-components-react, you can also use CodeSandbox.

Usage

import { Button } from 'carbon-components-react';

function MyComponent() {
  return <Button>Example usage</Button>;
}

For more information about each component, check out our Storybook. For guides on getting started, head on over to our Website or check out our Tutorial

:books: Documentation

• Storybook
• Getting started
• 🏃‍♀️ Migration Guides
  • v6 to v7

📚 Examples

If you're looking for more examples on how to use carbon-components-react, we have some examples that you can check out:

• Create React App
• Next.js
• React Router

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.

IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency you are agreeing to telemetry collection. To opt out, see Opting out of IBM Telemetry data collection. For more information on the data being collected, please see the IBM Telemetry documentation.