Back to Storybook

Addon A11y Parameter Error In Preview

docs/_snippets/addon-a11y-parameter-error-in-preview.md

10.3.63.7 KB
Original Source
ts
// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { Preview } from '@storybook/your-framework';

const preview: Preview = {
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
};
export default preview;
js
export default {
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
};
ts
// Replace your-framework with the framework you are using (e.g., react-vite, nextjs, nextjs-vite)
import { definePreview } from '@storybook/your-framework';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
<!-- JS snippets still needed while providing both CSF 3 & Next -->
js
// Replace your-framework with the framework you are using (e.g., react-vite, nextjs, nextjs-vite)
import { definePreview } from '@storybook/your-framework';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
ts
import { definePreview } from '@storybook/vue3-vite';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
<!-- JS snippets still needed while providing both CSF 3 & Next -->
js
import { definePreview } from '@storybook/vue3-vite';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
ts
import { definePreview } from '@storybook/angular';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
ts
import { definePreview } from '@storybook/web-components-vite';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});
<!-- JS snippets still needed while providing both CSF 3 & Next -->
js
import { definePreview } from '@storybook/web-components-vite';
import addonA11y from '@storybook/addon-a11y';

export default definePreview({
  addons: [addonA11y()],
  parameters: {
    // ๐Ÿ‘‡ Fail all accessibility tests when violations are found
    a11y: { test: 'error' },
  },
});