Crate tui_textarea 

tui-textarea-2

tui-textarea-2 is a simple yet powerful text editor widget like in HTML for <a href="https://github.com/ratatui/ratatui">ratatui</a> and <a href="https://github.com/fdehau/tui-rs">tui-rs</a>. Multi-line text editor can be easily put as part of your TUI application.</p> <blockquote> <p>Maintained fork notice: this repository is maintained under <code>srothgan/tui-textarea</code> to keep compatibility updates moving (including ratatui 0.30+ support and maintenance fixes).</p> </blockquote> <p>Since this fork was created, it has added or integrated:</p> <ul> <li>Compatibility updates for current ratatui releases plus Rust 2024 / <code>rust-version = 1.85.0</code></li> <li><code>TextArea::clear()</code> and custom highlight APIs</li> <li>Unicode-aware soft-wrap modes via <code>WrapMode::{None, Word, Glyph, WordOrGlyph}</code></li> <li>Wrapped-line Up/Down cursor navigation that follows visual rows</li> <li>Row measurement via <code>TextAreaMeasure</code>, <code>TextArea::measure()</code>, <code>set_min_rows()</code>, and <code>set_max_rows()</code></li> <li>Bulk whole-buffer replacement via <code>TextArea::set_lines()</code></li> </ul> <p><strong>Features:</strong></p> <ul> <li>Multi-line text editor widget with basic operations (insert/delete characters, auto scrolling, …)</li> <li>Emacs-like shortcuts (<code>C-n</code>/<code>C-p</code>/<code>C-f</code>/<code>C-b</code>, <code>M-f</code>/<code>M-b</code>, <code>C-a</code>/<code>C-e</code>, <code>C-h</code>/<code>C-d</code>, <code>C-k</code>, <code>M-<</code>/<code>M-></code>, …)</li> <li>Undo/Redo</li> <li>Line number</li> <li>Cursor line highlight</li> <li>Unicode-aware soft wrap with visual-line cursor navigation</li> <li>Dynamic row measurement for auto-sizing layouts</li> <li>Bulk content replacement without rebuilding widget configuration</li> <li>Search with regular expressions</li> <li>Text selection</li> <li>Custom highlighted ranges</li> <li>Placeholder and masking support</li> <li>Mouse scrolling</li> <li>Yank support. Paste text deleted with <code>C-k</code>, <code>C-j</code>, …</li> <li>Backend agnostic. <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a>, <a href="https://docs.rs/termion/latest/termion/">termion</a>, <a href="https://docs.rs/termwiz/latest/termwiz/">termwiz</a>, and your own backend are all supported</li> <li>Multiple textarea widgets in the same screen</li> <li>Support both <a href="https://github.com/ratatui/ratatui">ratatui</a> (the fork by community) and <a href="https://github.com/fdehau/tui-rs">tui-rs</a> (the original)</li> </ul> <p><a href="https://docs.rs/tui-textarea-2/latest/tui_textarea/">Documentation</a></p> <h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3> <p>Running <code>cargo run --example</code> in this repository can demonstrate usage of tui-textarea.</p> <h4 id="minimal"><a class="doc-anchor" href="#minimal">§</a><a href="./examples/minimal.rs"><code>minimal</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example minimal</code></pre></div> <p>Minimal usage with <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a> support.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/minimal.gif" width=539 height=172 alt="minimal example"> <h4 id="editor"><a class="doc-anchor" href="#editor">§</a><a href="./examples/editor.rs"><code>editor</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example editor --features search file.txt</code></pre></div> <p>Simple text editor to edit multiple files.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/editor.gif" width=560 height=236 alt="editor example"> <h4 id="single_line"><a class="doc-anchor" href="#single_line">§</a><a href="./examples/single_line.rs"><code>single_line</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example single_line</code></pre></div> <p>Single-line input form with float number validation.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/single_line.gif" width=539 height=92 alt="single line example"> <h4 id="split"><a class="doc-anchor" href="#split">§</a><a href="./examples/split.rs"><code>split</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example split</code></pre></div> <p>Two split textareas in a screen and switch them. An example for multiple textarea instances.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/split.gif" width=539 height=124 alt="multiple textareas example"> <h4 id="variable"><a class="doc-anchor" href="#variable">§</a><a href="./examples/variable.rs"><code>variable</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example variable</code></pre></div> <p>Simple textarea with variable height driven by measured preferred rows.</p> <p>This example now sizes itself from <code>textarea.measure(width).preferred_rows</code>.</p> <h4 id="vim"><a class="doc-anchor" href="#vim">§</a><a href="./examples/vim.rs"><code>vim</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example vim</code></pre></div> <p>Vim-like modal text editor. Vim emulation is implemented as a state machine.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/vim.gif" width=590 height=156 alt="Vim emulation example"> <h4 id="popup_placeholder"><a class="doc-anchor" href="#popup_placeholder">§</a><a href="./examples/popup_placeholder.rs"><code>popup_placeholder</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example popup_placeholder</code></pre></div> <p>Popup textarea with a placeholder text.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/placepop.gif" width=446 height=220 alt="popup textarea with placeholder example"> <h4 id="password"><a class="doc-anchor" href="#password">§</a><a href="./examples/password.rs"><code>password</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example password</code></pre></div> <p>Password input form with masking text with ●.</p> <img src="https://raw.githubusercontent.com/rhysd/ss/master/tui-textarea/password.gif" width=589 height=92 alt="password example"> <h4 id="termion"><a class="doc-anchor" href="#termion">§</a><a href="./examples/termion.rs"><code>termion</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example termion --no-default-features --features=termion</code></pre></div> <p>Minimal usage with <a href="https://docs.rs/termion/latest/termion/">termion</a> support.</p> <h4 id="termwiz"><a class="doc-anchor" href="#termwiz">§</a><a href="./examples/termwiz.rs"><code>termwiz</code></a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo run --example termwiz --no-default-features --features=termwiz</code></pre></div> <p>Minimal usage with <a href="https://docs.rs/termwiz/latest/termwiz/">termwiz</a> support.</p> <h4 id="examples-for-tui-rs-support"><a class="doc-anchor" href="#examples-for-tui-rs-support">§</a>Examples for <a href="https://github.com/fdehau/tui-rs">tui-rs</a> support</h4> <p>All above examples use <a href="https://github.com/ratatui/ratatui">ratatui</a>, but some examples provide tui-rs version. Try <code>tuirs_</code> prefix. In these cases, you need to specify features to use tui-rs and <code>--no-default-features</code> flag explicitly.</p> <div class="example-wrap"><pre class="language-sh"><code># tui-rs version of `minimal` example cargo run --example tuirs_minimal --no-default-features --features=tuirs-crossterm # tui-rs version of `editor` example cargo run --example tuirs_editor --no-default-features --features=tuirs-crossterm,search file.txt # tui-rs version of `termion` example cargo run --example tuirs_termion --no-default-features --features=tuirs-termion</code></pre></div><h3 id="installation"><a class="doc-anchor" href="#installation">§</a>Installation</h3> <p>Add <code>tui-textarea</code> crate to dependencies in your <code>Cargo.toml</code>. This enables crossterm backend support by default.</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] ratatui = "*" tui-textarea = { package = "tui-textarea-2", version = "*" }</code></pre></div> <p>If you need text search with regular expressions, enable <code>search</code> feature. It adds <a href="https://docs.rs/regex/latest/regex/">regex crate</a> as dependency.</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] ratatui = "*" tui-textarea = { package = "tui-textarea-2", version = "*", features = ["search"] }</code></pre></div> <p>If you’re using ratatui with <a href="https://docs.rs/termion/latest/termion/">termion</a> or <a href="https://docs.rs/termwiz/latest/termwiz/">termwiz</a>, enable the <code>termion</code> or <code>termwiz</code> feature instead of <code>crossterm</code> feature.</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] # For termion ratatui = { version = "*", default-features = false, features = ["termion"] } tui-textarea = { package = "tui-textarea-2", version = "*", default-features = false, features = ["termion"] } # For termwiz ratatui = { version = "*", default-features = false, features = ["termwiz"] } tui-textarea = { package = "tui-textarea-2", version = "*", default-features = false, features = ["termwiz"] }</code></pre></div> <p>If you’re using <a href="https://github.com/fdehau/tui-rs">tui-rs</a> instead of <a href="https://github.com/ratatui/ratatui">ratatui</a>, you need to enable features for using tui-rs crate and to disable default features. The following table shows feature names corresponding to the dependencies.</p> <div><table><thead><tr><th></th><th>crossterm</th><th>termion</th><th>termwiz</th><th>Your own backend</th></tr></thead><tbody> <tr><td>ratatui</td><td><code>crossterm</code> (enabled by default)</td><td><code>termion</code></td><td><code>termwiz</code></td><td><code>no-backend</code></td></tr> <tr><td>tui-rs</td><td><code>tuirs-crossterm</code></td><td><code>tuirs-termion</code></td><td>N/A</td><td><code>tuirs-no-backend</code></td></tr> </tbody></table> </div> <p>For example, when you want to use the combination of <a href="https://github.com/fdehau/tui-rs">tui-rs</a> and <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a>,</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] tui = "*" tui-textarea = { package = "tui-textarea-2", version = "*", features = ["tuirs-crossterm"], default-features = false }</code></pre></div> <p>Note that <a href="https://github.com/ratatui/ratatui">ratatui</a> support and <a href="https://github.com/fdehau/tui-rs">tui-rs</a> support are exclusive. When you use <a href="https://github.com/fdehau/tui-rs">tui-rs</a> support, you must disable <a href="https://github.com/ratatui/ratatui">ratatui</a> support by <code>default-features = false</code>.</p> <p>In addition to above dependencies, you also need to install <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a> or <a href="https://docs.rs/termion/latest/termion/">termion</a> or <a href="https://docs.rs/termwiz/latest/termwiz/">termwiz</a> to initialize your application and to receive key inputs. Note that the dependency versions of <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a> crate and <a href="https://docs.rs/termion/latest/termion/">termion</a> crate differ between <a href="https://github.com/ratatui/ratatui">ratatui</a> and <a href="https://github.com/fdehau/tui-rs">tui-rs</a>. Please make sure to use the same version that matches the package you are using. For example, <a href="https://github.com/fdehau/tui-rs">tui-rs</a> depends on <a href="https://docs.rs/crossterm/latest/crossterm/">crossterm</a> v0.2.5 or <a href="https://docs.rs/termion/latest/termion/">termion</a> v1.5 where both crates are older than <a href="https://github.com/ratatui/ratatui">ratatui</a>’s dependencies.</p> <h3 id="minimal-usage"><a class="doc-anchor" href="#minimal-usage">§</a>Minimal Usage</h3> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::TextArea; <span class="kw">use </span>crossterm::event::{Event, read}; <span class="kw">let </span><span class="kw-2">mut </span>term = ratatui::Terminal::new(...); <span class="comment">// Create an empty `TextArea` instance which manages the editor state </span><span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::default(); <span class="comment">// Event loop </span><span class="kw">loop </span>{ term.draw(|f| { <span class="comment">// Get `ratatui::layout::Rect` where the editor should be rendered </span><span class="kw">let </span>rect = ...; <span class="comment">// Render the textarea in terminal screen </span>f.render_widget(<span class="kw-2">&</span>textarea, rect); })<span class="question-mark">?</span>; <span class="kw">if let </span>Event::Key(key) = read()<span class="question-mark">? </span>{ <span class="comment">// Your own key mapping to break the event loop </span><span class="kw">if </span>key.code == KeyCode::Esc { <span class="kw">break</span>; } <span class="comment">// `TextArea::input` can directly handle key events from backends and update the editor state </span>textarea.input(key); } } <span class="comment">// Get text lines as `&[String]` </span><span class="macro">println!</span>(<span class="string">"Lines: {:?}"</span>, textarea.lines());</code></pre></div> <p><code>TextArea</code> is an instance to manage the editor state. By default, it disables line numbers and highlights cursor line with underline.</p> <p><code>&TextArea</code> reference implements ratatui’s <code>Widget</code> trait. Render it on every tick of event loop.</p> <p><code>TextArea::input()</code> receives inputs from tui backends. The method can take key events from backends such as <code>crossterm::event::KeyEvent</code> or <code>termion::event::Key</code> directly if the features are enabled. The method handles default key mappings as well.</p> <p>Default key mappings are as follows:</p> <div><table><thead><tr><th>Mappings</th><th>Description</th></tr></thead><tbody> <tr><td><code>Ctrl+H</code>, <code>Backspace</code></td><td>Delete one character before cursor</td></tr> <tr><td><code>Ctrl+D</code>, <code>Delete</code></td><td>Delete one character next to cursor</td></tr> <tr><td><code>Ctrl+M</code>, <code>Enter</code></td><td>Insert newline</td></tr> <tr><td><code>Ctrl+K</code></td><td>Delete from cursor until the end of line</td></tr> <tr><td><code>Ctrl+J</code></td><td>Delete from cursor until the head of line</td></tr> <tr><td><code>Ctrl+W</code>, <code>Alt+H</code>, <code>Alt+Backspace</code></td><td>Delete one word before cursor</td></tr> <tr><td><code>Alt+D</code>, <code>Alt+Delete</code></td><td>Delete one word next to cursor</td></tr> <tr><td><code>Ctrl+U</code></td><td>Undo</td></tr> <tr><td><code>Ctrl+R</code></td><td>Redo</td></tr> <tr><td><code>Ctrl+C</code>, <code>Copy</code></td><td>Copy selected text</td></tr> <tr><td><code>Ctrl+X</code>, <code>Cut</code></td><td>Cut selected text</td></tr> <tr><td><code>Ctrl+Y</code>, <code>Paste</code></td><td>Paste yanked text</td></tr> <tr><td><code>Ctrl+F</code>, <code>→</code></td><td>Move cursor forward by one character</td></tr> <tr><td><code>Ctrl+B</code>, <code>←</code></td><td>Move cursor backward by one character</td></tr> <tr><td><code>Ctrl+P</code>, <code>↑</code></td><td>Move cursor up by one line</td></tr> <tr><td><code>Ctrl+N</code>, <code>↓</code></td><td>Move cursor down by one line</td></tr> <tr><td><code>Alt+F</code>, <code>Ctrl+→</code></td><td>Move cursor forward by word</td></tr> <tr><td><code>Alt+B</code>, <code>Ctrl+←</code></td><td>Move cursor backward by word</td></tr> <tr><td><code>Alt+]</code>, <code>Alt+P</code>, <code>Ctrl+↑</code></td><td>Move cursor up by paragraph</td></tr> <tr><td><code>Alt+[</code>, <code>Alt+N</code>, <code>Ctrl+↓</code></td><td>Move cursor down by paragraph</td></tr> <tr><td><code>Ctrl+E</code>, <code>End</code>, <code>Ctrl+Alt+F</code>, <code>Ctrl+Alt+→</code></td><td>Move cursor to the end of line</td></tr> <tr><td><code>Ctrl+A</code>, <code>Home</code>, <code>Ctrl+Alt+B</code>, <code>Ctrl+Alt+←</code></td><td>Move cursor to the head of line</td></tr> <tr><td><code>Alt+<</code>, <code>Ctrl+Alt+P</code>, <code>Ctrl+Alt+↑</code></td><td>Move cursor to top of lines</td></tr> <tr><td><code>Alt+></code>, <code>Ctrl+Alt+N</code>, <code>Ctrl+Alt+↓</code></td><td>Move cursor to bottom of lines</td></tr> <tr><td><code>Ctrl+V</code>, <code>PageDown</code></td><td>Scroll down by page</td></tr> <tr><td><code>Alt+V</code>, <code>PageUp</code></td><td>Scroll up by page</td></tr> </tbody></table> </div> <p>Deleting multiple characters at once saves the deleted text to yank buffer. It can be pasted with <code>Ctrl+Y</code> later.</p> <p>If you don’t want to use default key mappings, see the ‘Advanced Usage’ section.</p> <h3 id="basic-usage"><a class="doc-anchor" href="#basic-usage">§</a>Basic Usage</h3><h4 id="create-textarea-instance-with-text"><a class="doc-anchor" href="#create-textarea-instance-with-text">§</a>Create <code>TextArea</code> instance with text</h4> <p><code>TextArea</code> implements <code>Default</code> trait to create an editor instance with an empty text.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::default();</code></pre></div> <p><code>TextArea::new()</code> creates an editor instance with text lines passed as <code>Vec<String></code>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>lines: Vec<String> = ...; <span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::new(lines);</code></pre></div> <p><code>TextArea</code> implements <code>From<impl Iterator<Item=impl Into<String>>></code>. <code>TextArea::from()</code> can create an editor instance from any iterators whose elements can be converted to <code>String</code>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// Create `TextArea` from from `[&str]` </span><span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::from([ <span class="string">"this is first line"</span>, <span class="string">"this is second line"</span>, <span class="string">"this is third line"</span>, ]); <span class="comment">// Create `TextArea` from `String` </span><span class="kw">let </span><span class="kw-2">mut </span>text: String = ...; <span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::from(text.lines());</code></pre></div> <p><code>TextArea</code> also implements <code>FromIterator<impl Into<String>></code>. <code>Iterator::collect()</code> can collect strings as an editor instance. This allows to create <code>TextArea</code> reading lines from file efficiently using <code>io::BufReader</code>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>file = fs::File::open(path)<span class="question-mark">?</span>; <span class="kw">let </span><span class="kw-2">mut </span>textarea: TextArea = io::BufReader::new(file).lines().collect::<io::Result<<span class="kw">_</span>>>()<span class="question-mark">?</span>;</code></pre></div><h4 id="get-text-contents-from-textarea"><a class="doc-anchor" href="#get-text-contents-from-textarea">§</a>Get text contents from <code>TextArea</code></h4> <p><code>TextArea::lines()</code> returns text lines as <code>&[String]</code>. It borrows text contents temporarily.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>text: String = textarea.lines().join(<span class="string">"\n"</span>);</code></pre></div> <p><code>TextArea::into_lines()</code> moves <code>TextArea</code> instance into text lines as <code>Vec<String></code>. This can retrieve the text contents without any copy.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>lines: Vec<String> = textarea.into_lines();</code></pre></div> <p>Note that <code>TextArea</code> always contains at least one line. For example, an empty text means one empty line. This is because any text file must end with newline.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>textarea = TextArea::default(); <span class="macro">assert_eq!</span>(textarea.into_lines(), [<span class="string">""</span>]);</code></pre></div><h4 id="replace-all-text-while-preserving-configuration"><a class="doc-anchor" href="#replace-all-text-while-preserving-configuration">§</a>Replace all text while preserving configuration</h4> <p>When you want to replace the whole buffer without rebuilding <code>TextArea</code> and reapplying styles/configuration, use <code>TextArea::set_lines()</code>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::default(); textarea.set_placeholder_text(<span class="string">"Type here"</span>); textarea.set_line_number_style(ratatui::style::Style::default()); textarea.set_lines( <span class="macro">vec!</span>[<span class="string">"hello"</span>.to_string(), <span class="string">"world"</span>.to_string()], (<span class="number">1</span>, <span class="number">5</span>), );</code></pre></div> <p><code>set_lines()</code> preserves widget configuration such as styles, wrapping, placeholder, and history capacity, while resetting content-specific state such as undo/redo contents, active selection, custom highlights, viewport scroll, and cached measurement results.</p> <h4 id="show-line-number"><a class="doc-anchor" href="#show-line-number">§</a>Show line number</h4> <p>By default, <code>TextArea</code> does not show line numbers. To enable, set a style for rendering line numbers by <code>TextArea::set_line_number_style()</code>. For example, the following renders line numbers in dark gray background color.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ratatui::style::{Style, Color}; <span class="kw">let </span>style = Style::default().bg(Color::DarkGray); textarea.set_line_number_style(style);</code></pre></div><h4 id="configure-cursor-line-style"><a class="doc-anchor" href="#configure-cursor-line-style">§</a>Configure cursor line style</h4> <p>By default, <code>TextArea</code> renders the line at cursor with underline so that users can easily notice where the current line is. To change the style of cursor line, use <code>TextArea::set_cursor_line_style()</code>. For example, the following styles the cursor line with bold text.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ratatui::style::{Style, Modifier}; <span class="kw">let </span>style = Style::default().add_modifier(Modifier::BOLD); textarea.set_cursor_line_style(style);</code></pre></div> <p>To disable cursor line style, set the default style as follows:</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ratatui::style::{Style, Modifier}; textarea.set_cursor_line_style(Style::default());</code></pre></div><h4 id="configure-tab-width"><a class="doc-anchor" href="#configure-tab-width">§</a>Configure tab width</h4> <p>The default tab width is 4. To change it, use <code>TextArea::set_tab_length()</code> method. The following sets 2 to tab width. Typing tab key inserts 2 spaces.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code>textarea.set_tab_length(<span class="number">2</span>);</code></pre></div><h4 id="configure-soft-wrap-mode"><a class="doc-anchor" href="#configure-soft-wrap-mode">§</a>Configure soft wrap mode</h4> <p>By default, soft wrapping is disabled and long lines are handled by horizontal scrolling. To enable soft wrapping, set <code>TextArea::set_wrap_mode()</code> with one of the supported modes.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::WrapMode; textarea.set_wrap_mode(WrapMode::WordOrGlyph);</code></pre></div> <p>Supported modes:</p> <ul> <li><code>WrapMode::None</code>: Disable soft wrap (default behavior).</li> <li><code>WrapMode::Word</code>: Wrap only at word boundaries.</li> <li><code>WrapMode::Glyph</code>: Wrap at grapheme boundaries.</li> <li><code>WrapMode::WordOrGlyph</code>: Wrap at word boundaries with grapheme fallback for long words.</li> </ul> <p>When wrapping is enabled, <code>CursorMove::Up</code> and <code>CursorMove::Down</code> follow visual rows instead of jumping only between logical lines.</p> <h4 id="measure-preferred-height"><a class="doc-anchor" href="#measure-preferred-height">§</a>Measure preferred height</h4> <p><code>TextArea::measure(width_cols)</code> returns a <code>TextAreaMeasure</code> with row counts for the current content and layout. This is useful when your textarea should grow and shrink with wrapped content.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::{TextArea, WrapMode}; <span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::from([<span class="string">"hello world"</span>]); textarea.set_wrap_mode(WrapMode::WordOrGlyph); textarea.set_min_rows(<span class="number">3</span>); textarea.set_max_rows(<span class="number">10</span>); <span class="kw">let </span>measured = textarea.measure(<span class="number">12</span>); <span class="kw">let </span>content_rows = measured.content_rows; <span class="kw">let </span>height = measured.preferred_rows;</code></pre></div> <p><code>content_rows</code> counts the rows needed by the inner content area. <code>preferred_rows</code> includes block chrome such as borders and respects the configured <code>min_rows</code> and <code>max_rows</code>.</p> <h4 id="add-custom-highlighted-ranges"><a class="doc-anchor" href="#add-custom-highlighted-ranges">§</a>Add custom highlighted ranges</h4> <p>You can draw your own highlighted ranges on top of the content with <code>TextArea::custom_highlight()</code>. This is useful for syntax annotations, diffs, or app-specific match highlighting.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ratatui::style::{Color, Style}; textarea.custom_highlight( ((<span class="number">0</span>, <span class="number">0</span>), (<span class="number">0</span>, <span class="number">5</span>)), Style::default().bg(Color::Yellow), <span class="number">10</span>, );</code></pre></div> <p>Call <code>TextArea::clear_custom_highlight()</code> to remove all custom highlighted ranges.</p> <h4 id="configure-max-history-size"><a class="doc-anchor" href="#configure-max-history-size">§</a>Configure max history size</h4> <p>By default, past 50 modifications are stored as edit history. The history is used for undo/redo. To change how many past edits are remembered, use <code>TextArea::set_max_histories()</code> method. The following remembers past 1000 changes.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code>textarea.set_max_histories(<span class="number">1000</span>);</code></pre></div> <p>Setting 0 disables undo/redo.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code>textarea.set_max_histories(<span class="number">0</span>);</code></pre></div><h4 id="text-search-with-regular-expressions"><a class="doc-anchor" href="#text-search-with-regular-expressions">§</a>Text search with regular expressions</h4> <p>To search text in textarea, set a regular expression pattern with <code>TextArea::set_search_pattern()</code> and move cursor with <code>TextArea::search_forward()</code> for forward search or <code>TextArea::search_back()</code> backward search. The regular expression is handled by <a href="https://docs.rs/regex/latest/regex/"><code>regex</code> crate</a>.</p> <p>Text search wraps around the textarea. When searching forward and no match found until the end of textarea, it searches the pattern from start of the file.</p> <p>Matches are highlighted in textarea. The text style to highlight matches can be changed with <code>TextArea::set_search_style()</code>. Setting an empty string to <code>TextArea::set_search_pattern()</code> stops the text search.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// Start text search matching to "hello" or "hi". This highlights matches in textarea but does not move cursor. // `regex::Error` is returned on invalid pattern. </span>textarea.set_search_pattern(<span class="string">"(hello|hi)"</span>).unwrap(); textarea.search_forward(<span class="bool-val">false</span>); <span class="comment">// Move cursor to the next match </span>textarea.search_back(<span class="bool-val">false</span>); <span class="comment">// Move cursor to the previous match // Setting empty string stops the search </span>textarea.set_search_pattern(<span class="string">""</span>).unwrap();</code></pre></div> <p>No UI is provided for text search. You need to provide your own UI to input search query. It is recommended to use another <code>TextArea</code> for search form. To build a single-line input form, see ‘Single-line input like <code><input></code> in HTML’ in ‘Advanced Usage’ section below.</p> <p><a href="./examples/editor.rs"><code>editor</code> example</a> implements a text search with search form built on <code>TextArea</code>. See the implementation for working example.</p> <p>To use text search, <code>search</code> feature needs to be enabled in your <code>Cargo.toml</code>. It is disabled by default to avoid depending on <code>regex</code> crate until it is necessary.</p> <div class="example-wrap"><pre class="language-toml"><code>tui-textarea = { package = "tui-textarea-2", version = "*", features = ["search"] }</code></pre></div><h3 id="advanced-usage"><a class="doc-anchor" href="#advanced-usage">§</a>Advanced Usage</h3><h4 id="single-line-input-like-input-in-html"><a class="doc-anchor" href="#single-line-input-like-input-in-html">§</a>Single-line input like <code><input></code> in HTML</h4> <p>To use <code>TextArea</code> for a single-line input widget like <code><input></code> in HTML, ignore all key mappings which inserts newline.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossterm::event::{Event, read}; <span class="kw">use </span>tui_textarea::{Input, Key}; <span class="kw">let </span>default_text: <span class="kw-2">&</span>str = ...; <span class="kw">let </span>default_text = default_text.replace(<span class="kw-2">&</span>[<span class="string">'\n'</span>, <span class="string">'\r'</span>], <span class="string">" "</span>); <span class="comment">// Ensure no new line is contained </span><span class="kw">let </span><span class="kw-2">mut </span>textarea = TextArea::new(<span class="macro">vec!</span>[default_text]); <span class="comment">// Event loop </span><span class="kw">loop </span>{ <span class="comment">// ... // Using `Input` is not mandatory, but it's useful for pattern match // Ignore Ctrl+m and Enter. Otherwise handle keys as usual </span><span class="kw">match </span>read()<span class="question-mark">?</span>.into() { Input { key: Key::Char(<span class="string">'m'</span>), ctrl: <span class="bool-val">true</span>, alt: <span class="bool-val">false </span>} | Input { key: Key::Enter, .. } => <span class="kw">continue</span>, input => { textarea.input(input); } } } <span class="kw">let </span>text = textarea.into_lines().remove(<span class="number">0</span>); <span class="comment">// Get input text</span></code></pre></div> <p>See <a href="./examples/single_line.rs"><code>single_line</code> example</a> for working example.</p> <h4 id="define-your-own-key-mappings"><a class="doc-anchor" href="#define-your-own-key-mappings">§</a>Define your own key mappings</h4> <p>All editor operations are defined as public methods of <code>TextArea</code>. To move cursor, use <code>tui_textarea::CursorMove</code> to notify how to move the cursor.</p> <div><table><thead><tr><th>Method</th><th>Operation</th></tr></thead><tbody> <tr><td><code>textarea.delete_char()</code></td><td>Delete one character before cursor</td></tr> <tr><td><code>textarea.delete_next_char()</code></td><td>Delete one character next to cursor</td></tr> <tr><td><code>textarea.insert_newline()</code></td><td>Insert newline</td></tr> <tr><td><code>textarea.delete_line_by_end()</code></td><td>Delete from cursor until the end of line</td></tr> <tr><td><code>textarea.delete_line_by_head()</code></td><td>Delete from cursor until the head of line</td></tr> <tr><td><code>textarea.delete_word()</code></td><td>Delete one word before cursor</td></tr> <tr><td><code>textarea.delete_next_word()</code></td><td>Delete one word next to cursor</td></tr> <tr><td><code>textarea.clear()</code></td><td>Clear all text</td></tr> <tr><td><code>textarea.undo()</code></td><td>Undo</td></tr> <tr><td><code>textarea.redo()</code></td><td>Redo</td></tr> <tr><td><code>textarea.copy()</code></td><td>Copy selected text</td></tr> <tr><td><code>textarea.cut()</code></td><td>Cut selected text</td></tr> <tr><td><code>textarea.paste()</code></td><td>Paste yanked text</td></tr> <tr><td><code>textarea.insert_char(c)</code></td><td>Insert one character</td></tr> <tr><td><code>textarea.insert_str(text)</code></td><td>Insert a string</td></tr> <tr><td><code>textarea.insert_tab()</code></td><td>Insert indentation / tab text</td></tr> <tr><td><code>textarea.delete_str(chars)</code></td><td>Delete multiple characters</td></tr> <tr><td><code>textarea.start_selection()</code></td><td>Start text selection</td></tr> <tr><td><code>textarea.cancel_selection()</code></td><td>Cancel text selection</td></tr> <tr><td><code>textarea.select_all()</code></td><td>Select entire text</td></tr> <tr><td><code>textarea.custom_highlight(range, style, priority)</code></td><td>Add a custom highlighted range</td></tr> <tr><td><code>textarea.clear_custom_highlight()</code></td><td>Clear all custom highlights</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Forward)</code></td><td>Move cursor forward by one character</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Back)</code></td><td>Move cursor backward by one character</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Up)</code></td><td>Move cursor up by one line</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Down)</code></td><td>Move cursor down by one line</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::WordForward)</code></td><td>Move cursor forward by word</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::WordEnd)</code></td><td>Move cursor to next end of word</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::WordBack)</code></td><td>Move cursor backward by word</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::ParagraphForward)</code></td><td>Move cursor up by paragraph</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::ParagraphBack)</code></td><td>Move cursor down by paragraph</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::End)</code></td><td>Move cursor to the end of line</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Head)</code></td><td>Move cursor to the head of line</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Top)</code></td><td>Move cursor to top of lines</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Bottom)</code></td><td>Move cursor to bottom of lines</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::Jump(row, col))</code></td><td>Move cursor to (row, col) position</td></tr> <tr><td><code>textarea.move_cursor(CursorMove::InViewport)</code></td><td>Move cursor to stay in the viewport</td></tr> <tr><td><code>textarea.set_search_pattern(pattern)</code></td><td>Set a pattern for text search</td></tr> <tr><td><code>textarea.search_forward(match_cursor)</code></td><td>Move cursor to next match of text search</td></tr> <tr><td><code>textarea.search_back(match_cursor)</code></td><td>Move cursor to previous match of text search</td></tr> <tr><td><code>textarea.scroll(Scrolling::PageDown)</code></td><td>Scroll down the viewport by page</td></tr> <tr><td><code>textarea.scroll(Scrolling::PageUp)</code></td><td>Scroll up the viewport by page</td></tr> <tr><td><code>textarea.scroll(Scrolling::HalfPageDown)</code></td><td>Scroll down the viewport by half-page</td></tr> <tr><td><code>textarea.scroll(Scrolling::HalfPageUp)</code></td><td>Scroll up the viewport by half-page</td></tr> <tr><td><code>textarea.scroll((row, col))</code></td><td>Scroll down the viewport to (row, col) position</td></tr> </tbody></table> </div> <p>To define your own key mappings, simply call the above methods in your code instead of <code>TextArea::input()</code> method.</p> <p>Useful state/configuration helpers:</p> <div><table><thead><tr><th>Method</th><th>Purpose</th></tr></thead><tbody> <tr><td><code>textarea.cursor()</code></td><td>Get current <code>(row, col)</code> cursor position</td></tr> <tr><td><code>textarea.selection_range()</code></td><td>Get the current selected range if selection is active</td></tr> <tr><td><code>textarea.is_selecting()</code></td><td>Check whether selection is active</td></tr> <tr><td><code>textarea.lines()</code></td><td>Borrow the current text lines</td></tr> <tr><td><code>textarea.set_lines(lines, cursor)</code></td><td>Replace the entire buffer while preserving widget settings</td></tr> <tr><td><code>textarea.set_wrap_mode(mode)</code></td><td>Configure soft wrapping</td></tr> <tr><td><code>textarea.wrap_mode()</code></td><td>Read the current wrap mode</td></tr> <tr><td><code>textarea.set_min_rows(rows)</code></td><td>Set the minimum preferred measured height</td></tr> <tr><td><code>textarea.min_rows()</code></td><td>Read the configured minimum preferred height</td></tr> <tr><td><code>textarea.set_max_rows(rows)</code></td><td>Set the maximum preferred measured height</td></tr> <tr><td><code>textarea.max_rows()</code></td><td>Read the configured maximum preferred height</td></tr> <tr><td><code>textarea.measure(width_cols)</code></td><td>Measure content and preferred outer height</td></tr> <tr><td><code>textarea.set_block(block)</code></td><td>Configure block chrome used for rendering and measurement</td></tr> <tr><td><code>textarea.remove_block()</code></td><td>Remove block chrome</td></tr> <tr><td><code>textarea.set_line_number_style(style)</code></td><td>Enable or restyle line numbers</td></tr> <tr><td><code>textarea.remove_line_number()</code></td><td>Disable line numbers</td></tr> <tr><td><code>textarea.set_placeholder_text(text)</code></td><td>Set or disable placeholder text</td></tr> <tr><td><code>textarea.set_placeholder_style(style)</code></td><td>Change placeholder style</td></tr> <tr><td><code>textarea.set_mask_char(ch)</code></td><td>Enable character masking</td></tr> <tr><td><code>textarea.clear_mask_char()</code></td><td>Disable character masking</td></tr> <tr><td><code>textarea.clear()</code></td><td>Clear the full buffer</td></tr> </tbody></table> </div> <p>See the <a href="./examples/vim.rs"><code>vim</code> example</a> for working example. It implements more Vim-like key modal mappings.</p> <p>If you don’t want to use default key mappings, <code>TextArea::input_without_shortcuts()</code> method can be used instead of <code>TextArea::input()</code>. The method only handles very basic operations such as inserting/deleting single characters, tabs, newlines.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">match </span>read()<span class="question-mark">?</span>.into() { <span class="comment">// Handle your own key mappings here // ... </span>input => textarea.input_without_shortcuts(input), }</code></pre></div><h4 id="use-your-own-backend"><a class="doc-anchor" href="#use-your-own-backend">§</a>Use your own backend</h4> <p>ratatui and tui-rs allows to make your own backend by implementing <a href="https://docs.rs/ratatui/latest/ratatui/backend/trait.Backend.html"><code>ratatui::backend::Backend</code></a> trait. tui-textarea supports it as well. Please use <code>no-backend</code> feature for <a href="https://github.com/ratatui/ratatui">ratatui</a> or <code>tuirs-no-backend</code> feature for <a href="https://github.com/fdehau/tui-rs">tui-rs</a>. They avoid adding backend crates (crossterm, termion, or termwiz) since you’re using your own backend.</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] # For ratatui tui-textarea = { package = "tui-textarea-2", version = "*", default-features = false, features = ["no-backend"] } # For tui-rs tui-textarea = { package = "tui-textarea-2", version = "*", default-features = false, features = ["tuirs-no-backend"] }</code></pre></div> <p><code>tui_textarea::Input</code> is a type for backend-agnostic key input. What you need to do is converting key event in your own backend into the <code>tui_textarea::Input</code> instance. Then <code>TextArea::input()</code> method can handle the input as other backend.</p> <p>In the following example, let’s say <code>your_backend::KeyDown</code> is a key event type for your backend and <code>your_backend::read_next_key()</code> returns the next key event.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// In your backend implementation </span><span class="kw">pub enum </span>KeyDown { Char(char), BS, Del, Esc, <span class="comment">// ... </span>} <span class="comment">// Return tuple of (key, ctrlkey, altkey) </span><span class="kw">pub fn </span>read_next_key() -> (KeyDown, bool, bool) { <span class="comment">// ... </span>}</code></pre></div> <p>Then you can implement the logic to convert <code>your_backend::KeyDown</code> value into <code>tui_textarea::Input</code> value.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::{Input, Key}; <span class="kw">use </span>your_backend::KeyDown; <span class="kw">fn </span>keydown_to_input(key: KeyDown, ctrl: bool, alt: bool) -> Input { <span class="kw">match </span>key { KeyDown::Char(c) => Input { key: Key::Char(c), ctrl, alt }, KeyDown::BS => Input { key: Key::Backspace, ctrl, alt }, KeyDown::Del => Input { key: Key::Delete, ctrl, alt }, KeyDown::Esc => Input { key: Key::Esc, ctrl, alt }, <span class="comment">// ... </span><span class="kw">_ </span>=> Input::default(), } }</code></pre></div> <p>For the keys which are not handled by tui-textarea, <code>tui_textarea::Input::default()</code> is available. It returns ‘null’ key. An editor will do nothing with the key.</p> <p>Finally, convert your own backend’s key input type into <code>tui_textarea::Input</code> and pass it to <code>TextArea::input()</code>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>textarea = ...; <span class="comment">// Event loop </span><span class="kw">loop </span>{ <span class="comment">// ... </span><span class="kw">let </span>(key, ctrl, alt) = your_backend::read_next_key(); <span class="kw">if </span>key == your_backend::KeyDown::Esc { <span class="kw">break</span>; <span class="comment">// For example, quit your app on pressing Esc </span>} textarea.input(keydown_to_input(key, ctrl, alt)); }</code></pre></div><h4 id="put-multiple-textarea-instances-in-screen"><a class="doc-anchor" href="#put-multiple-textarea-instances-in-screen">§</a>Put multiple <code>TextArea</code> instances in screen</h4> <p>You don’t need to do anything special. Create multiple <code>TextArea</code> instances and render widgets built from each instances.</p> <p>The following is an example to put two textarea widgets in application and manage the focus.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::{TextArea, Input, Key}; <span class="kw">use </span>crossterm::event::{Event, read}; <span class="kw">let </span>editors = <span class="kw-2">&mut </span>[ TextArea::default(), TextArea::default(), ]; <span class="kw">let </span><span class="kw-2">mut </span>focused = <span class="number">0</span>; <span class="kw">loop </span>{ term.draw(|f| { <span class="kw">let </span>rects = ...; <span class="kw">for </span>(editor, rect) <span class="kw">in </span>editors.iter().zip(rects.into_iter()) { f.render_widget(editor, rect); } })<span class="question-mark">?</span>; <span class="kw">match </span>read()<span class="question-mark">?</span>.into() { <span class="comment">// Switch focused textarea by Ctrl+S </span>Input { key: Key::Char(<span class="string">'s'</span>), ctrl: <span class="bool-val">true</span>, .. } => focused = (focused + <span class="number">1</span>) % <span class="number">2</span>; <span class="comment">// Handle input by the focused editor </span>input => editors[focused].input(input), } }</code></pre></div> <p>See <a href="./examples/split.rs"><code>split</code> example</a> and <a href="./examples/editor.rs"><code>editor</code> example</a> for working example.</p> <h4 id="serializationdeserialization-support"><a class="doc-anchor" href="#serializationdeserialization-support">§</a>Serialization/Deserialization support</h4> <p>This crate optionally supports <a href="https://crates.io/crates/serde">serde</a> crate by enabling <code>serde</code> feature.</p> <div class="example-wrap"><pre class="language-toml"><code>[dependencies] tui-textarea = { package = "tui-textarea-2", version = "*", features = ["serde"] }</code></pre></div> <p>Values of the following types can be serialized/deserialized:</p> <ul> <li><code>Key</code></li> <li><code>Input</code></li> <li><code>CursorMove</code></li> <li><code>Scrolling</code></li> <li><code>WrapMode</code></li> </ul> <p>Here is an example for deserializing key input from JSON using <a href="https://crates.io/crates/serde_json">serde_json</a>.</p> <div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tui_textarea::Input; <span class="kw">let </span>json = <span class="string">r#" { "key": { "Char": "a" }, "ctrl": true, "alt": false, "shift": true } "#</span>; <span class="kw">let </span>input: Input = serde_json::from_str(json).unwrap(); <span class="macro">println!</span>(<span class="string">"{input:?}"</span>); <span class="comment">// Input { // key: Key::Char('a'), // ctrl: true, // alt: false, // shift: true, // }</span></code></pre></div><h3 id="minimum-supported-rust-version"><a class="doc-anchor" href="#minimum-supported-rust-version">§</a>Minimum Supported Rust Version</h3> <p>MSRV of this crate is Rust 1.85.0 because the crate uses Rust 2024 edition.</p> <p>If you enable older <code>tui-rs</code> integration features, you still need dependency versions compatible with that backend stack, but the crate itself now targets Rust 1.85.0.</p> <h3 id="versioning"><a class="doc-anchor" href="#versioning">§</a>Versioning</h3> <p>This crate is not reaching v1.0.0 yet. There is no plan to bump the major version for now. Current versioning policy is as follows:</p> <ul> <li>Major: Fixed to 0</li> <li>Minor: Bump on breaking change</li> <li>Patch: Bump on new feature or bug fix</li> </ul> <h3 id="contributing-to-tui-textarea-2"><a class="doc-anchor" href="#contributing-to-tui-textarea-2">§</a>Contributing to tui-textarea-2</h3> <p>This project is developed <a href="https://github.com/srothgan/tui-textarea">on GitHub</a>.</p> <p>For feature requests or bug reports, please <a href="https://github.com/srothgan/tui-textarea/issues/new">create an issue</a>. For submitting patches, please <a href="https://github.com/srothgan/tui-textarea/pulls">create a pull request</a>.</p> <p>Please read <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a> before reporting an issue or making a PR.</p> <h3 id="license"><a class="doc-anchor" href="#license">§</a>License</h3> <p>tui-textarea-2 is distributed under <a href="./LICENSE">The MIT License</a>.</p> </div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Input.html" title="struct tui_textarea::Input">Input</a></dt><dd>Backend-agnostic key input type.</dd><dt><a class="struct" href="struct.TextArea.html" title="struct tui_textarea::TextArea">Text<wbr>Area</a></dt><dd>A type to manage state of textarea. These are some important methods:</dd><dt><a class="struct" href="struct.TextAreaMeasure.html" title="struct tui_textarea::TextAreaMeasure">Text<wbr>Area<wbr>Measure</a></dt><dd>Measured textarea height information for a given width.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CursorMove.html" title="enum tui_textarea::CursorMove">Cursor<wbr>Move</a></dt><dd>Specify how to move the cursor.</dd><dt><a class="enum" href="enum.Key.html" title="enum tui_textarea::Key">Key</a></dt><dd>Backend-agnostic key input kind.</dd><dt><a class="enum" href="enum.Scrolling.html" title="enum tui_textarea::Scrolling">Scrolling</a></dt><dd>Specify how to scroll the textarea.</dd><dt><a class="enum" href="enum.WrapMode.html" title="enum tui_textarea::WrapMode">Wrap<wbr>Mode</a></dt><dd>Specify how logical lines are soft-wrapped at render time.</dd></dl></section></div></main></body></html>