@mskcc/carbon-react
v2.7.3
Published
Carbon react components for the MSKCC DSM
Downloads
1,955
Readme
@mskcc/carbon-react
React components for the MSKCC Design System
Getting started
To install @mskcc/carbon-react
in your project, you will need to run the
following command using npm:
npm install -S @mskcc/carbon-react
If you prefer Yarn, use the following command instead:
yarn add @mskcc/carbon-react
This package requires Dart Sass in order to compile styles.
If you're new to Sass, we recommend checking out the following resources and links:
For info on how to configure Sass for your project, here are some common framework's documentation worth reviewing:
Or if you're just using a bundler:
Or anything else not listed above:
Once you get Sass up and running in your project, you may need to configure Sass
to include node_modules
in its includePaths
option. For more information,
checkout the configuration section in
our Sass docs.
Usage
The @mskcc/carbon-react
package provides components and icons for the Carbon
Design System.
To use a component, you can import it directly from the package:
import { Button } from '@mskcc/carbon-react';
function MyComponent() {
return <Button>Example usage</Button>;
}
📖 API Documentation
If you're looking for @mskcc/carbon-react
API documentation, check out:
🙌 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! 👀