10 releases (6 breaking)

new 0.29.0 Nov 1, 2024
0.27.1 Oct 20, 2024
0.26.0 Oct 16, 2024
0.25.1 Oct 13, 2024
0.10.0 Aug 25, 2024

#806 in Command-line interface

Download history 109/week @ 2024-08-22 168/week @ 2024-08-29 306/week @ 2024-09-05 204/week @ 2024-09-12 19/week @ 2024-09-19 19/week @ 2024-09-26 142/week @ 2024-10-03 284/week @ 2024-10-10 421/week @ 2024-10-17 24/week @ 2024-10-24 155/week @ 2024-10-31

923 downloads per month
Used in 3 crates (via rat-widget)

MIT/Apache

490KB
11K SLoC

crates.io Documentation License License

This crate is a part of rat-salsa.

For examples see rat-text GitHub or an extended example mdedit.rs in rat-salsa GitHub.

Text widgets for ratatui

Features for all widgets:

  • Undo/redo

  • Sync another widget

  • Support double-width characters

  • Range based text styling

  • Clipboard trait to link to some clipboard implementation.

    There is no general solution for clipboards but this way you can integrate one of the many crates that try to do this.

  • Builtin scrolling. Uses rat-scrolled.

  • Lots of text manipulation functions.

    • Line/TextRange/byte indexes supported.
    • Glyph iteration (glyph=grapheme+display information)
    • Grapheme iterator/cursor
    • byte-pos to TextPosition and vice versa.
    • Screen position to text position.

TextInput

Single line text input widget.

TextArea

Textarea with tendencies to being an editor.

Uses Rope backend for a good editing experience for longer text. Starts lagging a bit if you have more than 10,000 style ranges or so (wip).

  • Tab width/Tab expand to space.
  • Indent/dedent selection.
  • Newline starts at indent.
  • Mouse selection can work word-wise.
  • Renders this text in ~400µs
  • Add Quotes/Braces/Brackets to selection.

There is an extended example mdedit.rs for TextArea in rat-salsa

MaskedInput

Single line text input with a text-mask for allowed input.

  • Numeric
  • Decimal/Hexadecimal/Octal digits
  • Character/Character+Digits
  • Text separators

Nice to have for structured text input.

The widgets

  • DateInput and
  • NumberInput

use this as base.

DateInput

DateInput with chrono format patterns.

NumberInput

NumberInput with format_num_pattern backend. A bit similar to javas DecimalFormat.

LineNumbers

Line numbers widget that can be combined with TextArea.

Dependencies

~13–22MB
~306K SLoC