scanner-core/com.composea11yscanner.core.rule/A11yRule

A11yRule

interface A11yRule

Contract implemented by every accessibility rule.

Inheritors

Properties

abstract val ruleId: String

Stable id used in configuration, reports, and issue ids.

abstract val ruleName: String

Human-readable rule name shown in reports.

abstract val severity: A11ySeverity

Severity assigned to issues produced by this rule.

abstract val wcagReference: String?

Optional WCAG criterion associated with this rule.

Functions

abstract fun evaluate(node: A11yNode): A11yIssue?

Evaluates a single node.

open fun evaluateAll(nodes: List<A11yNode>): List<A11yIssue>

Evaluates an entire node list.