Tuix (tuix v0.1.0)

Tuix is a terminal UI framework for Elixir, inspired by OpenTUI.

Build declarative, component-based TUIs with a LiveView-style programming model: state lives in assigns, events arrive in callbacks, and render/1 describes the UI as a tree of boxes and text. Tuix lays the tree out with a flexbox-subset engine and writes only the terminal cells that changed.

See Tuix.App for the application behaviour and Tuix.Components for the element builders.

Quick start

defmodule Hello do
  use Tuix.App

  @impl true
  def render(_assigns) do
    box border: :rounded, padding: 1 do
      text("Hello, Tuix!", fg: "#00FF00")
    end
  end
end

Tuix.run(Hello)

Summary

Functions

run(module, opts \\ [])

Runs a Tuix.App, blocking the calling process until the app stops.

Functions

run(module, opts \\ [])

@spec run(
  module(),
  keyword()
) :: :ok

Runs a Tuix.App, blocking the calling process until the app stops.

Takes over the terminal (raw mode + alternate screen) and restores it on exit — including crashes.

Options

:exit_on_ctrl_c - stop the app when Ctrl+C is pressed (default true)

All other options are passed through to the app's Tuix.App.mount/2.