Main Configuration

/**
 * Main addon configuration function that returns preview configuration
 * @returns Preview configuration object for Storybook
 */
declare const addon: () => any;
export default addon;

// In .storybook/main.js
export default {
  addons: ['@storybook/addon-a11y']
};

// Or when importing programmatically
import a11yAddon from '@storybook/addon-a11y';
const config = a11yAddon();

/**
 * The parameter key for accessibility configuration
 * Used in story parameters and global parameters
 */
export const PARAM_KEY: "a11y";

// Using the parameter key in story configuration
export const MyStory = {
  parameters: {
    [PARAM_KEY]: {
      disable: false,
      config: {
        rules: [{ id: 'color-contrast', enabled: true }]
      }
    }
  }
};

// Import and use the constant
import { PARAM_KEY } from '@storybook/addon-a11y';
console.log(PARAM_KEY); // "a11y"

/**
 * Configuration setup interface for accessibility testing
 * Defines element, config, and options properties
 */
export interface Setup {
  element?: ElementContext;
  config: Spec;
  options: RunOptions;
}

import type { Setup } from '@storybook/addon-a11y';

const testSetup: Setup = {
  element: '#main-content',
  config: {
    rules: [{ id: 'color-contrast', enabled: true }]
  },
  options: {
    runOnly: ['wcag2a']
  }
};

/**
 * Type definition for accessibility parameters
 * Exported from main entry point for convenience
 */
export interface A11yParameters {
  /**
   * Accessibility configuration
   */
  a11y?: {
    /** Manual configuration for specific elements */
    element?: ElementContext;
    /** Configuration for the accessibility rules */
    config?: Spec;
    /** Options for the accessibility checks */
    options?: RunOptions;
    /** Remove the addon panel and disable the addon's behavior */
    disable?: boolean;
  };
};

import type { A11yParameters } from '@storybook/addon-a11y';

// Type-safe parameter configuration
const storyParameters: A11yParameters = {
  a11y: {
    config: {
      rules: [
        { id: 'color-contrast', enabled: true },
        { id: 'keyboard-navigation', enabled: true }
      ]
    },
    options: {
      runOnly: ['wcag2a', 'wcag2aa']
    }
  }
};

type ElementContext = string | Element | NodeList | Element[];

interface Spec {
  rules?: Array<{
    id: string;
    enabled?: boolean;
    options?: any;
  }>;
  tags?: string[];
  locale?: string;
}

interface RunOptions {
  runOnly?: string[] | { type: string; values: string[] };
  rules?: { [key: string]: { enabled: boolean } };
  reporter?: string;
  resultTypes?: string[];
  selectors?: boolean;
  ancestry?: boolean;
  xpath?: boolean;
  absolutePaths?: boolean;
}