Skip to content

Storybook Addon

withFeatureToggles() — a Storybook decorator that installs the plugin with a set of default flags, overridable per story.

ts
function withFeatureToggles(
  defaultFlags?: Record<string, FlagValue>,
  options?: Omit<FeatureTogglesOptions, 'flags' | 'loader'>,
)
ts
// .storybook/preview.ts
import { withFeatureToggles } from 'vue-feature-toggles/storybook'

export const decorators = [
  withFeatureToggles({ betaSearch: false }), // global defaults
]
ts
// MyComponent.stories.ts
export const WithBetaSearch: Story = {
  parameters: {
    featureToggles: {
      betaSearch: true,
      newDashboard: false,
    },
  },
}

Per-story parameters.featureToggles are merged on top of defaultFlags. The second, optional options argument accepts any other plugin option besides flags/loader (e.g. meta, groups, rules) — useful for keeping story-independent configuration (like flag metadata) out of every individual story file.

The vue-feature-toggles/storybook entry point is excluded from the production bundle.