Carbon for Cloud & Cognitive

Carbon for Cloud & Cognitive

🚀 Getting started

If you're just getting started and looking for React components, take a look at our Storybook.

If you're trying to find something specific, here's a full list of packages that we support!

Package name	Description
@carbon/ibm-cloud-cognitive	Common UI components

If you want to try out Carbon for Cloud & Cognitive, you can use CodeSandbox.

📦 Installing IBM Cloud Cognitive

To use IBM Cloud Cognitive components, all you need to do is install the @carbon/ibm-cloud-cognitive package.

$ yarn add @carbon/ibm-cloud-cognitive

# or

$ npm install @carbon/ibm-cloud-cognitive

Then you can import the component styles in your index.js.

import '@carbon/ibm-cloud-cognitive/css/index.min.css';

Usage

To start using the components

import { AboutModal } from '@carbon/ibm-cloud-cognitive';

const App = () => {
  return <AboutModal />;
};

Enabling canary components

Components that have not yet completed the release review process are considered to be canary and require the consumer to enable via a feature flag in a config.js file.

For example, create a config.js in your src directory:

import { pkg } from '@carbon/ibm-cloud-cognitive';

// Enable 'canary' (not yet reviewed/released) components
// that we want to make use of
pkg.component.AboutModal = true;
pkg.component.SidePanel = true;

// Live dangerously: enable all components!
pkg.setAllComponents(true);

// Enable all pre-release feature flags that we want to use
pkg.flags.noneJustYet = true;

// Live dangerously: enable all pre-release features!
pkg.setAllFeatures(true);

Note: the above settings must happen before a component first renders.

Building and running Locally

To get started run the following commands and storybook will be built and then served on port 3000 on your local machine.

yarn install
yarn storybook

To build all the packages, run the following command.

yarn build

Browser Support

This library supports the latest versions of:

• Apple Safari
• Google Chrome
• Microsoft Edge
• Mozilla Firefox

🙌 Contributing

This project is made possible by several community members who have invested their own time to give back to the Carbon community.

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 and Carbon's Developer Handbook! 👀

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Simon Finney 💻	Lee Chase 💻	Simon Moore 💻	Josh Black 💻	David Menendez 💻	vladbalanescu 💻	Matthew Gallo 💻
Matt Chapman 💻	Dominik Brugger 💻	Polina Olemskaia 💻	Syd Rosa 💻	Dave Clark 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

📝 License

Licensed under the Apache-2.0 License.