Skip to main content

Crate ratkit

Crate ratkit 

Source
Expand description

§ratkit - Core runtime for ratkit TUI components

ratkit provides the core runtime (Runner + Layout Manager) and optional re-exports for ratkit TUI components. Enable only the features you need or use the all feature for the full bundle.

§Installation

[dependencies]
ratkit = "0.2.12"

For the core runtime only:

ratkit = "0.2.12"

For selected components:

ratkit = { version = "0.2.12", default-features = false, features = ["tree-view", "toast"] }

For the full bundle:

ratkit = { version = "0.2.12", features = ["all"] }

§Quick Start

use ratkit::prelude::*;
use ratatui::Frame;

struct MyApp;

impl CoordinatorApp for MyApp {
    fn on_event(&mut self, _event: CoordinatorEvent) -> LayoutResult<CoordinatorAction> {
        Ok(CoordinatorAction::Continue)
    }

    fn on_draw(&mut self, _frame: &mut Frame) {}
}

fn main() -> std::io::Result<()> {
    run(MyApp, RunnerConfig::default())
}

With widget features enabled, import UI primitives from ratkit::widgets.

§Feature Flags

  • default: Core runtime only (Runner + Layout Manager)
  • all: All widgets and services
  • full: Alias for all
  • widgets: All UI widgets
  • services: All service components
  • Individual feature flags for each component