itsscb/ratatui
1
0
Fork 0
mirror of https://github.com/ratatui/ratatui.git synced 2025-09-27 13:01:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
ratatui/ratatui-crossterm/README.md
Josh McKinney 5620e06b1a
docs: add crate organization sections to workspace (#1946) 
Adds summary-level crate organization documentation to all crates
explaining the modular workspace structure and when to use each crate.
Links to ARCHITECTURE.md for detailed information.
2025-06-26 15:36:00 -07:00

1.0 KiB
Raw Blame History

Ratatui-crossterm

This module provides the [CrosstermBackend] implementation for the [Backend] trait. It uses the Crossterm crate to interact with the terminal.

Crate Organization

ratatui-crossterm is part of the Ratatui workspace that was modularized in version 0.30.0. This crate provides the Crossterm backend implementation for Ratatui.

When to use ratatui-crossterm:

  • You need fine-grained control over dependencies
  • Building a widget library that needs backend functionality
  • You want to use only the Crossterm backend without other backends

When to use the main ratatui crate:

  • Building applications (recommended - includes crossterm backend by default)
  • You want the convenience of having everything available

For detailed information about the workspace organization, see ARCHITECTURE.md.