1. Introduction to Ratatui
  2. 1. Installation
  3. 2. Tutorials
    ❱
    1. 2.1. Hello World
    2. 2.2. Counter App
      ❱
      1. 2.2.1. Single Function
      2. 2.2.2. Multiple Functions
      3. 2.2.3. Multiple Files
        ❱
        1. 2.2.3.1. app.rs
        2. 2.2.3.2. ui.rs
        3. 2.2.3.3. event.rs
        4. 2.2.3.4. tui.rs
        5. 2.2.3.5. update.rs
        6. 2.2.3.6. main.rs
    3. 2.3. JSON Editor
      ❱
      1. 2.3.1. App.rs - Holding application state
      2. 2.3.2. Main.rs - UI loop and event handling
      3. 2.3.3. Ui.rs - Layouts, widgets, frames, oh my!
        ❱
        1. 2.3.3.1. Ui.rs - Main
        2. 2.3.3.2. Ui.rs - Editing
        3. 2.3.3.3. Ui.rs - Exit
      4. 2.3.4. Conclusion
    4. 2.4. Async Counter App
      ❱
      1. 2.4.1. Async KeyEvents
      2. 2.4.2. Async Render
      3. 2.4.3. Introducing Actions
      4. 2.4.4. Async Actions
      5. 2.4.5. Conclusion
    5. 2.5. Stopwatch App
  4. 3. Concepts
    ❱
    1. 3.1. Rendering
      ❱
      1. 3.1.1. Under the hood
    2. 3.2. Layout
    3. 3.3. Application Patterns
      ❱
      1. 3.3.1. The Elm Architecture
      2. 3.3.2. Component Architecture
      3. 3.3.3. Flux Architecture
    4. 3.4. Backends
      ❱
      1. 3.4.1. Comparison
      2. 3.4.2. Raw Mode
      3. 3.4.3. Alternate Screen
      4. 3.4.4. Mouse Capture
    5. 3.5. Event Handling
  5. 4. How To
    ❱
    1. 4.1. Layout UIs
      ❱
      1. 4.1.1. Dynamic Layouts
      2. 4.1.2. Center a Rect
      3. 4.1.3. Collapse Borders
    2. 4.2. Render UIs
      ❱
      1. 4.2.1. Display Text
      2. 4.2.2. Style Text
      3. 4.2.3. Overwrite Regions
    3. 4.3. Use Widgets
      ❱
      1. 4.3.1. Paragraph
      2. 4.3.2. Block
      3. 4.3.3. Custom
    4. 4.4. Develop Applications
      ❱
      1. 4.4.1. CLI arguments
      2. 4.4.2. Configuration Directories
      3. 4.4.3. Logging with Tracing
      4. 4.4.4. Async Terminal and Event handler
      5. 4.4.5. Setup Panic Hooks
      6. 4.4.6. Better Panic Hooks
      7. 4.4.7. Migrate from tui-rs
  6. 5. FAQ
    ❱
    1. 5.1. Duplicate key events
    2. 5.2. tokio / async
    3. 5.3. tui.rs history
  7. 6. Highlights
    ❱
    1. 6.1. v0.24
    2. 6.2. v0.23
    3. 6.3. v0.22
    4. 6.4. v0.21
  8. 7. References
    ❱
    1. 7.1. Showcase
    2. 7.2. Features
  9. 8. Developer Guide
    ❱
    1. 8.1. Ratatui
    2. 8.2. Ratatui Book
    3. 8.3. License
  10. Contributors

Ratatui Book

Use Widgets

  • Paragraph
  • Block