SWAMPy

✎ CARVE FLESH

EDITING: README.md

# `axe-core-selenium`

The `axe-core-selenium` gem provides a chainable [axe API][] for [Selenium WebDriver][] and automatically injects into all frames.

## Usage

- In your Gemfile, add the `axe-core-selenium` gem.

```Gemfile
source "https://rubygems.org"

gem 'axe-core-selenium'
```

- Require `axe-selenium` and use the exported member `AxeSelenium`.

```rb
require 'axe-selenium'

# configure `AxeSelenium`

driver = AxeSelenium.configure(:firefox) do |c|
  # see below for a full list of configuration 
  c.jslib_path = "next-version/axe.js"
end

# use the driver configuration instance
driver.page.navigate.to 'https://www.deque.com/'
```

### API

#### `AxeSelenium.configure`

The configure method takes 1 optional argument as a [symbol][] and a configuration block object: `configure(*arg, &block)`

The optional argument is a browser name for `selenium-webdriver`. The valid browser names are:
- `:firefox` (default)
- `:chrome` 
- `:safari`

> Note: Please ensure respective drivers (eg: [`geckodriver`][]) are installed in your machine.

The block configuration object contains the below properties:

| Property | Type | Description |
|---|---|---|
| `jslib_path` (Optional) | `String` | Path to a custom `axe` source |
| `skip_iframes` (Optional) | `Boolean` | Indicate if frames should be excluded from injecting with `axe` |

## Development

> Note: Refer to [contributing guidelines](../../../CONTRIBUTING.md) for a full list of setup requirements.

Navigate to the directory of this gem - `src/packages/axe-core-selenium`

Install dependencies (declared in `axe-core-selenium.gemspec`):
```sh
bundle install
```

To run tests:
```
bundle exec rspec
```

[axe API]: https://github.com/dequelabs/axe-core/blob/develop/doc/API.md
[Selenium Webdriver]: https://rubygems.org/gems/selenium-webdriver
[`geckodriver`]: https://github.com/mozilla/geckodriver/releases
[symbol]: https://ruby-doc.org/core-2.5.0/Symbol.html

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 lib/	DIR	—	2023-09-24 03:48
📄 LICENSE	?	15.5 KB	2023-09-24 03:48	EDIT
📄 README.md	MD	1.9 KB	2023-09-24 03:48	EDIT