Struct CodeEditor 

pub struct CodeEditor { /* private fields */ }

Canvas-based high-performance text editor.

Implementations

impl CodeEditor

pub fn update(&mut self, message: &Message) -> Task<Message>

Updates the editor state based on messages and returns scroll commands.

Arguments

• message - The message to process

Returns

A Task that may contain scroll commands to keep cursor visible

impl CodeEditor

pub fn view(&self) -> Element<'_, Message>

Creates the view element with scrollable wrapper.

The backgrounds (editor and gutter) are handled by container styles to ensure proper clipping when the pane is resized.

impl CodeEditor

pub fn new(content: &str, syntax: &str) -> Self

Creates a new canvas-based text editor.

Arguments

• content - Initial text content
• syntax - Syntax highlighting language (e.g., “py”, “lua”, “rs”)

Returns

A new CodeEditor instance

pub fn content(&self) -> String

Returns the current text content as a string.

Returns

The complete text content of the editor

pub fn with_viewport_height(self, height: f32) -> Self

Sets the viewport height for the editor.

This determines the minimum height of the canvas, ensuring proper background rendering even when content is smaller than the viewport.

Arguments

• height - The viewport height in pixels

Returns

Self for method chaining

Example

use iced_code_editor::CodeEditor;

let editor = CodeEditor::new("fn main() {}", "rs")
    .with_viewport_height(500.0);

pub fn set_theme(&mut self, style: Style)

Sets the theme style for the editor.

Arguments

• style - The style to apply to the editor

Example

use iced_code_editor::{CodeEditor, theme};

let mut editor = CodeEditor::new("fn main() {}", "rs");
editor.set_theme(theme::light(&iced::Theme::Light));

pub fn reset(&mut self, content: &str) -> Task<Message>

Resets the editor with new content.

This method replaces the buffer content and resets all editor state (cursor position, selection, scroll, history) to initial values. Use this instead of creating a new CodeEditor instance to ensure proper widget tree updates in iced.

Returns a Task that scrolls the editor to the top, which also forces a redraw of the canvas.

Arguments

• content - The new text content

Returns

A Task<Message> that should be returned from your update function

Example

use iced_code_editor::CodeEditor;

let mut editor = CodeEditor::new("initial content", "lua");
// Later, reset with new content and get the task
let task = editor.reset("new content");
// Return task.map(YourMessage::Editor) from your update function

pub fn is_modified(&self) -> bool

Returns whether the editor has unsaved changes.

Returns

true if there are unsaved modifications, false otherwise

pub fn mark_saved(&mut self)

Marks the current state as saved.

Call this after successfully saving the file to reset the modified state.

pub fn can_undo(&self) -> bool

Returns whether undo is available.

pub fn can_redo(&self) -> bool

Returns whether redo is available.

Trait Implementations

impl Program<Message> for CodeEditor

type State = ()

The internal state mutated by the Program.

fn draw( &self, _state: &Self::State, renderer: &Renderer, _theme: &Theme, bounds: Rectangle, _cursor: Cursor, ) -> Vec<Geometry>

Draws the state of the Program, producing a bunch of Geometry.

fn update( &self, _state: &mut Self::State, event: &Event, bounds: Rectangle, cursor: Cursor, ) -> Option<Action<Message>>

Updates the State of the Program.

fn mouse_interaction( &self, _state: &Self::State, _bounds: Rectangle, _cursor: Cursor, ) -> Interaction

Returns the current mouse interaction of the Program.