Struct Editor 

pub struct Editor { /* private fields */ }

A multiline code editor. Create with cx.new(|cx| Editor::new(cx)).

The text model is the unit-tested EditorModel (char-index cursor, anchor selection, coalesced undo). Read-only editors still support selection and copy — only mutations are blocked.

Implementations

impl Editor

pub fn new(cx: &mut Context<'_, Self>) -> Self

pub fn value(self, text: &str) -> Self

Initial text (named like TextInput::value; text() is the getter).

pub fn language(self, language: Language) -> Self

Syntax highlighting language (default Language::None).

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

Dimmed hint shown while the buffer is empty and unfocused.

pub fn read_only(self, read_only: bool) -> Self

Block edits. Selection, copy, and Cmd+Enter still work.

pub fn line_numbers(self, show: bool) -> Self

Show the line-number gutter (default true).

pub fn tab_size(self, n: usize) -> Self

Spaces per tab stop (default 4).

pub fn font_size(self, size: f32) -> Self

Buffer font size in px (default 13.0).

pub fn rows(self, rows: usize) -> Self

Minimum height, as a number of visible lines.

pub fn token_colors(self, colors: [Hsla; 8]) -> Self

Override the syntax palette — one color per TokenKind, in TokenKind::ALL order. Defaults to the theme mapping (token_color).

pub fn style(self, style: EditorStyle) -> Self

Per-editor visual overrides (see EditorStyle).

pub fn set_style(&mut self, style: EditorStyle, cx: &mut Context<'_, Self>)

Replace the style at runtime (theme switches).

pub fn set_highlights( &mut self, highlights: Vec<(Pos, Pos, Hsla)>, cx: &mut Context<'_, Self>, )

Background rectangles painted under the text — search matches, occurrence highlights. Document-position ranges; multi-line ranges paint like selections.

pub fn text(&self) -> String

The current document text.

pub fn set_text(&mut self, value: &str, cx: &mut Context<'_, Self>)

Replace the document, resetting cursor, selection, and history.

pub fn focus_handle(&self) -> FocusHandle

The editor’s focus handle, so a host can focus it on open.

pub fn model(&self) -> &EditorModel

Read access to the underlying EditorModel — cursor, selection, lines — for hosts that build features over the buffer (completion, modal keymaps, search).

pub fn edit<R>( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, f: impl FnOnce(&mut EditorModel) -> R, ) -> R

Mutate the EditorModel directly. Emits EditorEvent::Change when the text changed, keeps the caret visible, and repaints — the same bookkeeping every built-in edit goes through.

pub fn caret_origin(&self, window: &Window) -> Point<Pixels>

Window-space origin of the caret’s cell — where a completion popup or search bar anchors. Tracks both scroll axes; meaningless before the first paint (returns the content origin).

pub fn line_height(&self) -> f32

The pixel height of one buffer line, as painted last frame.

pub fn bind(entity: &Entity<Editor>, signal: &Signal<String>, cx: &mut App)

Two-way bind this editor’s text to a Signal<String>. The signal is the source of truth: the editor adopts its value now, edits write back through Signal::set_if_changed, and signal writes replace the text. Equality guards on both directions prevent update loops.

Trait Implementations

impl EventEmitter<EditorEvent> for Editor

impl Render for Editor

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.