Skip to main content

Crate textual

Crate textual 

Source
Expand description

Textual-inspired reactive TUI framework built on rich-rs.

Re-exports§

pub use event::BindingHint;
pub use keys::KeyEventData;
pub use node_id::NodeId;
pub use node_id::node_id_from_ffi;
pub use node_id::node_id_to_ffi;
pub use reactive::ReactiveCtx;
pub use reactive::ReactiveWidget;
pub use runtime::App;
pub use runtime::DomQuery;
pub use runtime::DomQueryMut;
pub use screen::Screen;
pub use screen::ScreenResult;
pub use screen::ScreenResultCallback;
pub use screen::ScreenStack;
pub use style::Color;
pub use style::Style;
pub use style::Theme;
pub use textual_app::OverlayScreenStack;
pub use textual_app::TextualApp;
pub use textual_app::run;
pub use textual_app::run_snapshot;
pub use textual_app::run_snapshot_with_output;
pub use textual_app::run_sync;
pub use textual_app::run_sync_snapshot;
pub use textual_app::run_sync_snapshot_with_output;
pub use textual_app::run_sync_with_output;
pub use textual_app::run_textual_app;
pub use textual_app::run_textual_app_or_snapshot;
pub use textual_app::run_textual_app_or_snapshot_with_output;
pub use textual_app::run_textual_app_with_output;
pub use widgets::BindingDecl;
pub use widgets::WidgetStyles;

Modules§

action
Action system foundation: types, traits, parser, and built-in declarations.
animation
compose
Compose API types for declarative widget tree construction.
css
debug
demo_snapshot
driver
Terminal driver: terminal lifecycle, capability detection, keyboard-protocol and pointer-shape control built directly on top of crossterm.
event
keys
Canonical key model and normalization helpers.
layout
Layout solver infrastructure.
message
node_id
Arena-based widget identity.
prelude
reactive
Reactive attribute system for textual-rs.
render
Rendering boundary for textual-rs.
renderables
runtime
screen
Screen system for full-page overlays with independent widget trees.
signal
Typed signal/observer pattern for lightweight pub/sub notifications.
style
textual_app
validation
widget_tree
Arena-based widget tree.
widgets
worker
Worker abstraction for background tasks with lifecycle management.

Macros§

compose
Declarative macro for building a ComposeResult from widget expressions.
delegate_renderable
Also generate impl Renderable when used alongside delegate_widget_method!. Place this after the impl Widget for ... block.
delegate_widget_method
Widget method delegation macros.
delegate_widget_to
Generate a complete impl Widget + impl Renderable block forwarding every method to self.$field. Use for thin wrappers with zero overrides. For wrappers that override some methods, use delegate_widget_method! inside a hand-written impl Widget block.

Enums§

Error

Type Aliases§

Result

Attribute Macros§

on
Attribute macro for typed message handler dispatch.

Derive Macros§

Reactive
Derive macro for the reactive field system.