Module prelude

Expand description

Prelude for convenient imports

Structs§

ActionLoggerConfig: Configuration for action logging with glob pattern filtering.
ActionLoggerMiddleware: Middleware that logs actions with configurable pattern filtering.
ComposedMiddleware: Compose multiple middleware into a single middleware
DebugFreeze: Debug freeze state for capturing and inspecting UI frames
DebugTableBuilder: Builder for constructing debug tables
Event: An event with its context
EventBus: Event bus that manages subscriptions and dispatches events
EventContext: Context passed with every event
Frame: A consistent view into the terminal state for rendering a single frame.
Keybindings: Keybindings configuration with context support
Line: A line of text, consisting of one or more Spans.
LoggingMiddleware: Middleware that logs actions (for debugging)
Modifier: Modifier changes the way a piece of text is displayed.
NoopMiddleware: A no-op middleware that does nothing
NumericComponentId: A simple numeric component ID for basic use cases
Rect: A Rectangular area.
Span: Represents a part of a line that is contiguous and where all characters share the same style.
Store: Centralized state store with Redux-like reducer pattern
StoreWithMiddleware: Store with middleware support
Style: Style lets you control the main characteristics of the displayed elements.
Text: A string split over one or more lines.

Action: Marker trait for actions that can be dispatched to the store
ActionCategory: Extension trait for actions with category support
BindingContext: Trait for user-defined keybinding contexts
Component: A pure UI component that renders based on props and emits actions
ComponentId: Trait for user-defined component identifiers
Middleware: Middleware trait for intercepting actions

format_key_for_display: Format a key string for display (e.g., “ctrl+p” -> “^P”, “q” -> “q”, “tab” -> “Tab”)
parse_key_string: Parse a key string like “q”, “esc”, “ctrl+p”, “shift+tab” into a KeyEvent
process_raw_event: Process a raw event into an EventKind
spawn_event_poller: Spawn the event polling task with cancellation support