Referencia de la API de C#

Clases de Axe DevTools en C#

Esta página documenta las clases que componen Axe DevTools en C#

class Deque.AxeDevtools.Selenium.AxeSelenium

La interfaz para el análisis de accesibilidad. Contiene configuraciones que cambian cómo se ejecuta el análisis, así como la capacidad de ejecutarlo.

AxeSelenium(OpenQA.Selenium.Remote.RemoteWebDriver, ReportConfiguration?, string)

Crea un nuevo objeto AxeSelenium para una página con configuración específica.

Resultados del ReporteAnálisis()

Ejecutar el análisis de accesibilidad en la página.

Retorna: El reporte de la ejecución de axe-core en la página.

var report = new AxeSelenium(driver).Analyze();

AxeSelenium Configurar(Especificación)

Configurar axe. Hecho a través de axe.configure

Retorna: Este objeto para encadenamiento.

var spec = new Spec.Spec {
    Checks = new Spec.Check[] {
        new Spec.Check() {
            Id = "dylang",
            Options = (object) new string[] { "dylan" },
            Evaluate = @"function (node, options) {
              var lang = (node.getAttribute('lang') || '').trim().toLowerCase();
              var xmlLang = (node.getAttribute('xml:lang') || '').trim().toLowerCase();
              var invalid = [];
              (options || []).forEach(function(cc) {
                cc = cc.toLowerCase();
                if (lang && (lang === cc || lang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  lang = null;
                }
                if (xmlLang && (xmlLang === cc || xmlLang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  xmlLang = null;
                }
              });
              if (xmlLang) {
                invalid.push('xml:lang='' + xmlLang + ''');
              }
              if (lang) {
                invalid.push('lang='' + lang + ''');
              }
              if (invalid.length) {
                this.data(invalid);
                return true;
              }
              return false;
            }"
        }
    },
    Rules = new Spec.Rule[] {
        new Spec.Rule() {
            Id = "dylang",
            Selector = "html",
            Tags = new string[] { "wcag2aa" },
            All = new string[0],
            Any = new string[0],
            None = new string[] { "dylang" }
        }
    }
};
var report = new AxeSelenium(driver)
  .Configure(spec)
  .Analyze()

AxeSeleniumDeshabilitarReglas(string[])

Desactivar algunas reglas al ejecutar el análisis.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .DisablingRules("html-has-lang", "label")
  .Analyze()

AxeSeleniumExcluding(string)

Especificar parte de la página para excluir del análisis. Para excluir varias partes no relacionadas de la página, llame a Excluding una vez por cada una.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .Excluding(".cookie-banner")
  .Excluding(".ad-slot")
  .Analyze()

AxeSeleniumExcluding(params string[])

Especificar un elemento dentro de uno o más iframes anidados para excluir. Cada selector, excepto el último, coincide con un nivel de anidamiento de iframe; el último coincide con el elemento a excluir dentro del iframe más interno.

Debido a que el parámetro se declara params, Excluding(".iframe1", ".third-party-ad") y Excluding(new[] { ".iframe1", ".third-party-ad" }) son la misma llamada. De cualquier manera, los selectores forman un solo selector de iframe, no exclusiones separadas. Para excluir varias partes no relacionadas de la página, llame a Excluding(string) una vez por cada una.

Retorna: Este objeto para encadenamiento.

// Exclude .third-party-ad inside the iframe matched by .iframe1
var report = new AxeSelenium(driver)
  .Excluding(".iframe1", ".third-party-ad")
  .Analyze()

AxeSeleniumExcluding(string[][])

Especificar un elemento dentro de uno o más árboles DOM de sombra anidados para excluir. Pase una matriz interna por llamada. Dentro de esa matriz, cada selector, excepto el último, coincide con un anfitrión de sombra, y el último coincide con el elemento a excluir dentro de la raíz de sombra más interna.

Retorna: Este objeto para encadenamiento.

// Exclude #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Excluding(selector)
  .Analyze()

AxeSelenium Excluding(FromFrames)

Especificar un elemento dentro de uno o más iframes anidados para excluir, utilizando un selector FromFrames explícito.

Retorna: Este objeto para encadenamiento.

// Exclude the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Excluding(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Excluding(FromShadowDom)

Especificar un elemento dentro de uno o más árboles DOM de sombra anidados para excluir, utilizando un selector FromShadowDom explícito.

Porque axe-core coincide con los elementos en contra del árbol DOM aplanado, seleccionar un nodo DOM de sombra también selecciona cualquier descendiente insertado a través de un elemento <slot>.

Retorna: Este objeto para encadenamiento.

// Exclude the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Excluding(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumExcluding(params object[])

Especificar un selector que mezcle selectores CSS simples con objetos FromFrames o FromShadowDom, para casos que las otras sobrecargas no puedan expresar.

Esta sobrecarga se selecciona solo cuando la llamada pasa más de un argumento, o un solo argumento que no es uno de los tipos anteriores. Pasar un solo FromFrames o FromShadowDom selecciona Excluding(FromFrames) o Excluding(FromShadowDom) en su lugar.

Para llegar a un iframe que vive dentro de una raíz de sombra, el selector FromShadowDom debe estar anidado dentro del selector FromFrames; el reverso causa un error.

Retorna: Este objeto para encadenamiento.

// Exclude .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Excluding("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSeleniumIncluding(string)

Especificar parte de la página para analizar. Para analizar varias partes no relacionadas de la página, llame a Including una vez por cada una.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .Including(".sidebar")
  .Including(".some-class")
  .Analyze()

AxeSeleniumIncluding(params string[])

Especificar un elemento dentro de uno o más iframes anidados para probar. Cada selector, excepto el último, coincide con un nivel de anidamiento de iframe; el último coincide con el elemento a probar dentro del iframe más interno.

Debido a que el parámetro se declara params, Including(".sidebar-frame", ".some-class") y Including(new[] { ".sidebar-frame", ".some-class" }) son la misma llamada. De cualquier manera, los selectores forman un solo selector de iframe, no inclusiones separadas. Para probar varias partes no relacionadas de la página, llame a Including(string) una vez por cada una.

Retorna: Este objeto para encadenamiento.

// Test .some-class inside the iframe matched by .sidebar-frame
var report = new AxeSelenium(driver)
  .Including(".sidebar-frame", ".some-class")
  .Analyze()

AxeSeleniumIncluding(string[][])

Especificar un elemento dentro de uno o más árboles DOM de sombra anidados para probar. Pase una matriz interna por llamada. Dentro de esa matriz, cada selector, excepto el último, coincide con un anfitrión de sombra, y el último coincide con el elemento a probar dentro de la raíz de sombra más interna.

Retorna: Este objeto para encadenamiento.

// Test #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Including(selector)
  .Analyze()

AxeSelenium Including(FromFrames)

Especificar un elemento dentro de uno o más iframes anidados para probar, utilizando un selector FromFrames explícito.

Retorna: Este objeto para encadenamiento.

// Test the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Including(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Incluyendo(FromShadowDom)

Especifique un elemento dentro de uno o más árboles de shadow DOM anidados para probar, utilizando un selector FromShadowDom explícito.

Como axe-core coincide con los elementos en el árbol DOM aplanado, seleccionar un nodo de shadow DOM también selecciona cualquier descendiente insertado a través de un elemento <slot>.

Retorna: Este objeto para encadenamiento.

// Test the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Including(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumIncluyendo(objeto de parámetros[])

Especifique un selector que mezcle selectores CSS comunes con objetos FromFrames o FromShadowDom, para casos que las otras sobrecargas no pueden expresar.

Esta sobrecarga se selecciona solo cuando la llamada pasa más de un argumento, o un solo argumento que no es uno de los tipos anteriores. Pasar un solo FromFrames o FromShadowDom selecciona Including(FromFrames) o Including(FromShadowDom) en su lugar.

Para llegar a un iframe que vive dentro de una raíz de sombra, el selector FromShadowDom debe estar anidado dentro del selector FromFrames; lo contrario causa un error.

Retorna: Este objeto para encadenamiento.

// Test .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Including("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSelenium RunOptions(RunOptions)

Especifique RunOptions para pasar al llamar a axe.run.

Retorna: Este objeto para encadenamiento.

var options = new RunOptions.RunOptions {
  IFrames = false,
  RunOnly = RunOptions.RunOnly.Tags(RunOptions.TagType.Wcag2a)
};
var report = new AxeSelenium(driver)
  .RunOptions(options)
  .Analyze()

AxeSeleniumWithConfigFile(string)

Establecer dónde encontrar un archivo de configuración. La ruta predeterminada es config/axe-ruleset.json o $AXE_RULESET_PATH.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .WithConfigFile("path/to/file.json")
  .Analyze();

AxeSeleniumWithRules(string[])

Especifique reglas (por id) para usar al ejecutar el análisis.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .WithRules("document-title", "label")
  .WithRules("html-has-lang")
  .Analyze()

AxeSeleniumWithRuleset(string, bool)

Usar un conjunto de reglas específico (es decir, wcag2.1, 508).

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .WithRuleset("508", true)
  .Analyze()

AxeSelenium ConEtiquetas(TagType[])

Especifique reglas (por etiqueta) para usar al ejecutar el análisis.

Retorna: Este objeto para encadenamiento.

var report = new AxeSelenium(driver)
  .WithTags(RunTagType.BestPractice)
  .Analyze()

Variables de entorno

Estas variables de entorno le permiten configurar el servicio de uso y cambiar las propiedades de los eventos reportados.

AxeSeleniumHabilitarSeguimiento(bool)

Opta por enviar o no enviar datos al servicio de uso. El envío está habilitado por defecto.

Retorna: Este objeto para encadenamiento.

AxeSeleniumEstablecerUrlDeSeguimiento(string)

Establece a dónde se envían los datos de métricas de uso. Por defecto https://usage.deque.com

Retorna: Este objeto para encadenamiento.

AxeSeleniumEstablecerIdDistinto(string)

Establece un id distinto usado al enviar métricas de uso.

Retorna: Este objeto para encadenamiento.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Configura información específica del informe como el nombre de la suite de pruebas o la información del agente de usuario

static ReportConfigurationGetDefault()

Obtiene la configuración predeterminada actual. Tenga en cuenta que la configuración predeterminada se puede cambiar.

Retorna: El predeterminado actual.

static void ResetDefault()

Restablece el predeterminado a su estado inicial.

void SetAsDefault()

Establece este objeto como el predeterminado.

ReportConfiguration.GetDefault()
  .TestSuiteName("my-tests")
  .UIState("home-page")
  .SetAsDefault();

ReportConfigurationTestMachine(string)

Establece la máquina en la que se ejecutaron estas pruebas.

Retorna: Este objeto para encadenamiento.

ReportConfigurationTestSuiteName(string)

Establece el nombre del conjunto de pruebas.

Retorna: Este objeto para encadenamiento.

ReportConfigurationUIState(string)

Especifica el estado de la interfaz para este conjunto de pruebas. Se utiliza como ID.

Retorna: Este objeto para encadenamiento.

ReportConfigurationUserAgent(string)

Establece el agente de usuario utilizado durante las pruebas.

Retorna: Este objeto para encadenamiento.

class Deque.AxeDevtools.Selenium.Results.Check

El resultado de ejecutar una verificación.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Un nodo HTML que fue verificado por una regla.

class Deque.AxeDevtools.Results.FromFrames

Un selector que apunta a un elemento dentro de uno o más iframes anidados. Páselo a Including(FromFrames) o Excluding(FromFrames).

FromFrames(objeto de parámetros[])

var report = new AxeSelenium(driver)
  .Including(new FromFrames("iframe#outer", "iframe#inner", "form"))
  .Analyze()

class Deque.AxeDevtools.Results.FromShadowDom

Un selector que apunta a un elemento dentro de uno o más árboles de shadow DOM anidados. Páselo a Including(FromShadowDom) o Excluding(FromShadowDom).

FromShadowDom(parámetros string[])

var report = new AxeSelenium(driver)
  .Including(new FromShadowDom("app-root", ".header", "#search"))
  .Analyze()

class Deque.AxeDevtools.Selenium.Results.Node

Especifica un nodo HTML específico.

class Deque.AxeDevtools.Selenium.Results.Platform

La plataforma en la que se ejecutó una prueba.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Resultados de una prueba que son compatibles con el formato del reportero.

var axe = new AxeSelenium(driver, ReportConfiguration.GetDefault().UIState("UIState"));
var res = axe.Analyze();
File.WriteAllText(reportPath, JsonConvert.SerializeObject(res));

class Deque.AxeDevtools.Selenium.Results.Rule

Resultado para una regla individual.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Información sobre el motor axe-core en el que se ejecutó la prueba.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Información sobre el entorno en el que se realizó la prueba.

class Deque.AxeDevtools.Selenium.Results.TestResults

Resultados devueltos al ejecutar el análisis en la página.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Nombre del ejecutor de pruebas.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Información sobre lo que se está probando.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Especifique qué elemento debe y qué elemento no debe ser probado.

void Excluding(string[])

Agregue un conjunto de selectores para elementos que no deben ser probados.

void Including(string[])

Agregue un conjunto de selectores para elementos que deben ser probados.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Pasos
• Violaciones
• Incompleto
• Inaplicable

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Habilita o deshabilita una regla.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Limitar qué reglas se ejecutan, basándose en nombres o etiquetas.

static EjecutarSóloRules(string[])

Construir un limitador para reglas basándose en IDs.

Retorna: El objeto RunOnly.

estático EjecutarSólo Tags(TagType[])

Construir un limitador para reglas basadas en etiquetas.

Retorna: El objeto RunOnly.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regla
• Reglas
• Etiqueta
• Etiquetas

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Una configuración flexible de cómo opera el análisis.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Sección508
• TTv5
• EN301549
• RGAAv4
• MejoresPrácticas

class Deque.AxeDevtools.Selenium.Spec.Check

Se utiliza para agregar verificaciones a la lista de verificaciones utilizadas por reglas, o para sobreescribir las propiedades de verificaciones existentes.

class Deque.AxeDevtools.Selenium.Spec.Rule

Se utiliza para agregar reglas al conjunto existente de reglas, o para sobreescribir las propiedades de reglas existentes.

class Deque.AxeDevtools.Selenium.Spec.Spec

Configura el formato de los datos de la regla. Esto se puede usar para agregar nuevas reglas, que deben estar registradas con la biblioteca para ejecutarse.