Struct TuiEditorProps

pub struct TuiEditorProps {
    pub id: SharedString,
    pub height: SharedString,
    pub min_height: SharedString,
    pub initial_value: SharedString,
    pub edit_type: SharedString,
    pub preview_style: SharedString,
    pub theme: SharedString,
    pub locale: SharedString,
    pub on_change: Option<EventHandler<String>>,
}

The TuiEditor properties struct for the configuration of the component.

Fields

id: SharedString

The editor ID.

height: SharedString

The height of the container.

min_height: SharedString

The min-height of the container.

initial_value: SharedString

The initial value of Markdown string.

edit_type: SharedString

The initial type to show: markdown | wysiwyg.

preview_style: SharedString

The preview style of Markdown mode: tab | vertical.

theme: SharedString

The theme: light | dark.

locale: SharedString

The i18n locale.

on_change: Option<EventHandler<String>>

An event handler to be called when the input value is changed.

Implementations

impl TuiEditorProps

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

Create a builder for building TuiEditorProps. On the builder, call .id(...)(optional), .height(...)(optional), .min_height(...)(optional), .initial_value(...), .edit_type(...)(optional), .preview_style(...)(optional), .theme(...)(optional), .locale(...)(optional), .on_change(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TuiEditorProps.

Trait Implementations

impl Clone for TuiEditorProps

fn clone(&self) -> TuiEditorProps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for TuiEditorProps

fn eq(&self, other: &TuiEditorProps) -> 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 TuiEditorProps

where Self: Clone,

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

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 TuiEditorProps