Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
@carbon/feature-flags
Advanced tools
Readme
Build with feature flags in Carbon
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
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
}
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,
)
);
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! 👀
Licensed under the Apache 2.0 License.
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.
FAQs
Build with feature flags in Carbon
The npm package @carbon/feature-flags receives a total of 73,185 weekly downloads. As such, @carbon/feature-flags popularity was classified as popular.
We found that @carbon/feature-flags demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 14 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.