API Reference Excessibility v#0.14.0

Accessibility snapshot testing for Phoenix applications.

Behaviour for browser page source extraction.

Tracks capture state for auto-snapshot functionality.

HTML parsing, wrapping, and static asset path handling.

LiveView HTML extraction for snapshot testing.

Behaviour for LiveView HTML rendering.

Wrapper functions for Phoenix.LiveViewTest helpers that automatically capture snapshots when @tag capture_snapshots: true is used.

LiveView-aware accessibility rules.

Behaviour for LiveView-aware accessibility rules.

Flags elements that use phx-click-away for dismissal but provide no keyboard equivalent, leaving keyboard and screen-reader users unable to close the overlay.

Flags <input phx-debounce> when the snapshot has no ARIA live region anywhere.

Flags visually hidden <input type="checkbox"> / <input type="radio"> elements used as the programmatic backing for custom UI, when the visual replacement does not communicate checked state via ARIA.

Flags phx-click and phx-click-away placed on elements that are not natively keyboard-accessible.

Flags elements that use Phoenix.LiveView.JS.toggle/show/hide in phx-click but do not expose the expand/collapse state to assistive technology.

Helpers for getting the MCP client's context (working directory, etc).

Handles the MCP elicitation protocol for structured user interaction.

Helper for sending MCP progress notifications.

Behaviour for MCP prompts.

Auto-discovers MCP tools, resources, and prompts at compile time.

Behaviour for MCP resources.

MCP resource for accessing excessibility configuration.

MCP resource for accessing HTML snapshots.

MCP server for excessibility tools, resources, and prompts.

Subprocess execution with proper timeout handling.

Behaviour for MCP tools.

MCP tool for running accessibility checks.

Composite MCP tool that runs tests, accessibility checks, and optional performance analysis in one call.

MCP tool for running debug analysis on LiveView tests.

MCP tool for scaffolding accessibility snapshot tests.

MCP tool for listing or reading HTML snapshots.

MCP tool for reading captured timeline data.

Runtime scanner for arbitrary URLs.

Core snapshot generation and file management.

Cross-snapshot diffing: compare two HTML snapshots of the same view and report the regions whose rendered content changed.

Protocol for extracting HTML from various test sources.

Default implementation for system commands.

Behaviour for system-level operations.

Telemetry-based automatic snapshot capture for LiveView tests.

Behaviour for timeline analyzers.

Correlates state changes with accessibility implications.

Detects large assigns that get re-diffed frequently.

Analyzes assign lifecycle patterns.

Analyzes event cascade patterns.

Maps timeline events to likely source code locations.

Detects unnecessary component re-renders.

Analyzes data growth patterns across timeline events.

Analyzes Ecto query patterns across timeline events.

Analyzes event patterns and sequences across timeline.

Analyzes form validation patterns.

Detects handle_event calls that don't modify state.

Generates hypotheses about likely root causes.

Analyzes memory usage patterns across timeline events.

Detects high-frequency handle_info message patterns.

Analyzes performance patterns across timeline events.

Detects excessive push_event calls to JS hooks.

Analyzes render efficiency by detecting wasted renders.

Analyzes state transitions across timeline events.

Generates natural language summary of timeline.

Computes differences between sequential telemetry snapshots.

Behaviour for timeline event enrichers.

Enriches timeline events with per-assign byte size information.

Enriches timeline events with information about large binary content.

Enriches timeline events with Ecto changeset information.

Enriches timeline events with collection size information.

Enriches timeline events with LiveComponent structure information.

Enriches timeline events with duration information.

Enriches timeline events with Ecto query information.

Enriches timeline events with push_event call information.

Enriches timeline events with query/database information.

Enricher that detects stale timestamp fields in assigns.

Enriches timeline events with state structure information.

Filters noise from telemetry snapshot assigns.

Formats telemetry timeline data for different output formats.

Predefined analyzer profiles for common use cases.

Auto-discovers enrichers and analyzers at compile time.

Generates timeline data from telemetry snapshots.

Runs axe-core accessibility checks on HTML snapshots.

Copies current snapshots to the baseline directory.

Runs axe-core accessibility checks against any URL.

Compares current snapshots against the baseline and prompts for resolution.

Run tests and generate a comprehensive debug report with all snapshots.

Installs Excessibility into a host project using Igniter.

Display the most recent debug report without re-running tests.

Create a debug package for a test.

List, clean, or open HTML snapshots.