Struct AccessibilityReport

Source

pub struct AccessibilityReport {
    pub issues: Vec<Issue>,
    pub wcag_level: WcagLevel,
    pub elements_checked: usize,
    pub issue_count: usize,
    pub check_duration_ms: u64,
}

Expand description

A comprehensive accessibility check result.

§Examples

use html_generator::accessibility::{
    validate_wcag, AccessibilityConfig,
};

let html = r#"<html lang="en"><body><h1>Hi</h1></body></html>"#;
let report = validate_wcag(html, &AccessibilityConfig::default(), None).unwrap();
assert_eq!(report.issue_count, report.issues.len());

Fields§

§issues: Vec<Issue>

List of accessibility issues found

§wcag_level: WcagLevel

WCAG conformance level checked

§elements_checked: usize

Total number of elements checked

§issue_count: usize

Number of issues found

§check_duration_ms: u64

Time taken for the check (in milliseconds)

Implementations§

Source §

impl AccessibilityReport

Helper functions for WCAG validation

Source

pub fn check_keyboard_navigation( document: &Html, issues: &mut Vec<Issue>, ) -> Result<()>

Check keyboard navigation.

Walks all interactive elements (a, button, input, select, textarea, [tabindex]) and pushes a KeyboardNavigation Issue for negative tabindex values or click handlers without keyboard equivalents.

§Examples

use html_generator::accessibility::{AccessibilityReport, Issue};
use scraper::Html;

let doc = Html::parse_document(
    r#"<html><body><button tabindex="-1">x</button></body></html>"#,
);
let mut issues: Vec<Issue> = Vec::new();
AccessibilityReport::check_keyboard_navigation(&doc, &mut issues).unwrap();
assert!(issues.iter().any(|i| i.message.contains("Negative tabindex")));

§Errors

Returns Error::HtmlProcessingError if internal selector dispatch fails (none of the static selectors used here can fail in practice).

Source

pub fn check_language_attributes( document: &Html, issues: &mut Vec<Issue>, ) -> Result<()>

Check language attributes.

Verifies that the root <html> element carries a lang attribute and that any element-level lang="..." overrides are valid BCP 47 codes. Each violation is pushed to issues.

§Examples

use html_generator::accessibility::{AccessibilityReport, Issue};
use scraper::Html;

let doc = Html::parse_document(r#"<html><body><p>x</p></body></html>"#);
let mut issues: Vec<Issue> = Vec::new();
AccessibilityReport::check_language_attributes(&doc, &mut issues).unwrap();
assert!(issues.iter().any(|i| i.message.contains("Missing language")));

§Errors

Returns Error::HtmlProcessingError for internal selector dispatch failures (not reachable in practice).

Source

pub fn check_advanced_aria( document: &Html, issues: &mut Vec<Issue>, ) -> Result<()>

Check advanced ARIA usage.

Verifies that any role="..." attributes are valid for the element they appear on, and that elements with ARIA roles carry all required companion properties (e.g. a slider requires aria-valuenow).

§Examples

use html_generator::accessibility::{AccessibilityReport, Issue};
use scraper::Html;

// The `aria-label` is what makes the element match the
// `aria-*` selector that `check_advanced_aria` walks; `slider`
// requires `aria-valuenow` plus min/max, which are absent here.
let doc = Html::parse_fragment(
    r#"<div role="slider" aria-label="vol"></div>"#,
);
let mut issues: Vec<Issue> = Vec::new();
AccessibilityReport::check_advanced_aria(&doc, &mut issues).unwrap();
assert!(
    issues
        .iter()
        .any(|i| i.message.contains("required ARIA properties"))
);