Struct CodeEditorProps 

pub struct CodeEditorProps {
    pub value: String,
    pub language: Language,
    pub theme: CodeTheme,
    pub line_numbers: bool,
    pub read_only: bool,
    pub spellcheck: bool,
    pub aria_label: String,
    pub placeholder: String,
    pub class: String,
    pub oninput: EventHandler<String>,
}

Props for CodeEditor.

use dioxus_code::{CodeTheme, Theme};
use dioxus_code_editor::{CodeEditorProps, Language};
let _props = CodeEditorProps::builder()
    .value("fn main() {}")
    .language(Language::Rust)
    .theme(CodeTheme::fixed(Theme::TOKYO_NIGHT))
    .build();

Fields

value: String

The current editor contents.

language: Language

Tree-sitter grammar used for syntax highlighting.

Pass a Language variant directly. Use Language::from_slug to turn a runtime slug into a variant. Defaults to Language::Rust.

theme: CodeTheme

Syntax theme selection shared with dioxus-code.

line_numbers: bool

Show a gutter with one-based line numbers.

read_only: bool

Disable editing while preserving syntax highlighting and text selection.

spellcheck: bool

Forward spellcheck to the textarea input layer.

aria_label: String

Accessible label for the editor textbox.

placeholder: String

Placeholder shown only while CodeEditorProps::value is empty.

class: String

Extra class names appended to the editor root.

oninput: EventHandler<String>

Called with the full editor text after each input event.

Implementations

impl CodeEditorProps

pub fn builder() -> CodeEditorPropsBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building CodeEditorProps. On the builder, call .value(...), .language(...)(optional), .theme(...)(optional), .line_numbers(...)(optional), .read_only(...)(optional), .spellcheck(...)(optional), .aria_label(...)(optional), .placeholder(...)(optional), .class(...)(optional), .oninput(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CodeEditorProps.

Trait Implementations

impl Clone for CodeEditorProps

fn clone(&self) -> CodeEditorProps

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for CodeEditorProps

fn eq(&self, other: &CodeEditorProps) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for CodeEditorProps

where Self: Clone,

type Builder = CodeEditorPropsBuilder<((), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.

impl StructuralPartialEq for CodeEditorProps