### Features

- **acot-preset-wcag:** add `ignore` option to `dialog-focus` rule ([959bcbc](https://github.com/acot-a11y/acot/commit/959bcbc6f698e565f2a5b452970dfa0031d4fb6c))
- **acot-preset-wcag:** add `ignore` option to `img-has-name` rule ([36a152e](https://github.com/acot-a11y/acot/commit/36a152ef468f0ddfce15037eda23b9f2ed6ed51f))
- **acot-preset-wcag:** add `ignore` option to `interactive-has-enough-size` rule ([640a0aa](https://github.com/acot-a11y/acot/commit/640a0aa1530a20d7105d8ddab36d709681f3f776))
- **acot-preset-wcag:** add `ignore` option to `interactive-has-name` rule ([bcf6119](https://github.com/acot-a11y/acot/commit/bcf61195285a49ade70049f7a82643d8c6914ef1))
- **acot-preset-wcag:** add `ignore` option to `interactive-supports-focus` rule ([a563858](https://github.com/acot-a11y/acot/commit/a56385803a010589ac51fe52e37b496dd5e4d527))
- **acot-preset-wcag:** add `ignore` option to `link-has-name` rule ([97e01a5](https://github.com/acot-a11y/acot/commit/97e01a594c7a4b95cd4afdaa304ccd7554924a2b))
- **utils:** add `isElementMatches` utilify function ([53c4c58](https://github.com/acot-a11y/acot/commit/53c4c58db1e06127250ad1b1d4f97e6452dd754a))

[0.0.18](https://github.com/acot-a11y/acot/compare/v0.0.17...v0.0.18) (2022-05-11)

wadackel

@acot/acot-runner-storybook

# @acot/acot-runner-storybook

An acot custom runner for [Storybook](https://github.com/storybookjs/storybook).

The `@acot/acot-runner-storybook` crawls all the Stories in Storybook and sets them up for acot to audit.

## Installation

Install via npm:

```bash
$ npm install --save-dev @acot/acot-runner-storybook
```

## Usage

Add `@acot/storybook` to the `runner` field of the [configuration file](../../docs/configuration.md).

```json
{
  "runner": "@acot/storybook"
}
```

### Custom config for each story

You can pass a custom config to the `parameters.acot` field in Story's metadata, as in the following example:

```typescript
// Component Story Format (CSF) Example:
export default {
  title: 'Button',
  component: Button,
  parameters: {
    acot: {
      rules: {
        '@acot/wcag/button-has-name': 'off',
      },
    },
  },
};
```

## Options

### `include`

**Type:** `string[]`  
**Required:** `false`

The Story name pattern to include in the audit target. See the [micromatch][mm] documentation for pattern strings.

```json
{
  "runner": {
    "uses": "@acot/storybook",
    "with": {
      "include": ["*", "/atoms/**/*"]
    }
  }
}
```

### `exclude`

**Type:** `string[]`  
**Required:** `false`

The Story name pattern to exclude in the audit target. See the [micromatch][mm] documentation for pattern strings.

```json
{
  "runner": {
    "uses": "@acot/storybook",
    "with": {
      "exclude": ["/utils/**/*"]
    }
  }
}
```

### `timeout`

**Type:** `number`  
**Default:** `60000`  
**Required:** `false`

Maximum time in milliseconds to wait for the browser instance to collect stories.

```json
{
  "runner": {
    "uses": "@acot/storybook",
    "with": {
      "timeout": 120000
    }
  }
}
```

## Storybook compatibility

### Storybook versions

- [x] Storybook v5
- [x] Storybook v6

### UI frameworks

Since `@acot/acot-runner-storybook` doesn't rely on UI frameworks like React, Angular, or Vue.js, it can be used in conjunction with any UI framework of your choice!

[mm]: https://github.com/micromatch/micromatch


@acot/acot-runner-storybook

0.0.18 (2022-05-11)

Features

@acot/acot-runner-storybook

Installation

Usage

Custom config for each story

Options

`include`

`exclude`

`timeout`

Storybook compatibility

Storybook versions

UI frameworks

Keywords