Crate accessibility_rs

source ·
Expand description

Audit html to see how it complies with WCAG standards.

accessibility-rs is a web accessibility engine that can replicate websites without a browser to get complex accessibility reports.

§How to use accessibility-rs

There are a couple of ways to use accessibility-rs:

  • Audit perform an audit against an html page.
    • audit is used to audit a web page for issues.

§Examples

A basic WCAG audit for a website:

use accessibility_rs::{audit, AuditConfig};

#[cfg(not(feature = "tokio"))]
fn main() {
    let config = AuditConfig::basic(r###"<html><body><h1>My Title</h1><input type="text" placeholder="Type me"></input><img src="tabby_cat.png"></img></body></html>"###);
    let audit = audit(config);
    println!("{:?}", audit);
}

#[cfg(all(feature = "tokio", not(feature = "spider")))]
#[tokio::main]
async fn main() {
    let config = AuditConfig::basic(r###"<html><body><h1>My Title</h1><input type="text" placeholder="Type me"></input><img src="tabby_cat.png"></img></body></html>"###);
    let audit = audit(config).await;
    println!("{:?}", audit);
}

#[cfg(feature = "spider")]
#[tokio::main]
async fn main() {
    let mut config = AuditConfig::default();
    config.url = "https://example.com".into();
    let audit = audit(config).await;
    println!("{:?}", audit);
}

Modules§

  • engine
    the main engine for accessibility auditing.
  • i18n
    locales for translations.

Structs§

Enums§

Functions§