BarrierLab

API Overview

The most important types and functions per crate. The detailed documentation of each item is on docs.rs.

a11y-rules

ItemPurpose
run, run_with_semantics, run_with_rendering, run_fullcheck a document, depending on what the host provides
run_in, run_with_semantics_in, run_with_rendering_in, run_full_inthe same, with finding texts in the chosen Locale (En, De)
structure_rules, semantics_rules, rendering_rulesthe rules of a tier, bound to a host
structure_metas, semantics_metas, rendering_metasthe declarations without a host, for listing and naming
catalogue, meta_forall declarations in one stable list, and the lookup by finding ID (feature serde: serialisable)
MetaIDs, tier, WCAG criteria, default severity and hint of a rule
StructureRule, SemanticsRule, RenderingRulea rule as a function pointer plus Meta

docs.rs/a11y-rules

a11y-dom

ItemPurpose
Document, Nodethe DOM-shaped base tree
Semantics, Rendering, Interactionthe capabilities on top of the structure
Tier, Capswhich data layer a rule needs, what a host provides
ComputedStyle, Color, Rect, NameSourcedata of the capabilities
Arena, ArenaBuilder, ArenaNodebundled tree, test vehicle and form for WASM hosts
elements, descendants, ancestors, closest, subtree_text, has_texttraversal

docs.rs/a11y-dom

a11y-report

ItemPurpose
Finding, Location, Evidencea check result with location and evidence
Outcome, Severity, WcagLevelthe two axes and the WCAG level
Report, Summaryfindings, records and counts
RuleRun, NotRunwhether a rule ran, and if not, why
Extraopaque, non-serialized extra attached to a finding

docs.rs/a11y-report

accname

ItemPurpose
name, descriptionaccessible name and description
role, impliciteffective and implicit role
allows_name_from_content, name_is_prohibitedproperties of a role
IdIndexID index for references

docs.rs/accname

Edit this page on GitHub