Skip to main content

debug

The debug configuration controls OpenKeyNav's keyboard-accessibility diagnostics during development.

Debug diagnostics​

debug.keyboardAccessible is enabled by default in the current release. During Click Mode target discovery, OpenKeyNav uses heuristics to identify likely mouse-clickable, unfocusable elements. It applies a red review outline to each candidate and its regular label, with diagnostic details available on hover.

Review each marked element's semantics, accessible name, focus behavior, keyboard operation, state, and visible focus, then record the result as part of the complete workflow evaluation.

Configuration​

const openKeyNav = new OpenKeyNav();

openKeyNav.init({
  debug: {
    keyboardAccessible: true,
  },
});

Set keyboardAccessible to false to switch to standard Click Mode labels for production.

openKeyNav.init({
  debug: {
    keyboardAccessible: false,
  },
});

Expanded audit panel​

v.next

The v.next diagnostic design expands the existing checks into a page-wide heuristic scan. With debug.keyboardAccessible set to true, enabling OpenKeyNav scans likely interactive elements, records review candidates, writes the results to the console, and opens an audit panel when it finds candidates.

The expanded audit runs automatically when OpenKeyNav is enabled and uses the same debug.keyboardAccessible setting as the current diagnostics.

Use this focused keyboard-accessibility heuristic alongside complete WCAG evaluation of pages and processes.