Skip to main content
Module

x/tui/mod.ts>Tui

🦕 Deno module for creating Terminal User Interfaces
Im-Beast/deno_tui
Go to Latest
class Tui
extends EventEmitter<{ destroy: EmitterEvent<[]>; } & InputEventRecord>
Re-export
import { Tui } from "https://deno.land/x/tui@2.1.10/mod.ts";

Root element of Tui app.

This keeps elements running and manages Components as children.

Examples

Example 1

const tui = new Tui({
  style: crayon.bgBlack,
  refreshRate: 1000 / 60,
});

tui.dispatch();
tui.run();

Constructors

new
Tui(options: TuiOptions)

Properties

canvas: Canvas
children: Component[]
components: Set<Component>
drawnObjects: { background?: BoxObject; }
rectangle: Signal<Rectangle>
refreshRate: number
stdin: Stdin
stdout: Stdout
optional
style: Style

Methods

addChild(child: Component): void
destroy(): void
dispatch(): void
run(): void