install

fun install(activity: ComponentActivity, config: ScannerConfig = ScannerConfig(enabledRules = ScannerRules.allRuleIds().toSet()))

Attaches the accessibility scanner overlay to activity.

A default ScannerConfig that enables all built-in rules is used when config is omitted. Calling install for an activity that is already installed is a no-op.

Must be called on the main thread, typically in Activity.onCreate after setContent.

Parameters

activity

Activity that should receive the scanner overlay.

config

Scanner configuration applied to this install.

Throws

in non-debug builds.