Class: AccessibilityConcern

AccessibilityConcern(path, engineTestId, attribute, bestPracticeId, element, fixType, needsReview, rawEngineJsonObject, bestPracticeDescription, severity, noticeability, tractability, bestPracticeDetailsUrl, bestPracticeStandards) → {AccessibilityConcern}

This class represents an accessibility concern identified by Access Engine. At minimum, it contains both information about the concern that was identified and well as where on the page the problem is located. It may also include best practice data from AMP, e.g. how severe or noticeable the issue might be, along with an AMP URL that can be visited for more info.

Constructor

new AccessibilityConcern(path, engineTestId, attribute, bestPracticeId, element, fixType, needsReview, rawEngineJsonObject, bestPracticeDescription, severity, noticeability, tractability, bestPracticeDetailsUrl, bestPracticeStandards) → {AccessibilityConcern}

Parameters:
Name Type Description
path string a CSS selector to the element with this accessibility concern
engineTestId number the automatic Access Engine test ID that failed and produced this accessibility concern
attribute string a brief human-readable description of this accessibility concern
bestPracticeId number the best practice ID that corresponds to this accessibility concern
element string the source code of the HTML node corresponding to this accessibility concern
fixType FixType the remediation steps suggested by Access Engine for resolving this accessibility concern
needsReview boolean whether or not this accessibility concern requires manual review
rawEngineJsonObject object the raw JSON object from Access Engine that was originally used to build this accessibility concern
bestPracticeDescription string the name of the best practice that corresponds to this accessibility concern
severity number the severity of the best practice that corresponds to this accessibility concern
noticeability number the noticeability of the best practice that corresponds to this accessibility concern
tractability number the tractability of the best practice that corresponds to this accessibility concern
bestPracticeDetailsUrl string the URL of the best practice page in AMP that corresponds to this accessibility concern
bestPracticeStandards Array.<Standard> the array of accessibility standards associated with the best practice that corresponds to this accessibility concern
Source:
Returns:
Type
AccessibilityConcern

Members

attribute

A brief human-readable description of this accessibility concern. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

bestPracticeDescription

The name of the best practice that corresponds to this accessibility concern. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

bestPracticeDetailsUrl

The URL of the best practice page in AMP that corresponds to this accessibility concern. An AMP license is not required to visit this URL, but if you're logged into AMP, you'll be presented with additional information beyond what's publicly available.
Source:

bestPracticeId

The best practice ID that corresponds to this accessibility concern. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

bestPracticeStandards

An array of accessibility standards associated with the best practice that corresponds to this accessibility concern, ordered alphabetically by name. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

element

The source code of the HTML node corresponding to this accessibility concern.
Source:

engineTestId

The automatic Access Engine test ID that failed and produced this accessibility concern. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

fixType

The remediation steps suggested by Access Engine for resolving this accessibility concern.
Source:

needsReview

Gets whether or not this accessibility concern requires manual review, i.e. whether the user should manually use AMP to determine whether or not this accessibility concern is actually a legitimate violation given the context of the offending element (AccessibilityConcern#element). If this returns true, visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information on how to manually validate the applicability of this accessibility concern relative to the offending element (AccessibilityConcern#element); it may be that this accessibility concern is not applicable given this context. Accessibility concerns that require manual review will only ever be returned (and thus this function will only ever possibly return false for a given accessibility concern) if Continuum#includePotentialAccessibilityConcerns returns true.
Source:

noticeability

The noticeability of this accessibility concern on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

path

A CSS (for web) or XPath (for mobile) selector to the element with this accessibility concern.
Source:

rawEngineJsonObject

The raw JSON object from Access Engine that was originally used to build this accessibility concern.
Source:

severity

The severity of this accessibility concern on a scale of 1 to 10, where 1 is the least severe and 10 is the most severe. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source:

tractability

The tractability of this accessibility concern on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable. Visit the URL returned by AccessibilityConcern#bestPracticeDetailsUrl for more information.
Source: