API Reference Raxol Core v#2.4.0

Copy Markdown View Source

Modules

Refactored Accessibility module that delegates to the unified GenAccessibilityServer.

Unified GenServer implementation for accessibility features in Raxol.

Pure-functional helpers for announcement queue management, priority sorting, history tracking, and delivery. Used by AccessibilityServer.

Handles screen reader announcements and announcement queue management.

Behaviour for accessibility implementations.

Handles accessibility-related events and notifications.

Pure-functional helpers for focus tracking, announcements, and event handler registration within the AccessibilityServer state.

Handles accessibility metadata for UI elements and component styles.

Pure-functional helpers for accessibility metadata and component style registration within the AccessibilityServer state.

Preference sync helpers for AccessibilityServer. Handles merging, setting, and syncing preferences to UserPreferences.

Manages accessibility preferences and settings.

Base behavior for manager GenServers to reduce code duplication. Provides common patterns for state management, lifecycle, and error handling.

Base behavior for registry GenServers to reduce code duplication. Provides common patterns for registering, unregistering, and looking up resources.

Base behavior for general-purpose GenServers to reduce code duplication. Provides common patterns for server lifecycle, error handling, and state management.

Common behavior for lifecycle management across different components.

Common behavior for metrics collection and reporting.

Behaviour for state management systems.

Pure functional configuration management for Raxol.

Backward-compatible configuration server.

ETS-backed configuration store for fast concurrent reads.

Canonical default values for the Raxol framework.

Functional error handling patterns for Raxol.

Error recovery strategies for the Raxol application.

Defines the structure for events in the Raxol system, providing a standardized format for key presses, mouse actions, and other UI events that components need to process.

Event management system that wraps :telemetry for backward compatibility.

GenServer implementation for event management in Raxol applications.

Alias module for Raxol.Core.Events.EventManager.

Provides helpers for managing event subscriptions.

Adapter to migrate from EventManager to :telemetry.

Converts rrex_termbox v2.0.1 NIF events to Raxol.Core.Events.Event structs.

Convenience module for focus management in TEA applications.

Refactored FocusManager that delegates to GenServer implementation.

Defines the behaviour for focus management services.

GenServer implementation for focus management.

Unified registry interface consolidating different registry patterns across Raxol.

Behaviour for unified registry operations.

Refactored internationalization module using GenServer for state management.

ETS-backed internationalization server.

Refactored KeyboardNavigator that delegates to GenServer implementation.

BaseManager implementation for keyboard navigation in Raxol terminal UI applications.

Refactored KeyboardShortcuts that delegates to GenServer implementation.

GenServer implementation for keyboard shortcuts management.

Behavior for KeyboardShortcuts implementation.

Shared utilities for navigation path management. Used by both KeyboardNavigator and WindowManager to avoid code duplication.

Manages user preferences and settings for the Raxol terminal UI.

Handles persistence (loading/saving) of user preferences to a file.

Handles storage and retrieval of user preferences.

Centralized logging system for Raxol with structured context, performance tracking, and consistent formatting across all modules.

This module is responsible for processing cells in the Raxol runtime.

Handles plugin command registration and dispatch for the Plugin Manager.

Manages command registration and execution for plugins.

Install-time and load-time dependency resolution for plugins.

Handles plugin discovery and initialization. This module is responsible for

Handles event filtering for plugins. This module is responsible for

Handles file watching and plugin reloading functionality.

Behavior for file watcher plugins.

Defines the behaviour for plugin lifecycle management.

Helper functions for plugin lifecycle management.

Behavior for plugin lifecycle management.

Handles plugin lifecycle operations including loading, unloading, enabling, and disabling plugins.

Manages plugin loading operations.

Behavior for plugin loading functionality.

Declarative plugin metadata struct.

Named set of plugins with configuration overrides.

Defines the behaviour for Raxol plugins.

Behavior for plugin command handling.

Manages plugin command registration and dispatch. Coordinates between plugins and the command system.

Handles plugin error handling and logging.

Behavior for plugin event filtering.

Handles event processing and filtering through plugins.

Handles initialization of plugins, including state setup and command registration.

GenServer for plugin lifecycle coordination.

Handles plugin lifecycle callback implementations.

Facade for plugin management operations.

Defines the behaviour for plugins that provide metadata like ID, version, and dependencies.

Pure functional plugin registry backed by ETS for fast concurrent lookups.

Handles plugin reloading operations including reloading by ID and from disk.

Behaviour for plugin reloading operations.

Supervisor for plugin tasks and processes.

Handles unloading of plugins, including command and state cleanup.

Comprehensive validation system for plugins before loading.

Defines the state struct for the plugin manager.

Runtime resource monitoring per plugin.

Enhanced version of LifecycleOperations with comprehensive error handling.

BEAM bytecode analyzer for detecting security-sensitive operations.

High-level capability detection for plugins.

Namespaced alias for StateManager.

Handles timer management for plugin operations including periodic ticks and file event timers.

Replacement for Process dictionary usage. Provides a functional alternative using Agent for state storage.

Trace context propagation for telemetry events.

Trace context management for request correlation across telemetry events.

Manages user preferences for the terminal emulator.

Internal state for the UserPreferences GenServer.

Purely functional debounce utilities for delayed operations.

Common GenServer patterns and utilities to reduce code duplication. Provides standardized handlers for common operations like state retrieval, metrics collection, and configuration management.

Shared list and collection utilities.

Shared numeric utilities.

Centralized timer management utilities for consistent timer handling across the codebase.

Consolidated timer utilities for standardized timer management across Raxol.

Common validation utilities to reduce code duplication across the codebase. Provides standardized validation functions for dimensions, configs, and common patterns.

Core behaviours, utilities, events, config, accessibility, and plugin infrastructure for Raxol.

Plugin state management utilities with full functionality.