How do I handle user input like text fields in Ratatouille?

Ratatouille processes terminal events such as key presses via the update/2 callback; for text input, you can capture character events and manage state, as demonstrated in the editor.exs example. However, built-in form elements are limited, so you may need to implement custom logic.

What's the difference between Ratatouille and ex_termbox for Elixir?

Ratatouille builds on ex_termbox but adds a higher-level, declarative DSL and Elm Architecture for state management, whereas ex_termbox provides raw, low-level terminal bindings. Choose Ratatouille for structured apps and ex_termbox for direct control.

Can I build a terminal game with Ratatouille?

Yes, the snake.exs example shows how to create simple games using the update loop and rendering, but performance may be limited for fast-paced games due to the declarative nature and current rendering optimizations listed in the roadmap.

How to style elements with custom colors or attributes in Ratatouille?

Use attributes like color, background, and attributes in element definitions, as shown in the styling section; however, styling is not fully uniform across all elements yet, so check the documentation for limitations.

Is Ratatouille ready for production applications?

It depends on the use case; while it's stable for basic UIs, the immature feature set and complex packaging might be risks for critical production apps, so evaluate based on the roadmap and your needs.

How to package a Ratatouille app as a standalone executable?

Use Distillery with include_erts: true to create a self-contained release, but the process is noted as complex and 'rough around the edges,' requiring careful setup as described in the packaging section.

ratatouille — Elixir Terminal UI Kit

What is ratatouille?

Ratatouille is a declarative terminal UI kit for Elixir that allows developers to build rich text-based terminal applications using an HTML-like DSL. It solves the problem of creating structured, maintainable terminal interfaces by implementing The Elm Architecture for state management and providing a strict, validated view system.

Target Audience

Elixir developers who need to build terminal-based applications, such as CLI tools, monitoring dashboards, or interactive text interfaces, and prefer a declarative, structured approach over imperative drawing libraries.

Value Proposition

Developers choose Ratatouille for its declarative, HTML-like DSL that simplifies UI construction, its strict validation that catches errors early, and its implementation of The Elm Architecture, which brings predictable state management to terminal apps.

A TUI (terminal UI) kit for Elixir

Use Cases

Best For

Building interactive CLI tools with complex user interfaces
Creating terminal-based monitoring dashboards or observability tools
Developing educational or demo applications in Elixir with visual feedback
Prototyping terminal applications quickly using a declarative approach
Implementing text-based games or simulations in the terminal
Building custom Erlang/Elixir observer or debugging tools

Not Ideal For

Projects requiring high-performance, real-time terminal graphics or complex animations
Teams that prefer imperative, low-level control over terminal output without a structured framework
Applications needing a vast library of pre-built, production-ready UI widgets out of the box
Environments where installing Elixir/Erlang runtime is impractical or prohibited

Pros & Cons

Pros

Declarative HTML-like DSL

Provides an intuitive, HTML-like syntax with tags like view, row, and column, making UI construction familiar and reducing boilerplate code, as shown in the counter example.

Predictable State Management

Implements The Elm Architecture with Model-Update-View pattern, ensuring clear state transitions and updates, which fits naturally with Elixir's functional style.

Strict Validation

Enforces well-structured view trees and raises descriptive errors for invalid configurations, catching bugs early and simplifying debugging.

Flexible Styling and Events

Supports text colors, backgrounds, attributes, and handles terminal events like key presses and resizing, enabling rich, interactive UIs without low-level handling.

Cons

Immature Feature Set

The roadmap admits incomplete features like configurable charts and uniform styling support, limiting advanced use cases and requiring custom workarounds.

Complex Packaging

Packaging for distribution is described as 'rough around the edges' and requires additional tools like Distillery for executable releases, adding overhead.

Limited Ecosystem

Only a few projects are listed as using it, indicating a small community, fewer third-party libraries, and less shared knowledge or examples.

Frequently Asked Questions

What is ratatouille?

Target Audience

Value Proposition

Use Cases

Best For

Building interactive CLI tools with complex user interfaces
Creating terminal-based monitoring dashboards or observability tools
Developing educational or demo applications in Elixir with visual feedback
Prototyping terminal applications quickly using a declarative approach
Implementing text-based games or simulations in the terminal
Building custom Erlang/Elixir observer or debugging tools

Not Ideal For

Projects requiring high-performance, real-time terminal graphics or complex animations
Teams that prefer imperative, low-level control over terminal output without a structured framework
Applications needing a vast library of pre-built, production-ready UI widgets out of the box
Environments where installing Elixir/Erlang runtime is impractical or prohibited

Pros & Cons

Pros

Declarative HTML-like DSL

Provides an intuitive, HTML-like syntax with tags like view, row, and column, making UI construction familiar and reducing boilerplate code, as shown in the counter example.

Predictable State Management

Implements The Elm Architecture with Model-Update-View pattern, ensuring clear state transitions and updates, which fits naturally with Elixir's functional style.

Strict Validation

Enforces well-structured view trees and raises descriptive errors for invalid configurations, catching bugs early and simplifying debugging.

Flexible Styling and Events

Supports text colors, backgrounds, attributes, and handles terminal events like key presses and resizing, enabling rich, interactive UIs without low-level handling.

Cons

Immature Feature Set

The roadmap admits incomplete features like configurable charts and uniform styling support, limiting advanced use cases and requiring custom workarounds.

Complex Packaging

Packaging for distribution is described as 'rough around the edges' and requires additional tools like Distillery for executable releases, adding overhead.

Limited Ecosystem

Only a few projects are listed as using it, indicating a small community, fewer third-party libraries, and less shared knowledge or examples.

Frequently Asked Questions

ratatouille

What is ratatouille?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

ratatouille

What is ratatouille?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?