Skip to main content

RichTextEditorProps

Struct RichTextEditorProps 

Source
pub struct RichTextEditorProps {
    pub name: String,
    pub value: Option<String>,
    pub formats: Vec<String>,
    pub placeholder: Option<String>,
    pub theme: String,
    pub label: Option<String>,
    pub error: Option<String>,
    pub data_path: Option<String>,
    pub required: Option<bool>,
}
Expand description

Props for Component::RichTextEditor.

Renders a <div data-rich-text-editor> host whose runtime IIFE attaches a Quill 2.0.3 (Snow theme) editor. On form submit the IIFE writes two hidden inputs — {name}_delta (canonical Delta JSON, lossless) and {name}_html (sanitized HTML, rendering input). The formats allowlist is the single source of truth: it constrains both the Quill toolbar (init time) and the HTML post-process (submit time). Image / video / HTML-paste paths are not reachable through the prop surface.

Quill JS+CSS are loaded once per page from jsDelivr, SHA-384 SRI-pinned via the RichTextEditorPlugin asset adapter. Multiple editor instances on the same page deduplicate the asset to a single load.

Fields§

§name: String

Base form field name. The IIFE emits two hidden inputs on submit: {name}_delta (Delta JSON) and {name}_html (sanitized HTML).

Must be unique within the page (not just within the form). The renderer uses name as the DOM id of the editor host and the error element (err-{name}). Two editors with the same name on one page produce duplicate DOM ids, which breaks label association and the error-element selector.

§value: Option<String>

Initial editor content. Auto-detected at runtime: parses as JSON (Delta) when the string has an ops array; otherwise loaded as HTML via clipboard.dangerouslyPasteHTML filtered by the formats allowlist.

§formats: Vec<String>

Toolbar/allowlist whitelist. Drives both Quill’s toolbar config and the HTML post-process. Default: ["bold", "italic", "underline", "list", "header", "link"] (D-18).

§placeholder: Option<String>

Optional placeholder shown by Quill when the editor is empty.

§theme: String

Quill theme — only "snow" is supported in v1. Defaults to "snow".

§label: Option<String>

Optional visible label rendered above the editor host.

§error: Option<String>

Validation error message rendered below the editor with destructive token styling.

§data_path: Option<String>

JSON pointer for pre-fill at render time. Resolved value is passed as the initial editor body (after html_escape). When both value and data_path are set, value wins.

§required: Option<bool>

When true, the IIFE installs a guard that calls event.preventDefault on form submit if quill.getText().trim().length === 0, surfacing the destructive-token error region with a “Required” message.

Trait Implementations§

Source§

impl Clone for RichTextEditorProps

Source§

fn clone(&self) -> RichTextEditorProps

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RichTextEditorProps

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RichTextEditorProps

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for RichTextEditorProps

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for RichTextEditorProps

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for RichTextEditorProps

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RichTextEditorProps

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,