axe-hud API
    Preparing search index...

    Interface AxeHudProviderProps

    Public configuration for the HUD.

    Note: the HUD has no environment gating of its own — calling createAxeHud() mounts it (when a DOM is present). Decide where it runs by deciding where you load/call it, e.g. a guarded dynamic import in development or staging builds.

    interface AxeHudProviderProps {
        axe?: AxeLike;
        axeContext?: ContextSpec;
        axeOptions?: RunOptions;
        children?: ReactNode;
        debounceMs?: number;
        onAudit?: (outcome: AuditOutcome) => void;
        position?: WidgetPosition;
        runOn?: { initial?: boolean; navigation?: boolean };
    }

    Hierarchy (View Summary)

    Index

    Properties

    axe? axeContext? axeOptions? children? debounceMs? onAudit? position? runOn?

    Properties

    axe?: AxeLike

    Inject a custom axe-core instance instead of the bundled lazy import.

    axeContext?: ContextSpec

    Context forwarded to axe.run. The HUD's own root is always excluded.

    axeOptions?: RunOptions

    Options forwarded to axe.run. Defaults to the EN 301 549 (EU baseline) tag set.

    children?: ReactNode
    debounceMs?: number

    Debounce window, in milliseconds, for navigation-triggered audits.

    onAudit?: (outcome: AuditOutcome) => void

    Called with every completed (or failed) audit outcome.

    position?: WidgetPosition

    Corner the widget is anchored to. Defaults to 'bottom-right'.

    runOn?: { initial?: boolean; navigation?: boolean }

    Which events trigger an audit. Both default to true.

    Settings

    Member Visibility

    On This Page

    Properties