Skip to content

Commit

Permalink
chore(storybook): move feature flag overview under welcome (#17685)
Browse files Browse the repository at this point in the history
  • Loading branch information
annawen1 authored Oct 9, 2024
1 parent 7776f11 commit 6b59491
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions packages/react/src/components/FeatureFlags/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Meta } from '@storybook/blocks';

<Meta title="Experimental/Feature Flags" />
<Meta title="Getting Started/Feature Flags" />

# Feature Flags

Expand Down Expand Up @@ -117,11 +117,14 @@ Feature flags can also be enabled via the provided `enable()` mixin

## FeatureFlags Prop Update

The `FeatureFlags` component has been updated to improve compatibility. The `flags` object prop is now deprecated and is replaced with individual boolean props for each feature flag.

The `flags` prop will be removed in a future release. Instead, use individual boolean props for each feature flag.
A `featureflag-deprecate-flags-prop` codemod has been provided to help deprecate the `flags` object prop and switch to individual boolean props.
The `FeatureFlags` component has been updated to improve compatibility. The
`flags` object prop is now deprecated and is replaced with individual boolean
props for each feature flag.

The `flags` prop will be removed in a future release. Instead, use individual
boolean props for each feature flag. A `featureflag-deprecate-flags-prop`
codemod has been provided to help deprecate the `flags` object prop and switch
to individual boolean props.

```bash
npx @carbon/upgrade migrate featureflag-deprecate-flags-prop --write
Expand All @@ -130,9 +133,9 @@ npx @carbon/upgrade migrate featureflag-deprecate-flags-prop --write
```jsx
//Before migration

<FeatureFlags
<FeatureFlags
flags={{
'enable-v12-tile-default-icons': true,
'enable-v12-tile-default-icons': true,
}}>
<App />
</FeatureFlags>
Expand All @@ -143,4 +146,4 @@ npx @carbon/upgrade migrate featureflag-deprecate-flags-prop --write
<FeatureFlags enableV12TileDefaultIcons>
<App />
</FeatureFlags>
```
```

0 comments on commit 6b59491

Please sign in to comment.