Back to Storybook

Addon Backgrounds Define Globals

docs/_snippets/addon-backgrounds-define-globals.md

10.3.68.3 KB
Original Source
ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './button.component';

const meta: Meta<Button> = {
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
};

export default meta;
type Story = StoryObj<Button>;

export const OnDark: Story = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
ts
import preview from '../.storybook/preview';

import { Button } from './button.component';

const meta = preview.meta({
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
svelte
<script module>
  import { defineMeta } from '@storybook/addon-svelte-csf';

  import Button from './Button.svelte';

  const { Story } = defineMeta({
    component: Button,
    globals: {
      // ๐Ÿ‘‡ Set background value for all component stories
      backgrounds: { value: 'gray', grid: false },
    },
  });
</script>

<!-- ๐Ÿ‘‡ Override background value for this story -->
<Story
  name="OnDark"
  globals={{
    backgrounds: { value: "dark" },
  }}
/>
js
import Button from './Button.svelte';

export default {
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
};

export const OnDark = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
svelte
<script module>
  import { defineMeta } from '@storybook/addon-svelte-csf';

  import Button from './Button.svelte';

  const { Story } = defineMeta({
    component: Button,
    globals: {
      // ๐Ÿ‘‡ Set background value for all component stories
      backgrounds: { value: 'gray', grid: false },
    },
  });
</script>

<!-- ๐Ÿ‘‡ Override background value for this story-->
<Story
  name="OnDark"
  globals={{
    backgrounds: { value: "dark" },
  }}
/>
ts
// Replace your-framework with svelte-vite or sveltekit
import type { Meta, StoryObj } from '@storybook/your-framework';

import Button from './Button.svelte';

const meta = {
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
} satisfies Meta<typeof Button>;

export default meta;
type Story = StoryObj<typeof meta>;

export const OnDark: Story = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
js
import { Button } from './Button';

export default {
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
};

export const OnDark = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
ts
// Replace your-framework with the name of your framework (e.g., react-vite, vue3-vite, etc.)
import type { Meta, StoryObj } from '@storybook/your-framework';

import { Button } from './Button';

const meta = {
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
} satisfies Meta<typeof Button>;

export default meta;
type Story = StoryObj<typeof meta>;

export const OnDark: Story = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
js
export default {
  component: 'demo-button',
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
};

export const OnDark = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
ts
import type { Meta, StoryObj } from '@storybook/web-components-vite';

const meta: Meta = {
  component: 'demo-button',
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
};

export default meta;
type Story = StoryObj;

export const OnDark: Story = {
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
};
js
import preview from '../.storybook/preview';

const meta = preview.meta({
  component: 'demo-button',
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
ts
import preview from '../.storybook/preview';

const meta = preview.meta({
  component: 'demo-button',
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
ts
import preview from '../.storybook/preview';

import { Button } from './Button';

const meta = preview.meta({
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
<!-- JS snippets still needed while providing both CSF 3 & Next -->
js
import preview from '../.storybook/preview';

import { Button } from './Button';

const meta = preview.meta({
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
ts
import preview from '../.storybook/preview';

import Button from './Button.vue';

const meta = preview.meta({
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});
<!-- JS snippets still needed while providing both CSF 3 & Next -->
js
import preview from '../.storybook/preview';

import Button from './Button.vue';

const meta = preview.meta({
  component: Button,
  globals: {
    // ๐Ÿ‘‡ Set background value for all component stories
    backgrounds: { value: 'gray', grid: false },
  },
});

export const OnDark = meta.story({
  globals: {
    // ๐Ÿ‘‡ Override background value for this story
    backgrounds: { value: 'dark' },
  },
});