Carbon react components for the MSKCC DSM
> React components for the MSKCC Design System
To install @mskcc/carbon-react in your project, you will need to run the
following command using npm:
``bash`
npm install -S @mskcc/carbon-react
If you prefer Yarn, use the following command
instead:
`bash`
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:
- Sass Basics
- The Sass @use documentation for Sass modules
- The Carbon Design System FAQ on Sass
For info on how to configure Sass for your project, here are some common
framework's documentation worth reviewing:
- Next.js with Sass
- Remix with Sass
- Gatsby with Sass
Or if you're just using a bundler:
- Parcel with Sass
- Vite with Sass
Or anything else not listed above:
- Webpack with Sass
- Create React App with Sass
- Snowpack with Sass
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.
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:
`jsx
import { Button } from '@mskcc/carbon-react';
function MyComponent() {
return ;
}
`
If you're looking for @mskcc/carbon-react` API documentation, check out:
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! 👀