Crate osui

OSUI – A Rust Terminal User Interface Library

OSUI is a library for building interactive and customizable terminal user interfaces in Rust. It provides a component system, real-time keyboard input handling, and a rsx! macro for defining UI elements in a declarative way, however that is optional.

✅ Features

• 🧱 RSX-like syntax with rsx! macro
• 🖥️ Virtual screen abstraction
• 🎹 Keyboard input handling
• 🎯 Component-based design
• ⚡ Real-time rendering

🚀 Quick Example

use osui::prelude::*;

fn main() -> std::io::Result<()> {
    let screen = Screen::new();
    rsx! {
        "👋 Hello, World!"
    }.draw(&screen);
    screen.run()
}

---

🧰 For full documentation, visit: osui.netlify.app/docs

🧪 Examples and demos: github.com/osui-rs/osui/demos

Modules

elements

extensions

frontend

The frontend binder for OSUI.

macros

prelude

render_scope

Rendering logic and layout scope management for OSUI.

state

style

Layout and style definitions for OSUI widgets.

utils

The utils module provides utility functions for terminal manipulation and string operations, designed to enhance terminal-based applications.

widget

Core widget infrastructure for OSUI.

Macros

component

Declares a struct that implements the Component trait.

event

Declares a struct that implements the Event trait.

event_handler

Creates an event handler closure that calls a method on self.

rsx

Constructs an Rsx tree using declarative syntax.

rsx_inner

Internal macro used by rsx! to recursively build Rsx trees.

transform

Creates a Transform with property overrides.

Structs

NoRender

NoRenderRoot

RenderWrapperEvent

Screen

The main screen abstraction for rendering and managing widgets and extensions.