Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(puppeteer): add disableFrames method to docs #186

Merged
merged 3 commits into from
Jan 11, 2021
Merged

docs(puppeteer): add disableFrames method to docs #186

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aff7377
docs(puppeteer): add `disableFrames` method to docs
michael-siek Jan 11, 2021
6311729
Apply suggestions from code review
michael-siek Jan 11, 2021
8df456e
Update README.md
michael-siek Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/puppeteer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,22 @@ new AxePuppeteer(page)
.disableRules('color-contrast');
```

### AxePuppeteer#disableFrame(selector: string)

Skips specific frame with selector provided. Accepts a String of a single selector. **Subsequent calls to `AxePuppeteer#options`, `AxePuppeteer#disableFrame` will override specified options.**

```js
new AxePuppeteer(page).disableFrame('#my-frame');
```

or use it combined with some specified tags:

```js
new AxePuppeteer(page)
.withTags(['wcag2a', 'wcag2aa'])
.disableFrame('#my-frame');
```

### AxePuppeteer#configure(config: Axe.Spec)

Inject an axe configuration object to modify the ruleset before running Analyze. Subsequent calls to this method will invalidate previous ones by calling `axe.configure` and replacing the config object. See [axe-core API documentation](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure) for documentation on the object structure.
Expand Down