Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlaskit/platform-feature-flags

atlassian575.8kApache-2.00.3.0TypeScript support: included

Platform Feature Flags

readme

@atlaskit/platform-feature-flags

Allows usage of feature flags in platform components.

Registration

Feature flags are required to be registered in their respective package before they will be available in the api. This is because the types used in this package are dynamically generated based on flags defined in their "package.json". Definitions can be like so:

{
  'platform-feature-flags': {
    'flag-name': {
      type: 'boolean',
      // required
    },
  },
}

changelog

@atlaskit/platform-feature-flags

0.3.0

Minor Changes

0.2.6

Patch Changes

  • #114530 32d09d1f69b95 - Add fg function to supersede getBooleanFF. This aligns platform usage with Jira usage.

0.2.5

Patch Changes

  • #42550 c9c2b136ecb - Add a type to globalThis and dummy index.js file to fix failing typecheck and eslint check in AFM

0.2.4

Patch Changes

  • #35772 d6a9413f008 - Store the Platform Feaature Flags booleanFeatureFlagResolver on the global so that it won't matter if multiple different versions of the library are installed

0.2.3

Patch Changes

  • #35628 71902efa32d - Added logging for any feature flags that are called before the platform feature flags resolver is created

0.2.2

Patch Changes

0.2.1

Patch Changes

0.2.0

Minor Changes

0.1.2

Patch Changes

  • #31785 49c6941535b - This package is now declared as a singleton within its package.json file. Consumers should provide tooling to assist in deduplication and enforcement of the singleton pattern.

0.1.1

Patch Changes

  • #30973 bcbc0232ef1 - [ux] Update documentation around platform feature flag implementation and integration

0.1.0

Minor Changes

  • #29445 1d3a3683ed9 - Revamp platform feature flag package to allow deferral to outside client instead

0.0.12

Patch Changes

0.0.11

Patch Changes

0.0.10

Patch Changes

0.0.9

Patch Changes

0.0.8

Patch Changes

  • #28158 7888ba61c3b - Add platform feature flag registration and dynamic type generation for platform feature flag client

0.0.7

Patch Changes

0.0.6

Patch Changes

0.0.5

Patch Changes

  • #27830 1f19e1fe8c9 - Fix running unit tests and Storybook when Platform FF are enabled

0.0.4

Patch Changes

  • #27782 d446d03215b - Add storybook enviornment variable for setting all platform feature flags to be true

0.0.3

Patch Changes

  • #27765 f366312e13a - Add support for toggling on all the Platform Feature Flags when running unit tests

0.0.2

Patch Changes

0.0.1

Patch Changes