Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TroyWalshProf/SeleniumAxeDotnet

Tools for using aXe for web accessibility testing with C# and Selenium.
https://github.com/TroyWalshProf/SeleniumAxeDotnet

accessibility-testing dotnet-framework dotnet-standard selenium

Last synced: 23 days ago
JSON representation

Tools for using aXe for web accessibility testing with C# and Selenium.

Host: GitHub
URL: https://github.com/TroyWalshProf/SeleniumAxeDotnet
Owner: TroyWalshProf
License: mit
Created: 2019-03-12T14:22:34.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-10-24T17:43:24.000Z (3 months ago)
Last Synced: 2025-01-09T12:17:43.575Z (27 days ago)
Topics: accessibility-testing, dotnet-framework, dotnet-standard, selenium
Language: C#
Size: 867 KB
Stars: 32
Watchers: 8
Forks: 21
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # :warning: Deprecation Notice :warning:

The switch from Selenium.Axe to Deque.AxeCore is, by design, really straight forward. This is because Deque.AxeCore is a fork of Selenium.Axe so the interfaces to both are very similar.  

## Update steps

1. Add Deque and Html packages 

  - Deque.AxeCore.Commons

  - Deque.AxeCore.Selenium  

  - TWP.Selenium.Axe.Html  

  _*Only if you are using the current HTML report functionality_

2. Remove Selenium.Axe package

3. Update usings

  - Remove

    - ```using Selenium.Axe;```

  - Add

    - ```using Deque.AxeCore.Commons;```

    - ```using Deque.AxeCore.Selenium;```

    - ```using TWP.Selenium.Axe.Html;```   

    _*Only when creating HTML reports_

## Context

### Why is this project being deprecated?

-	Deque is officially taking on the .Net bindings  

	-	https://github.com/dequelabs/axe-core-nuget  

	-	https://www.nuget.org/packages/Deque.AxeCore.Selenium/  

### Is this a good thing?

- Yes

  - Selenium.Axe actually uses Deque’s Axe core under the hood

  - This should help keep the .Net bindings at feature parity with the other official supported binding, such as Java and JavaScript

### Anything special we should know?

- The new Deque project will support both Selenium and Playwright 

- A [standalone HTML reporter](https://github.com/TroyWalshProf/SeleniumAxeHtmlDotnet) library has been created and will be maintained until the [Microsoft HTML reporter](https://github.com/microsoft/html-reporter-for-axe-core-dotnet) gets released. 

____

____

____

# Selenium.Axe for .NET

[![Selenium.Axe NuGet package](https://img.shields.io/nuget/v/Selenium.Axe)](https://www.nuget.org/packages/Selenium.Axe) 

[![NuGet package download counter](https://img.shields.io/nuget/dt/Selenium.Axe)](https://www.nuget.org/packages/Selenium.Axe/) 

[![Main pipeline](https://github.com/TroyWalshProf/SeleniumAxeDotnet/actions/workflows/mainPipeline.yml/badge.svg?branch=main)](https://github.com/TroyWalshProf/SeleniumAxeDotnet/actions/workflows/mainPipeline.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=alert_status)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=coverage)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=TroyWalshProf_SeleniumAxeDotnet&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=TroyWalshProf_SeleniumAxeDotnet)

Automated web accessibility testing with .NET, C#, and Selenium. Wraps the [axe-core](https://github.com/dequelabs/axe-core) accessibility scanning engine and the [Selenium.WebDriver](https://www.seleniumhq.org/) browser automation framework.

Compatible with .NET Standard 2.0+, .NET Framework 4.7.1+, and .NET Core 2.0+. 

Inspired by [axe-selenium-java](https://github.com/dequelabs/axe-selenium-java) and [axe-webdriverjs](https://github.com/dequelabs/axe-webdriverjs). Forked from [Globant.Selenium.Axe](https://github.com/javnov/axe-selenium-csharp).

## Documentation

* [Getting Started](https://troywalshprof.github.io/SeleniumAxeDotnet/#/?id=getting-started)

* [`AxeBuilder` Reference](https://troywalshprof.github.io/SeleniumAxeDotnet/#/?id=axebuilder-reference)

* [Working with `AxeResult` objects](https://troywalshprof.github.io/SeleniumAxeDotnet/#/?id=working-with-axeresult-objects)

* [Creating a HTML report](https://troywalshprof.github.io/SeleniumAxeDotnet/#/?id=creating-a-html-report)

* [Contributing](https://troywalshprof.github.io/SeleniumAxeDotnet/#/?id=contributing)

Patron

------

This project would not exist in its current form without the generous support of

[![Magenic](docs/magenic-logo.png)](https://magenic.com)