Expand description
Prelude for convenient imports
Macros§
- reducer_
compose - Compose a reducer by routing actions to focused handlers.
Structs§
- Action
Logger Config - Configuration for action logging with glob pattern filtering.
- Action
Logger Middleware - Middleware that logs actions with configurable pattern filtering.
- Composed
Middleware - Compose multiple middleware into a single middleware
- Debug
Freeze - Debug freeze state for capturing and inspecting UI frames
- Debug
Table Builder - Builder for constructing debug tables
- Dispatch
Result - Result of dispatching an action to an effect-aware store.
- Dispatch
Runtime - Runtime helper for simple stores (no effects).
- Effect
Context - Context passed to effect handlers.
- Effect
Runtime - Runtime helper for effect-based stores.
- Effect
Store - A store that supports effect-emitting reducers.
- Effect
Store With Middleware - An effect store with middleware support.
- Event
- An event with its context
- Event
Bus - Event bus that manages subscriptions and dispatches events
- Event
Context - Context passed with every event
- Event
Outcome - Result of mapping an event into actions plus an optional render hint.
- 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. - Logging
Middleware - Middleware that logs actions (for debugging)
- Modifier
- Modifier changes the way a piece of text is displayed.
- Noop
Middleware - A no-op middleware that does nothing
- Numeric
Component Id - A simple numeric component ID for basic use cases
- Poller
Config - Configuration for the event poller.
- Rect
- A Rectangular area.
- Render
Context - Context passed to render closures.
- 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
- Store
With Middleware - 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.
Enums§
- Color
- ANSI Color
- Debug
Overlay - Type of debug overlay
- Event
Kind - The actual event payload
- Event
Type - Event types that components can subscribe to
- RawEvent
- Raw event from crossterm before processing
Traits§
- Action
- Marker trait for actions that can be dispatched to the store
- Action
Category - Extension trait for actions with category support
- Action
Params - Trait for getting action parameters without the variant name.
- Binding
Context - Trait for user-defined keybinding contexts
- Component
- A pure UI component that renders based on props and emits actions
- Component
Id - Trait for user-defined component identifiers
- Dispatch
Store - Store interface used by
DispatchRuntime. - Effect
Store Like - Effect store interface used by
EffectRuntime. - Middleware
- Middleware trait for intercepting actions
Functions§
- 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
Type Aliases§
- Effect
Reducer - A reducer function that can emit effects.
- Reducer
- A reducer function that handles actions and mutates state
Derive Macros§
- Action
- Derive macro for the Action trait
- Binding
Context - Derive macro for the BindingContext trait
- Component
Id - Derive macro for the ComponentId trait
- Debug
State - Derive macro for the DebugState trait
- Feature
Flags - Derive macro for the FeatureFlags trait