mooncakes.io

ansi
→
completion
→
components
→
core
→
docs
→
editor
→
events
→
headless
→
image
→
input
→
io
→
logics
→
render
→
stories
→
term
→
testing
→
vnode
→
README
U
A11yNode
U
AccordionState
U
App
U
BorderChars
U
ButtonState
U
CharBuffer
U
CharCell
U
Color
U
Component
U
DisplayValue
U
EditConfig
U
FocusContext
U
FocusNav
U
GridAutoFlowValue
U
HitTestResult
U
InputEvent
U
InputResult
U
InputState
U
KeyEvent
U
KeyModifier
U
ModalState
U
MouseButton
U
MouseEvent
U
MouseEventType
U
RenderStyleMap
U
Role
U
SelectionState
U
SpecialKey
U
TextContentMap
U
TextStyle
U
ToggleState
U
TuiEvent
U
TuiNode
U
VNodeApp
V
ansi_full_reset
V
cleanup_stdin
V
column
V
disable_mouse
V
disable_mouse_all
V
dump_a11y_tree
V
enable_mouse
V
enable_mouse_all
V
enable_raw_mode
V
form_edit_config
V
fragment
V
get_terminal_size
V
grid
V
grid_area
V
grid_item
V
hspace
V
init_vnode_terminal
V
input
V
input_plain
V
is_printable_char
V
is_printable_string
V
parse_input
V
print_raw
V
read_key
V
render_once
V
render_vnode_once
V
resolve_button_state
V
row
V
run
V
run_vnode_app
V
spacer
V
start_edit
V
start_edit_inplace
V
start_edit_inplace_in_bounds
V
start_keypress_listener
V
stop_keypress_listener
V
text
V
text_dyn
V
textarea
V
view
V
vspace

README

mizchi/tui/render does not have a README file

#
App

pub struct App {
  width : Int
  height : Int
  prev_buffer : CharBuffer?
  last_layout : @mizchi/crater-core.Layout
Layout?
  handlers : @mizchi/tui/events.EventHandlers
EventHandlers
}

App manages the render loop and diff-based updates

#
App::clear_prev_buffer

source

fn App::clear_prev_buffer(self : App) -> Unit

Clear the previous buffer to force a full re-render on next render call

#
App::create_render_effect

source

fn App::create_render_effect(self : App, render_fn : () -> @mizchi/tui/core.Component
Component, output_fn : (String) -> Unit) -> (() -> Unit)

Create a reactive effect that re-renders when signals change Returns a dispose function

#
App::dispatch_click

source

fn App::dispatch_click(self : App, event : @mizchi/tui/events.MouseEvent
MouseEvent, handlers : Map[String, () -> Unit]) -> String?

Dispatch a click event to handlers based on hit test result Returns the clicked component ID if found, None otherwise

#
App::dispatch_click_from_component

source

fn App::dispatch_click_from_component(self : App, event : @mizchi/tui/events.MouseEvent
MouseEvent, component : @mizchi/tui/core.Component
Component) -> String?

Dispatch a click event using Component's click_handlers Returns the clicked component ID if found and handler was invoked, None otherwise

#
App::dispatch_click_with_result

source

fn App::dispatch_click_with_result(self : App, event : @mizchi/tui/events.MouseEvent
MouseEvent) -> @mizchi/tui/events.HitTestResult
HitTestResult?

Dispatch a click event, returns hit result for custom handling

#
App::dispatch_hover

source

fn App::dispatch_hover(self : App, event : @mizchi/tui/events.MouseEvent
MouseEvent) -> String?

Dispatch hover event - returns hovered component ID on Move/Drag events

#
App::find_by_id

source

fn App::find_by_id(self : App, id : String) -> @mizchi/tui/events.HitTestResult
HitTestResult?

Find component by ID

#
App::handle_mouse

source

fn App::handle_mouse(self : App, event : @mizchi/tui/events.MouseEvent
MouseEvent) -> Bool

Handle a mouse event Returns true if an event handler was invoked

#
App::hit_test

source

fn App::hit_test(self : App, x : Int, y : Int) -> @mizchi/tui/events.HitTestResult
HitTestResult?

Perform hit test at coordinates

#
App::init_terminal

source

fn App::init_terminal() -> String

Initialize terminal (enter alt screen, hide cursor)

#
App::new

source

fn App::new(width : Int, height : Int) -> App

#
App::on_click

source

fn App::on_click(self : App, id : String, handler : () -> Unit) -> Unit

#
App::render

source

fn App::render(self : App, component : @mizchi/tui/core.Component
Component) -> String

Render a component tree to ANSI string

#
App::render_frame

source

fn App::render_frame(self : App, component : @mizchi/tui/core.Component
Component) -> String

Render with cursor hidden and positioned at origin

#
App::render_with_offset

source

fn App::render_with_offset(self : App, component : @mizchi/tui/core.Component
Component, row_offset? : Int, col_offset? : Int) -> String

Render a component tree with a cursor offset (no screen clear)

#
App::restore_terminal

source

fn App::restore_terminal() -> String

Restore terminal (show cursor, leave alt screen)

#
CharBuffer

source

pub struct CharBuffer {
  width : Int
  height : Int
  cells : Array[CharCell]
}

Character-based framebuffer

#
CharBuffer::clear

source

fn CharBuffer::clear(self : CharBuffer) -> Unit

#
CharBuffer::clone

source

fn CharBuffer::clone(self : CharBuffer) -> CharBuffer

Clone the buffer

#
CharBuffer::diff_to_ansi

source

fn CharBuffer::diff_to_ansi(self : CharBuffer, prev : CharBuffer) -> String

Optimized ANSI output with diff (only output changed cells)

#
CharBuffer::diff_to_ansi_offset

source

fn CharBuffer::diff_to_ansi_offset(self : CharBuffer, prev : CharBuffer, row_offset : Int, col_offset : Int) -> String

Optimized ANSI output with diff and an offset

#
CharBuffer::fill_bg

source

fn CharBuffer::fill_bg(self : CharBuffer, x : Int, y : Int, w : Int, h : Int, bg : @mizchi/tui/core.Color
Color) -> Unit

Fill background color and overwrite content with spaces This allows overlays to properly cover underlying content

#
CharBuffer::fill_rect

source

fn CharBuffer::fill_rect(self : CharBuffer, x : Int, y : Int, w : Int, h : Int, cell : CharCell) -> Unit

#
CharBuffer::get_cell

source

fn CharBuffer::get_cell(self : CharBuffer, x : Int, y : Int) -> CharCell

#
CharBuffer::new

source

fn CharBuffer::new(width : Int, height : Int) -> CharBuffer

#
CharBuffer::set_cell

source

fn CharBuffer::set_cell(self : CharBuffer, x : Int, y : Int, cell : CharCell) -> Unit

#
CharBuffer::to_ansi

source

fn CharBuffer::to_ansi(self : CharBuffer) -> String

Convert CharBuffer to ANSI-encoded string

#
CharBuffer::to_ansi_offset

source

fn CharBuffer::to_ansi_offset(self : CharBuffer, row_offset : Int, col_offset : Int) -> String

Convert CharBuffer to ANSI-encoded string with an offset

#
CharBuffer::write_text

source

fn CharBuffer::write_text(self : CharBuffer, x : Int, y : Int, text : String, style : TextStyle, max_width : Int) -> Int

#
CharBuffer::write_text_wrapped

source

fn CharBuffer::write_text_wrapped(self : CharBuffer, x : Int, y : Int, text : String, style : TextStyle, max_width : Int, max_height : Int) -> Int

#
CharCell

source

pub(all) struct CharCell {
  char : Char
  fg : @mizchi/tui/core.Color
Color
  bg : @mizchi/tui/core.Color
Color
  bold : Bool
  underline : Bool
  reverse : Bool
}

A single character cell in the terminal

impl Eq for CharCell

#
CharCell::default

source

fn CharCell::default() -> CharCell

#
CharCell::from_char

source

fn CharCell::from_char(c : Char) -> CharCell

#
CharCell::styled

source

fn CharCell::styled(c : Char, fg : @mizchi/tui/core.Color
Color, bg : @mizchi/tui/core.Color
Color) -> CharCell

#
TextStyle

source

pub(all) struct TextStyle {
  fg : @mizchi/tui/core.Color
Color
  bg : @mizchi/tui/core.Color
Color
  bold : Bool
  underline : Bool
}

Text style for writing text

#
TextStyle::default

source

fn TextStyle::default() -> TextStyle

#
ansi_bg_256

source

fn ansi_bg_256(color_idx : Int) -> String

#
ansi_bg_color

source

fn ansi_bg_color(color : @mizchi/tui/core.Color
Color) -> String

#
ansi_bg_reset

source

fn ansi_bg_reset() -> String

Reset background color to default

#
ansi_bold

source

fn ansi_bold() -> String

#
ansi_clear_line

source

fn ansi_clear_line() -> String

#
ansi_clear_screen

source

fn ansi_clear_screen() -> String

#
ansi_dim

source

fn ansi_dim() -> String

#
ansi_enter_alt_screen

source

fn ansi_enter_alt_screen() -> String

#
ansi_fg_256

source

fn ansi_fg_256(color_idx : Int) -> String

#
ansi_fg_black

source

fn ansi_fg_black() -> String

#
ansi_fg_blue

source

fn ansi_fg_blue() -> String

#
ansi_fg_color

source

fn ansi_fg_color(color : @mizchi/tui/core.Color
Color) -> String

#
ansi_fg_cyan

source

fn ansi_fg_cyan() -> String

#
ansi_fg_gray

source

fn ansi_fg_gray() -> String

Dim gray (bright black)

#
ansi_fg_green

source

fn ansi_fg_green() -> String

#
ansi_fg_magenta

source

fn ansi_fg_magenta() -> String

#
ansi_fg_red

source

fn ansi_fg_red() -> String

#
ansi_fg_white

source

fn ansi_fg_white() -> String

#
ansi_fg_yellow

source

fn ansi_fg_yellow() -> String

#
ansi_full_reset

source

fn ansi_full_reset() -> String

Full terminal reset sequence for recovering from corrupted state

#
ansi_hide_cursor

source

fn ansi_hide_cursor() -> String

#
ansi_leave_alt_screen

source

fn ansi_leave_alt_screen() -> String

#
ansi_move_down

source

fn ansi_move_down(n? : Int) -> String

Move cursor down by n lines

#
ansi_move_left

source

fn ansi_move_left(n? : Int) -> String

Move cursor left by n columns

#
ansi_move_right

source

fn ansi_move_right(n? : Int) -> String

Move cursor right by n columns

#
ansi_move_to

source

fn ansi_move_to(row : Int, col : Int) -> String

#
ansi_move_up

source

fn ansi_move_up(n? : Int) -> String

Move cursor up by n lines

#
ansi_reset

source

fn ansi_reset() -> String

#
ansi_reset_attrs

source

fn ansi_reset_attrs() -> String

Reset all terminal attributes (colors, styles)

#
ansi_reverse

source

fn ansi_reverse() -> String

#
ansi_show_cursor

source

fn ansi_show_cursor() -> String

#
ansi_underline

source

fn ansi_underline() -> String

#
color_to_256

source

fn color_to_256(color : @mizchi/tui/core.Color
Color) -> Int

#
compute_layout

source

fn compute_layout(node : @mizchi/crater-core/node.Node
Node, width : Int, height : Int) -> @mizchi/crater-core.Layout
Layout

Compute layout using layout tree with character-based viewport

#
compute_layout_max_content

source

fn compute_layout_max_content(node : @mizchi/crater-core/node.Node
Node, width : Int, height : Int) -> @mizchi/crater-core.Layout
Layout

Compute layout in intrinsic (MaxContent) mode. Useful for shrink-wrapped overlays/popups.

#
disable_mouse

source

fn disable_mouse() -> String

#
disable_mouse_all

source

fn disable_mouse_all() -> String

Disable mouse motion tracking

#
enable_mouse

source

fn enable_mouse() -> String

#
enable_mouse_all

source

fn enable_mouse_all() -> String

Enable mouse with motion tracking (reports move events even without button press)

#
render_layout

source

fn render_layout(buf : CharBuffer, layout : @mizchi/crater-core.Layout
Layout, styles : @mizchi/tui/core.RenderStyleMap
RenderStyleMap, texts : @mizchi/tui/core.TextContentMap
TextContentMap, offset_x : Int, offset_y : Int) -> Unit

Render Layout to CharBuffer

#
render_once

source

fn render_once(width : Int, height : Int, component : @mizchi/tui/core.Component
Component) -> String

Simple render function for one-shot rendering (no reactivity)

#
render_to_ansi

source

fn render_to_ansi(layout : @mizchi/crater-core.Layout
Layout, styles : @mizchi/tui/core.RenderStyleMap
RenderStyleMap, texts : @mizchi/tui/core.TextContentMap
TextContentMap, width : Int, height : Int) -> String

Quick render function: Layout -> ANSI string

#
rgb_to_256

source

fn rgb_to_256(r : Int, g : Int, b : Int) -> Int

Convert RGB color to 256-color palette index

#
run_app

source

fn run_app(width : Int, height : Int, render_fn : () -> @mizchi/tui/core.Component
Component, output_fn : (String) -> Unit) -> (() -> Unit)

Full-screen app helper: sets up alt screen and handles cleanup

Source Files

Site source Report issue Packages Build queue Skills Statistics

#App

#App::clear_prev_buffer

#App::create_render_effect

#App::dispatch_click

#App::dispatch_click_from_component

#App::dispatch_click_with_result

#App::dispatch_hover

#App::find_by_id

#App::handle_mouse

#App::hit_test

#App::init_terminal

#App::new

#App::on_click

#App::render

#App::render_frame

#App::render_with_offset

#App::restore_terminal

#CharBuffer

#CharBuffer::clear

#CharBuffer::clone

#CharBuffer::diff_to_ansi

#CharBuffer::diff_to_ansi_offset

#CharBuffer::fill_bg

#CharBuffer::fill_rect

#CharBuffer::get_cell

#CharBuffer::new

#CharBuffer::set_cell

#CharBuffer::to_ansi

#CharBuffer::to_ansi_offset

#CharBuffer::write_text

#CharBuffer::write_text_wrapped

#CharCell

#CharCell::default

#CharCell::from_char

#CharCell::styled

#TextStyle

#TextStyle::default

#ansi_bg_256

#ansi_bg_color

#ansi_bg_reset

#ansi_bold

#ansi_clear_line

#ansi_clear_screen

#ansi_dim

#ansi_enter_alt_screen

#ansi_fg_256

#ansi_fg_black

#ansi_fg_blue

#ansi_fg_color

#ansi_fg_cyan

#ansi_fg_gray

#ansi_fg_green

#ansi_fg_magenta

#ansi_fg_red

#ansi_fg_white

#ansi_fg_yellow

#ansi_full_reset

#ansi_hide_cursor

#ansi_leave_alt_screen

#ansi_move_down

#ansi_move_left

#ansi_move_right

#ansi_move_to

#ansi_move_up

#ansi_reset

#ansi_reset_attrs

#ansi_reverse

#ansi_show_cursor

#ansi_underline

#color_to_256

#compute_layout

#compute_layout_max_content

#disable_mouse

#disable_mouse_all

#enable_mouse

#enable_mouse_all

#render_layout

#render_once

#render_to_ansi

#rgb_to_256

#
App

#
App::clear_prev_buffer

#
App::create_render_effect

#
App::dispatch_click

#
App::dispatch_click_from_component

#
App::dispatch_click_with_result

#
App::dispatch_hover

#
App::find_by_id

#
App::handle_mouse

#
App::hit_test

#
App::init_terminal

#
App::new

#
App::on_click

#
App::render

#
App::render_frame

#
App::render_with_offset

#
App::restore_terminal

#
CharBuffer

#
CharBuffer::clear

#
CharBuffer::clone

#
CharBuffer::diff_to_ansi

#
CharBuffer::diff_to_ansi_offset

#
CharBuffer::fill_bg

#
CharBuffer::fill_rect

#
CharBuffer::get_cell

#
CharBuffer::new

#
CharBuffer::set_cell

#
CharBuffer::to_ansi

#
CharBuffer::to_ansi_offset

#
CharBuffer::write_text

#
CharBuffer::write_text_wrapped

#
CharCell

#
CharCell::default

#
CharCell::from_char

#
CharCell::styled

#
TextStyle

#
TextStyle::default

#
ansi_bg_256

#
ansi_bg_color

#
ansi_bg_reset

#
ansi_bold

#
ansi_clear_line

#
ansi_clear_screen

#
ansi_dim

#
ansi_enter_alt_screen

#
ansi_fg_256

#
ansi_fg_black

#
ansi_fg_blue

#
ansi_fg_color

#
ansi_fg_cyan

#
ansi_fg_gray

#
ansi_fg_green

#
ansi_fg_magenta

#
ansi_fg_red

#
ansi_fg_white

#
ansi_fg_yellow

#
ansi_full_reset

#
ansi_hide_cursor

#
ansi_leave_alt_screen

#
ansi_move_down

#
ansi_move_left

#
ansi_move_right

#
ansi_move_to

#
ansi_move_up

#
ansi_reset

#
ansi_reset_attrs

#
ansi_reverse

#
ansi_show_cursor

#
ansi_underline

#
color_to_256

#
compute_layout

#
compute_layout_max_content

#
disable_mouse

#
disable_mouse_all

#
enable_mouse

#
enable_mouse_all

#
render_layout

#
render_once

#
render_to_ansi

#
rgb_to_256