Expand description
UI Inspector overlay for debugging widget trees and hit-test regions. UI Inspector overlay for debugging widget trees and hit-test regions.
The inspector visualizes:
- Hit regions with colored overlays
- Widget boundaries with colored borders
- Widget names and metadata
§Usage
ⓘ
use ftui_widgets::inspector::{InspectorMode, InspectorState, InspectorOverlay};
// In your app state
let mut inspector = InspectorState::default();
// Toggle with F12
if key == KeyCode::F12 {
inspector.toggle();
}
// Render overlay after all widgets
if inspector.is_active() {
InspectorOverlay::new(&inspector).render(area, frame);
}See docs/specs/ui-inspector.md for the full specification.
Structs§
- Diagnostic
Entry - JSONL diagnostic log entry.
- Diagnostic
Log - Diagnostic log collector.
- HitInfo
- Helper to extract hit information from a HitCell for display.
- Inspector
Overlay - Inspector overlay widget.
- Inspector
State - Inspector overlay state (shared across frames).
- Inspector
Style - Configuration for inspector appearance.
- Telemetry
Hooks - Telemetry hooks for observing inspector events.
- Widget
Info - Information about a widget for inspector display.
Enums§
- Diagnostic
Event Kind - Diagnostic event types for JSONL logging.
- Inspector
Mode - Inspector display mode.
Functions§
- diagnostics_
enabled - Check if diagnostics are enabled.
- init_
diagnostics - Initialize diagnostic settings from environment.
- is_
deterministic_ mode - Check if deterministic mode is enabled.
- reset_
event_ counter - Reset event counter (for testing determinism).
- set_
diagnostics_ enabled - Set diagnostics enabled state (for testing).
Type Aliases§
- Telemetry
Callback - Callback type for telemetry hooks.