Skip to main content

CreateEditorArgs

Struct CreateEditorArgs 

Source
pub struct CreateEditorArgs {
    pub nodes: Vec<NodeClass>,
    pub namespace: String,
    pub editor_state: Option<EditorState>,
    pub editable: Option<bool>,
    pub on_warn: Option<WarningHandler>,
    pub parent_editor: Option<Editor>,
    pub theme: Object,
    pub html: HtmlConfig,
    pub dom: Option<EditorDomRenderConfig>,
}
Expand description

CreateEditorArgs: the node classes (and LexicalNodeReplacements, as NodeClasses) to register besides the core ones, the editor’s namespace (when empty, its parent editor’s, or a random one, createUID()), the initial state, whether it is editable, the theme, the parent editor, onWarn, and (with the html feature) the HTML import and export overrides and the render config. JS’s onError has no counterpart: an update’s error is returned from Editor::update.

Fields§

§nodes: Vec<NodeClass>§namespace: String§editor_state: Option<EditorState>

editorState: the state the editor starts with, committed by its first read or update.

§editable: Option<bool>

editable; None is JS’s undefined, editable.

§on_warn: Option<WarningHandler>

onWarn: what hears of recoverable conditions (an update cascade cut short); by default the warning is returned as an error, as JS’s default throws in development.

§parent_editor: Option<Editor>

parentEditor: the editor this one is nested in, which commands dispatched in this one reach after its own listeners.

§theme: Object

theme: class names by node kind (EditorThemeClasses), as JSON: a string or an array of strings, or (for text) an object of them by format.

§html: HtmlConfig

html: export overrides by node type and extra import conversions.

§dom: Option<EditorDomRenderConfig>

dom: the render config; None for the default.

Trait Implementations§

Source§

impl Clone for CreateEditorArgs

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for CreateEditorArgs

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.