Skip to content

[BUG]: Fix vitest-accessiblity-checker documentation #2583

Description

@wkeese

Project

other

Browser

Chrome

Description

vitest-accessibility-checker seems to be working but the documentation just needs to be updated.

https://www.npmjs.com/package/vitest-accessibility-checker links to github.com/IBMa/equal-access#readme, but that page doesn't actually say anything about vitest-accessibility-checker.

Further, if we look at index.d.ts, it claims:

/**
 * Browser-side accessibility checker functions
 * These are available in the browser context via window.aChecker
 */
declare global {
    interface Window {
        aChecker: {
            /**
             * Get accessibility compliance results for a DOM element or document
             * 
             * @param content - The element or document to scan
             * @param label - Label for this scan
             * @returns Promise with compliance report
             */
            getCompliance(content: Element | Document, label: string): Promise<IBaselineReport>;

However, in actuality, the relevant function is apparently window.ACBrowserHelper.runScan().

I'm not sure completely though, is runScan() equivalent to runCompliance(), and if so, why did the name change?

PS: It seems though that page https://www.npmjs.com/package/vitest-accessibility-checker itself has good documentation..

Metadata

Metadata

Assignees

Labels

3Q2026user-reportedIssues identified outside of the core team

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions