Struct TextEditor 

pub struct TextEditor { /* private fields */ }

A styled-text editor bound two-way to a StyledText signal. Build with text_editor.

Implementations

impl TextEditor

pub fn highlight(self, f: impl Fn(&str) -> Vec<TextRun> + 'static) -> Self

Live syntax highlighting: f turns the text into runs, and runs again after every edit (and whenever a signal it reads changes). The runs reach the native view as an attributes patch, so the caret and the platform’s undo stack stay put. highlight::highlighter builds f for the languages the crate knows.

pub fn highlight_limit(self, bytes: usize) -> Self

The size, in bytes, past which TextEditor::highlight leaves the text plain (default HIGHLIGHT_LIMIT, 512 KiB). The tokenizers are linear, but every keystroke restyles the whole document in the native view, and a body of hundreds of thousands of runs is where that stops feeling like typing. A read-only body is styled once and can afford more: raise it there.

pub fn single_line(self) -> Self

One line, scrolling sideways instead of wrapping: a styled text_field. Enter submits (TextEditor::on_submit) and inserts nothing; a pasted newline becomes a space. For a URL bar or a header value that wants template tags or other runs drawn inline.

pub fn on_submit(self, f: impl Fn() + 'static) -> Self

What Enter does in a TextEditor::single_line editor (and what a dayscript submit step delivers).

pub fn code(self) -> Self

Code editing: Tab indents instead of moving focus, Enter keeps the previous line’s indentation (one level deeper after an opening bracket), and an opening bracket or quote gets its closer typed after the caret. Spell-check is off.

pub fn indent(self, spaces: u8) -> Self

The width of one indentation level in spaces (default 2), for TextEditor::code.

pub fn selection(self, sel: impl Binding<Range<usize>>) -> Self

Bind the selection, in BYTE offsets into doc.text, two-way: the user moving the caret writes it, and writing it moves the caret. Collapsed when start == end.

pub fn typing_style(self, style: impl Binding<RunStyle>) -> Self

Bind what the next typed character will be styled with.

The one piece of editor state an app cannot derive from the document and the selection: with a collapsed caret there is no text to read a style off, and “what happens if I type now” is the platform’s own pending state. Writing it is how a toolbar makes the next word bold rather than the last one.

pub fn base(self, base: Font) -> Self

The style unstyled text draws in, and what relative runs scale against (default Body).

pub fn editable<M>(self, v: impl IntoReactive<bool, M>) -> Self

pub fn no_spellcheck(self) -> Self

Hide the platform’s spell-check squiggles (they are on by default); what prose that is not in the system language, or an identifier field, wants. code does this too.

pub fn placeholder<M>(self, t: impl IntoText<M>) -> Self

pub fn min_lines(self, n: u32) -> Self

The height band, in lines: never shorter than min_lines, grows to max_lines and then scrolls (0 = unbounded).

pub fn max_lines(self, n: u32) -> Self

Trait Implementations

impl Piece for TextEditor

fn build(self, cx: &mut BuildCx) -> RNode

impl TextEditorBuilder for TextEditor

fn highlight(self, f: impl Fn(&str) -> Vec<TextRun> + 'static) -> Self

Live syntax highlighting: f turns the text into runs, and runs again after every edit (and whenever a signal it reads changes). The runs reach the native view as an attributes patch, so the caret and the platform’s undo stack stay put. highlight::highlighter builds f for the languages the crate knows.

fn highlight_limit(self, bytes: usize) -> Self

The size, in bytes, past which TextEditor::highlight leaves the text plain (default HIGHLIGHT_LIMIT, 512 KiB). The tokenizers are linear, but every keystroke restyles the whole document in the native view, and a body of hundreds of thousands of runs is where that stops feeling like typing. A read-only body is styled once and can afford more: raise it there.

fn single_line(self) -> Self

One line, scrolling sideways instead of wrapping: a styled text_field. Enter submits (TextEditor::on_submit) and inserts nothing; a pasted newline becomes a space. For a URL bar or a header value that wants template tags or other runs drawn inline.

fn on_submit(self, f: impl Fn() + 'static) -> Self

What Enter does in a TextEditor::single_line editor (and what a dayscript submit step delivers).

fn code(self) -> Self

Code editing: Tab indents instead of moving focus, Enter keeps the previous line’s indentation (one level deeper after an opening bracket), and an opening bracket or quote gets its closer typed after the caret. Spell-check is off.

fn indent(self, spaces: u8) -> Self

The width of one indentation level in spaces (default 2), for TextEditor::code.

fn selection(self, sel: impl Binding<Range<usize>>) -> Self

Bind the selection, in BYTE offsets into doc.text, two-way: the user moving the caret writes it, and writing it moves the caret. Collapsed when start == end.

fn typing_style(self, style: impl Binding<RunStyle>) -> Self

Bind what the next typed character will be styled with.

fn base(self, base: Font) -> Self

The style unstyled text draws in, and what relative runs scale against (default Body).

fn editable<M>(self, v: impl IntoReactive<bool, M>) -> Self

fn no_spellcheck(self) -> Self

Hide the platform’s spell-check squiggles (they are on by default); what prose that is not in the system language, or an identifier field, wants. code does this too.

fn placeholder<M>(self, t: impl IntoText<M>) -> Self

fn min_lines(self, n: u32) -> Self

The height band, in lines: never shorter than min_lines, grows to max_lines and then scrolls (0 = unbounded).

fn max_lines(self, n: u32) -> Self