agnostic - v1.0.0

agnostic/platform/opentui

The OpenTUI platform for Lustre. This module provides a platform configuration that targets @opentui/core for building terminal user interfaces with Lustre’s MVU architecture.

Types

Config

opaque </>

Configuration for creating an OpenTUI renderer.

pub opaque type Config

ElementFactory

</>

A factory function that receives the renderer and returns a renderable node. Used with register_element to define custom element types.

pub type ElementFactory =
  fn(Renderer) -> Node

Event

</>

A type representing a TUI event.

pub type Event

Node

</>

A type representing a TUI renderable node from @opentui/core.

pub type Node

Renderer

</>

A type representing an OpenTUI CLI renderer.

pub type Renderer

Value

</>

A type representing a TUI property value.

pub type Value

Values

after_flush_phase

</> 
pub const after_flush_phase: String

The phase name tagged by opentui/effect.after_flush and declared by the OpenTUI platform. Public so custom platforms can declare a Phase with this exact name to run after_flush effects.

after_layout_phase

</> 
pub const after_layout_phase: String

The phase name tagged by opentui/effect.after_layout and declared by the OpenTUI platform. Public so custom platforms can declare a Phase with this exact name to run after_layout effects.

auto_focus

</> 
pub fn auto_focus(config: Config, value: Bool) -> Config

Set whether to auto-focus the first focusable element.

background_color

</> 
pub fn background_color(config: Config, value: String) -> Config

Set the background color.

debounce_delay

</> 
pub fn debounce_delay(config: Config, value: Int) -> Config

Set the debounce delay in milliseconds.

default_config

</> 
pub fn default_config() -> Config

Create a default configuration for the OpenTUI renderer.

enable_mouse_movement

</> 
pub fn enable_mouse_movement(
  config: Config,
  value: Bool,
) -> Config

Set whether to enable mouse movement events.

exit_on_ctrl_c

</> 
pub fn exit_on_ctrl_c(config: Config, value: Bool) -> Config

Set whether Ctrl+C exits the application.

frame_callbacks_phase

</> 
pub const frame_callbacks_phase: String

The phase name tagged by opentui/effect.frame_callbacks and declared by the OpenTUI platform. Public so custom platforms can declare a Phase with this exact name to run frame_callbacks effects.

gather_stats

</> 
pub fn gather_stats(config: Config, value: Bool) -> Config

Set whether to gather performance stats.

max_fps

</> 
pub fn max_fps(config: Config, value: Int) -> Config

Set the maximum frames per second. This paces on-demand frames — the one-shot renders triggered by state changes — capping how fast bursts of updates repaint.

max_stat_samples

</> 
pub fn max_stat_samples(config: Config, value: Int) -> Config

Set the maximum number of stat samples to keep.

open_console_on_error

</> 
pub fn open_console_on_error(
  config: Config,
  value: Bool,
) -> Config

Set whether to open console on error.

register_element

</> 
pub fn register_element(
  config: Config,
  tag: String,
  factory: fn(Renderer) -> Node,
) -> Config

Register a custom element factory for a tag name. Once registered, using element.element(tag, attrs, children) with this tag will create a node via the factory instead of falling back to a box container.

Built-in tags (box, text, input, etc.) cannot be overridden — custom factories are only consulted when no built-in renderable matches.

remote

</> 
pub fn remote(config: Config, value: Bool) -> Config

Set whether to enable remote rendering.

target_fps

</> 
pub fn target_fps(config: Config, value: Int) -> Config

Set the target frames per second. Rendering is on-demand: this paces the continuous render loop, which only runs while OpenTUI animations are active (requestAnimationFrame, timelines). It has no effect at idle or on state-change renders — those are paced by max_fps.

use_alternate_screen

</> 
pub fn use_alternate_screen(
  config: Config,
  value: Bool,
) -> Config

Set whether to use the alternate screen buffer.

use_console

</> 
pub fn use_console(config: Config, value: Bool) -> Config

Set whether to use the built-in console.

use_kitty_keyboard

</> 
pub fn use_kitty_keyboard(config: Config, value: Bool) -> Config

Set whether to use Kitty keyboard protocol.

use_mouse

</> 
pub fn use_mouse(config: Config, value: Bool) -> Config

Set whether to enable mouse input.

use_thread

</> 
pub fn use_thread(config: Config, value: Bool) -> Config

Set whether to use a separate thread for rendering.

✨ Search Document