ContextQMD
Back to Storybook

Addon Backgrounds Options In Meta

docs/_snippets/addon-backgrounds-options-in-meta.md

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

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

const meta: Meta<Button> = {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};

export default meta;
ts
import preview from '../.storybook/preview';

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

const meta = preview.meta({
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
js
export default {
  component: 'demo-button',
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};
ts
import type { Meta } from '@storybook/web-components-vite';

const meta: Meta = {
  component: 'demo-button',
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};

export default meta;
js
import preview from '../.storybook/preview';

const meta = preview.meta({
  component: 'demo-button',
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
ts
import preview from '../.storybook/preview';

const meta = preview.meta({
  component: 'demo-button',
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
js
import { Button } from './Button';

export default {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};
ts
// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.
import type { Meta } from '@storybook/your-framework';

import { Button } from './Button';

const meta = {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
} satisfies Meta<typeof Button>;

export default meta;
js
import Button from './Button.vue';

export default {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};
ts
import type { Meta } from '@storybook/vue3-vite';

import Button from './Button.vue';

const meta = {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
} satisfies Meta<typeof Button>;

export default meta;
ts
import preview from '../.storybook/preview';

import Button from './Button.vue';

const meta = preview.meta({
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
<!-- 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,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
svelte
<script module>
  import { defineMeta } from '@storybook/addon-svelte-csf';

  import Button from './Button.svelte';

  const { Story } = defineMeta({
    component: Button,
    parameters: {
      backgrounds: {
        options: {
          // ๐Ÿ‘‡ Override the default `dark` option
          dark: { name: 'Dark', value: '#000' },
          // ๐Ÿ‘‡ Add a new option
          gray: { name: 'Gray', value: '#CCC' },
        },
      },
    },
  });
</script>
js
import Button from './Button.svelte';

export default {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
};
svelte
<script module>
  import { defineMeta } from '@storybook/addon-svelte-csf';

  import Button from './Button.svelte';

  const { Story } = defineMeta({
    component: Button,
    parameters: {
      backgrounds: {
        options: {
          // ๐Ÿ‘‡ Override the default `dark` option
          dark: { name: 'Dark', value: '#000' },
          // ๐Ÿ‘‡ Add a new option
          gray: { name: 'Gray', value: '#CCC' },
        },
      },
    },
  });
</script>
ts
// Replace your-framework with svelte-vite or sveltekit
import type { Meta } from '@storybook/your-framework';

import Button from './Button.svelte';

const meta = {
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
} satisfies Meta<typeof Button>;

export default meta;
ts
import preview from '../.storybook/preview';

import { Button } from './Button';

const meta = preview.meta({
  component: Button,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});
<!-- 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,
  parameters: {
    backgrounds: {
      options: {
        // ๐Ÿ‘‡ Override the default `dark` option
        dark: { name: 'Dark', value: '#000' },
        // ๐Ÿ‘‡ Add a new option
        gray: { name: 'Gray', value: '#CCC' },
      },
    },
  },
});