Struct CodeEditor 

pub struct CodeEditor { /* private fields */ }

A multi-line code area with a line-number gutter, composed from a multiline TextInput. Real tree-sitter syntax highlighting is available via Self::language, but only while Self::read_only is set — see that method’s doc comment for why live-typing highlighting is a separately-scoped effort.

Stateful view — create with cx.new(|cx| CodeEditor::new(cx)) and store the resulting Entity<CodeEditor>.

Implementations

impl CodeEditor

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

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

Toggles read-only mode (e.g. for a read-only code preview that reuses this component rather than a separate one). Forwards the flag to the wrapped TextInput — no key-handling logic is duplicated here; the TextInput’s own read_only flag remains the single source of truth.

pub fn set_read_only(&mut self, read_only: bool, cx: &mut Context<'_, Self>)

Dynamically toggles read-only mode after construction.

pub fn language(self, extension: &'static str) -> Self

Enables real tree-sitter syntax highlighting for the given file extension (no leading dot, e.g. "rs") — see language::DefaultLanguageRegistry for which extensions are compiled in. Highlighting only renders while Self::read_only is set: TextInput (which this component wraps for keystroke handling) has no cursor-position tracking beyond append-at-the-end (see the current-line-highlight note in render below), so there is no way to keep a caret visually correct inside syntax-highlighted rich text while the user is actively typing. Read-only code previews — the primary use case this component documents — get full highlighting; live editing still renders as plain colored text.

pub fn text(&self, cx: &App) -> String

The current code content.

pub fn set_text(&mut self, text: impl Into<String>, cx: &mut Context<'_, Self>)

Programmatically sets the code content (e.g. loading content into a read-only preview).

Trait Implementations

impl Render for CodeEditor

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

Render this view into an element tree.