core library
Pure-Dart part of a11yship (report model, rule catalog, rules engine). Safe to import from the Dart VM (CLI) and from Flutter web.
Classes
- Box
- A rectangle in logical pixels, relative to the top-left of the screen.
- ContrastSample
- Contrast measured for one piece of text on the screenshot.
- EngineOptions
- Options that change how strict rules are.
- Issue
- One accessibility problem found on one screen.
- ManualCheck
- A criterion that needs a human with a screen reader, keyboard or switch.
- NodeSnapshot
- A flattened, framework-independent view of one semantics node.
- OverflowSample
- A layout overflow reported while the screen was rendered at 200% text.
- Rule
- An automated rule.
- ScanReport
-
Everything one scan run produced. Serialised to
report.json. - ScanSummary
- Aggregated numbers for a scan, stored alongside it for fast dashboards.
- ScreenResult
- Result for a single captured screen (or screen state).
- ScreenSnapshot
- Everything captured for one screen.
- SourceLocation
- Where in the developer's code the offending widget was created.
- Wcag
- A WCAG success criterion.
- WcagSc
- WCAG criteria referenced by rules and the manual checklist.
Enums
- Severity
- Impact of an issue on users, modelled after common audit practice.
- TargetGuide
- Platform whose design guidelines are used for best-practice checks.
Constants
-
kManualChecks
→ const List<
ManualCheck> - Mobile-relevant WCAG 2.2 AA criteria that automation cannot decide.
- kReportSchemaVersion → const int
- Report schema version. Bump when the JSON shape changes incompatibly.
-
kRules
→ const List<
Rule> - All automated rules, in report order.
- kToolVersion → const String
- Version of the scanner that produced a report.
Properties
-
kRulesById
→ Map<
String, Rule> -
final
Functions
-
evaluateScreen(
ScreenSnapshot screen, {EngineOptions options = const EngineOptions()}) → ScreenResult -
Runs every rule on
screenand returns the screen result.