A behavior for excluding certain violations from the results.

Modules implementing this behavior can be passed as a :filter option to:

• A11yAudit.Wallaby.assert_no_violations/2
• A11yAudit.Hound.assert_no_violations/1
• A11yAudit.Assertions.assert_no_violations/2

Generally, it's not advisable to permanently exclude violations.

If one of the violations is a false-positive, submit a bug report with axe-core. If one of the violations is caused by a third-party library that you're using, submit a bug report with that library to help spread awareness about web accessibility.

Example

defmodule MyApp.A11yAuditViolationFilter do
  @behaviour A11yAudit.ViolationFilter

  @impl A11yAudit.ViolationFilter
  def exclude_violation?(%A11yAudit.Results.Violation{} = violation) do
    ids_to_ignore = ["aria-deprecated-role", "image-redundant-alt"]
    violation.id in ids_to_ignore
  end
end