pub struct TextArea { /* private fields */ }Expand description
A multi-line text editor. It edits the text in a shared signal as a
TextInput does, and takes the focus the same
ways. Enter breaks the line, and Ctrl+Enter runs
on_accept. Up and Down move by line, keeping the
caret’s place across, Home and End go to the ends of the line as it
is wrapped, Ctrl+Home and Ctrl+End to the ends of the text, and
PageUp and PageDown by the height of the ScrollView
around it, or 10 lines. Tab types a tab, drawn four spaces wide, and
Shift+Tab and Ctrl+Tab move the focus back and on.
The area is as tall as its lines, at least one. Put it in a
ScrollView to cap its height; when the caret leaves the view, the
view scrolls the least that shows it.
use crabshell_ui::{Cx, ScrollView, Style, TextArea};
fn note(cx: &Cx) -> ScrollView {
let text = cx.signal(String::new());
ScrollView::new(TextArea::new(text).placeholder("Write a note"))
.style(Style::new().height(120.0))
}Implementations§
Source§impl TextArea
impl TextArea
Sourcepub fn placeholder(self, text: impl IntoProp<String>) -> TextArea
pub fn placeholder(self, text: impl IntoProp<String>) -> TextArea
Sets the text shown, dimmed, while the area is empty.
Sourcepub fn max_length(self, max: impl IntoProp<Option<usize>>) -> TextArea
pub fn max_length(self, max: impl IntoProp<Option<usize>>) -> TextArea
Lets the area hold at most max characters, a line break counting
as one, or any number with None, the default. Typing, pasting and
an input method stop there, cutting what they bring between
graphemes. Text set from outside, or already there when the limit
drops, is cut to it, and the cut text is written back to the signal.
Sourcepub fn read_only(self, on: impl IntoProp<bool>) -> TextArea
pub fn read_only(self, on: impl IntoProp<bool>) -> TextArea
While on, off by default, the area takes no edits: typing, Enter
and Tab, deleting, cutting, pasting and input methods leave it
alone, and their keys go on to the window’s on_key. The caret,
selection and Ctrl+C still work, Ctrl+Enter still runs on_accept,
and text set from outside still shows.
Sourcepub fn selection_color(self, color: impl IntoProp<Option<Color>>) -> TextArea
pub fn selection_color(self, color: impl IntoProp<Option<Color>>) -> TextArea
Sets the color the selection is drawn in behind the text. By
default, or with None, it is the text’s color at a third of its
alpha.
Sourcepub fn selected_text_color(
self,
color: impl IntoProp<Option<Color>>,
) -> TextArea
pub fn selected_text_color( self, color: impl IntoProp<Option<Color>>, ) -> TextArea
Sets the color the selected text is drawn in, over any span or
link color. By default, or with None, it keeps its own color.
Underlines and strikethroughs keep theirs.
Sourcepub fn focus(self, focus: impl IntoProp<bool>) -> TextArea
pub fn focus(self, focus: impl IntoProp<bool>) -> TextArea
Takes the keyboard focus whenever this turns true.
Sourcepub fn wrap(self, wrap: impl IntoProp<bool>) -> TextArea
pub fn wrap(self, wrap: impl IntoProp<bool>) -> TextArea
When on, the default, lines wrap at words to the area’s width, 200
unless its style sets one. Off, each line is as long as it is and
the area as wide as its longest, so a sideways ScrollView scrolls
it.
Sourcepub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextArea
pub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextArea
Runs handler with the text when Ctrl+Enter is pressed in the area.
Sourcepub fn style(self, style: impl IntoProp<Style>) -> TextArea
pub fn style(self, style: impl IntoProp<Style>) -> TextArea
Sets the style. An area cuts its text to the inside of its border.
Its text takes the font, color, alignment, line height and
decorations it inherits or sets, as a Text does.
Sourcepub fn visible(self, visible: impl IntoProp<bool>) -> Self
pub fn visible(self, visible: impl IntoProp<bool>) -> Self
Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.
Sourcepub fn geometry(self, geometry: Signal<Rect>) -> Self
pub fn geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is: after each layout that moves or
resizes it, its laid-out rectangle in the window’s logical
pixels, scrolled with any scroll view around it but not moved by
a style’s translate, scale or rotate, is written to geometry. A
hidden widget writes nothing. An effect that reads it may change
the layout: the window is laid out again at once, until nothing
moves.
Sourcepub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.
Sourcepub fn accessible_name(self, name: impl IntoProp<String>) -> Self
pub fn accessible_name(self, name: impl IntoProp<String>) -> Self
What a screen reader calls the widget, instead of what it shows: a button’s text, a text’s own, or a field’s placeholder. An icon button needs one to be read at all.
Sourcepub fn mask_region(self, region: impl IntoProp<Option<Region>>) -> Self
pub fn mask_region(self, region: impl IntoProp<Option<Region>>) -> Self
Keeps the widget and everything inside it only within region,
given in the widget’s own logical pixels from its top-left
corner, with antialiased edges and rounded corners. Nothing shows
outside the widget’s box, as with a style’s
mask, and both apply when both are set.
None, the default, keeps it all.
It changes only what is drawn: the pointer still hits the whole
widget, so a click in a hole reaches it. A window’s own
mask is what lets clicks through.
A new region repaints the widget’s painted area, its box unless its children overflow it, and never lays the window out, so a region that changes every frame of an animation costs a repaint of that area each frame. A full-screen 1080p picture with a few rounded holes took about 6 to 8 ms a frame at scale 1 and 22 to 25 ms at scale 2 on a 12-core laptop, most of it in the tiles a hole’s edge crosses.