Feature Flags

Feature flags are used to hide experimental features. For Twenty, they are set on workspace level and not on a user level.

Adding a new feature flag

In FeatureFlagKey.ts add the feature flag:

type FeatureFlagKey =
  | 'IS_FEATURENAME_ENABLED'
  | ...;

Also add it to the enum in feature-flag.entity.ts:

enum FeatureFlagKeys {
    IsFeatureNameEnabled = 'IS_FEATURENAME_ENABLED',
    ...
}

To apply a feature flag on a backend feature use:

@Gate({
  featureFlag: 'IS_FEATURENAME_ENABLED',
})

To apply a feature flag on a frontend feature use:

const isFeatureNameEnabled = useIsFeatureEnabled('IS_FEATURENAME_ENABLED');

Change the corresponding record in the Table core.featureFlag:

id	key	workspaceId	value
Random	`IS_FEATURENAME_ENABLED`	WorkspaceID	`true`