Deque.AxeCore.Commons 4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Deque.AxeCore.Commons.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Deque.AxeCore.Commons --version 4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d
NuGet\Install-Package Deque.AxeCore.Commons -Version 4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Deque.AxeCore.Commons" Version="4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Deque.AxeCore.Commons --version 4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d
#r "nuget: Deque.AxeCore.Commons, 4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Deque.AxeCore.Commons as a Cake Addin
#addin nuget:?package=Deque.AxeCore.Commons&version=4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d&prerelease

// Install Deque.AxeCore.Commons as a Cake Tool
#tool nuget:?package=Deque.AxeCore.Commons&version=4.4.0-alpha.c9651f2c2284967c64d2f28e460b5181d0af5c6d&prerelease

Deque.AxeCore.Commons

Provides a .NET wrapper around axe-core, including a bundled copy of axe-core and .NET typings for its options and results.

Getting Started

Note: this package is still under development; these instructions won't work until we perform an initial NuGet release

Install a .NET SDK if you haven't already.

Install Deque.AxeCore.Commons and its dependencies:

dotnet add package Deque.AxeCore.Commons

Usage

This package exists primarily to help .NET tool developers integrate axe-core with different tools and test frameworks. If you are just trying to write test cases using axe-core, you probably want to use one of these instead:

AxeResult

AxeResult represents the axe-core Results Object.

AxeRunContext

AxeRunContext represents the axe-core Context Parameter.

AxeRunOptions

AxeRunOptions represents the axe-core Options Parameter.

Axe script providers

The IAxeScriptProvider interface is suitable for use as an option in an API for running an axe-core scan of a page. It specifies a single method, GetScript(), which returns a string containing JavaScript code suitable for injecting into a running page.

This library provides two IAxeScriptProvider implementations:

1. BundledAxeScriptProvider

BundledAxeScriptProvider provides a bundled copy of axe-core which is included with the library. The included version will match the major and minor version of the library, but may not match the patch version.

This script provider is suitable as a default option for users that don't wish to explicitly override the version of axe-core to use.

IAxeScriptProvider axeScriptProvider = new BundledAxeScriptProvider();
axeScriptProvider.GetScript(); // a string containing the contents of the bundled copy of axe.min.js

2. FileAxeScriptProvider

FileAxeScriptProvider is an alternate option for users that wish to provide their own separate implementation of axe-core, usually for the purposes of pinning to a specific axe-core version independently of this library's version.

new FileAxeScriptProvider("./path/to/axe.min.js");
axeScriptProvider.GetScript(); // synchronously reads the contents of file ./path/to/axe.min.js

License

This package, including its embedded copy of axe-core, is distributed under the terms of the Mozilla Public License, version 2.0.

Acknowledgements

This package builds on past work from the SeleniumAxeDotnet and PlaywrightAxeDotnet projects (see NOTICE.txt). We thank all of those projects' contributors for their work.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Deque.AxeCore.Commons:

Package Downloads
Deque.AxeCore.Selenium The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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

Deque.AxeCore.Playwright The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Automated accessibility testing via axe for tests written with Microsoft Playwright .NET

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.9.0-alpha.75 41 3/26/2024
4.8.2 65,638 2/14/2024
4.8.2-alpha.74 41 3/26/2024
4.8.2-alpha.73 50 2/14/2024
4.8.2-alpha.72 43 2/14/2024
4.8.2-alpha.71 42 2/14/2024
4.8.2-alpha.70 49 2/8/2024
4.8.1 2,434 1/11/2024
4.8.1-alpha.69 45 2/8/2024
4.8.1-alpha.68 42 2/8/2024
4.8.1-alpha.65 52 1/9/2024
4.8.0 251,326 10/2/2023
4.8.0-alpha.67 41 2/7/2024
4.8.0-alpha.64 54 1/9/2024
4.8.0-alpha.63 60 1/9/2024
4.8.0-alpha.62 57 1/9/2024
4.7.2 7,788 8/30/2023
4.7.2-alpha.61 59 12/21/2023
4.7.2-alpha.59 60 11/21/2023
4.7.2-alpha.58 59 11/2/2023
4.7.2-alpha.57 58 11/1/2023
4.7.2-alpha.56 50 10/30/2023
4.7.2-alpha.55 53 10/19/2023
4.7.2-alpha.54 61 10/16/2023
4.7.2-alpha.53 60 10/16/2023
4.7.2-alpha.52 62 10/5/2023
4.7.2-alpha.51 62 10/3/2023
4.7.2-alpha.50 53 10/3/2023
4.7.2-alpha.49 57 9/27/2023
4.7.1-alpha.48 57 9/27/2023
4.7.1-alpha.47 60 9/27/2023
4.7.1-alpha.46 73 9/14/2023
4.7.1-alpha.45 64 9/13/2023
4.7.1-alpha.44 65 9/8/2023
4.7.1-alpha.43 71 8/30/2023
4.7.1-alpha.42 71 8/30/2023
4.4.0-alpha.c9651f2c2284967... 35,572 11/10/2022
4.4.0-alpha.41 70 8/30/2023
4.4.0-alpha.40 73 8/30/2023