rat-text 0.29.5

ratatui text input widgets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

![stable](https://img.shields.io/badge/stability-β--3-850101)
[![crates.io](https://img.shields.io/crates/v/rat-text.svg)](https://crates.io/crates/rat-text)
[![Documentation](https://docs.rs/rat-text/badge.svg)](https://docs.rs/rat-text)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![License](https://img.shields.io/badge/license-APACHE-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![](https://tokei.rs/b1/github/thscharler/rat-salsa)

This crate is a part of [rat-salsa][refRatSalsa].

For examples see [rat-text GitHub][refGitHubText] or an extended example `mdedit.rs` in
[rat-salsa GitHub][refGitHubSalsa].

* [Changes](https://github.com/thscharler/rat-salsa/blob/master/rat-text/changes.md)

# 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][refRatScrolled].

* 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](crate::text_input::TextInput)


Single line text input widget.

## [TextArea](crate::text_area::TextArea)


Textarea with tendencies to being an editor.

Uses [Rope][refRopey] 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][refRatSalsa]

## [MaskedInput](crate::text_input_mask::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](crate::date_input::DateInput)


DateInput with [chrono][refChrono] format patterns.

## [NumberInput](crate::number_input::NumberInput)


NumberInput with [format_num_pattern][refFormatNumPattern]
backend. A bit similar to javas DecimalFormat.

## [LineNumbers](crate::line_number::LineNumbers)


Line numbers widget that can be combined with TextArea.


[refRatSalsa]: https://docs.rs/rat-salsa/latest/rat_salsa/

[refRatScrolled]: https://docs.rs/rat-scrolled/latest/rat_scrolled/

[refRopey]: https://docs.rs/ropey/

[refChrono]: https://docs.rs/chrono

[refFormatNumPattern]: https://docs.rs/format_num_pattern

[refGitHubText]: https://github.com/thscharler/rat-salsa/blob/master/rat-text/examples

[refGitHubSalsa]: https://github.com/thscharler/rat-salsa/tree/master/examples