@storybook/addon-a11y
Version:
Storybook Addon A11y: Test UI component compliance with WCAG web accessibility standards
40 lines (39 loc) • 1.44 kB
TypeScript
import { RunOptions, Selector, SelectorList, Spec } from "axe-core";
//#region code/addons/a11y/.dts-emit/code/addons/a11y/src/params.d.ts
type SelectorWithoutNode = Omit<Selector, 'Node'> | Omit<SelectorList, 'NodeList'>;
type ContextObjectWithoutNode = {
include: SelectorWithoutNode;
exclude?: SelectorWithoutNode;
} | {
exclude: SelectorWithoutNode;
include?: SelectorWithoutNode;
};
type ContextSpecWithoutNode = SelectorWithoutNode | ContextObjectWithoutNode;
type A11yTest = 'off' | 'todo' | 'error';
interface A11yParameters {
/**
* Context parameter for axe-core's run function, except without support for passing Nodes and
* NodeLists directly.
*
* @see https://github.com/dequelabs/axe-core/blob/develop/doc/context.md
*/
context?: ContextSpecWithoutNode;
/**
* Options for running axe-core.
*
* @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter
*/
options?: RunOptions;
/**
* Configuration object for axe-core.
*
* @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure
*/
config?: Spec;
/** Whether to disable accessibility tests. */
disable?: boolean;
/** Defines how accessibility violations should be handled: 'off', 'todo', or 'error'. */
test?: A11yTest;
}
//#endregion
export { SelectorWithoutNode as i, ContextObjectWithoutNode as n, ContextSpecWithoutNode as r, A11yParameters as t };