@carbon/feature-flags

@carbon/feature-flags

Build with feature flags in Carbon

Getting started

To install @carbon/feature-flags in your project, you will need to run the following command using npm:

npm install -S @carbon/feature-flags

If you prefer Yarn, use the following command instead:

yarn add @carbon/feature-flags

Usage

The @carbon/feature-flags provides a runtime-based feature flag system that you can use to enable or disable experimental features from Carbon or in your own code.

To check if a feature flag is enabled, you can use the enabled function in JavaScript:

import { enabled } from '@carbon/feature-flags';

enabled('feature-flag-name');

In Sass, you would use the enabled function or mixin:

@use '@carbon/feature-flags';

// Return true if the flag is enabled
@if feature-flags.enabled('feature-flag-name') {
  //
}

@include enabled('feature-flag-name') {
  // only include contents if the flag is enabled
}

Managing feature flags

You can change whether a feature flag is enabled. In JavaScript, you can use the enable, disable, and merge functions to accomplish this.

import { enable, disable, merge } from '@carbon/feature-flags';

// Enable `feature-flag-a`
enable('feature-flag-a');

// Disable `feature-flag-a`
disable('feature-flag-a');

// Set a variety of feature flags to a specific value
merge({
  'feature-flag-a': true,
  'feature-flag-b': false,
  'feature-flag-c': true,
});

In Sass, you can configure whether a feature flag is enabled when you include the module or by using enable, disable, and merge.

@use '@carbon/feature-flags' with (
  $feature-flags: (
    'feature-flag-a': false,
    'feature-flag-b': true,
  ),
);

// Enable `feature-flag-a`
@include feature-flags.enable('feature-flag-a');

// Disable `feature-flag-b`
@include feature-flags.disable('feature-flag-b');

// Set a variety of feature flags to a specific value
@include feature-flags.merge(
  (
    'feature-flag-a': true,
    'feature-flag-b': true,
  )
);

🙌 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.