API Reference

AccessKitDevTools

1 min read

AccessKitDevTools

Floating dev panel that runs accessibility audits on the current page. Shows findings with severity, WCAG level, and fix guidance. For development only; mount inside a dev-only branch (e.g. process.env.NODE_ENV === "development") so it is not shipped to production.

PropTypeDefaultRequiredDescription
routeKeystring/YesCurrent pathname from your router (e.g. Next.js usePathname(), React Router useLocation().pathname). Resets findings when the route changes.
defaultOpenbooleanfalseNoWhether the dev tools panel is open when the page loads.
positionAccessKitPosition"bottom-left"NoWhere the dev tools tab is placed. One of "bottom-right", "center-right", "top-right", "bottom-left", "center-left", "top-left".
zIndexnumber2147483641NoStacking order for the tab and panel. Use a lower value than the widget's zIndex if you want the widget to stay on top.
additionalRules AccessKitAdditionalRuleTag[]-NoExtra rule-set tags to run in addition to default WCAG A/AA/AAA (e.g. ["best-practice", "section508"] or category tags like "cat.color").