Struct leptos::HtmlElement

pub struct HtmlElement<El>where
    El: ElementDescriptor,{ /* private fields */ }

Represents an HTML element.

Implementations

impl<El> HtmlElement<El>where El: ElementDescriptor + 'static,

pub fn into_any(self) -> HtmlElement<AnyElement>

Converts this element into HtmlElement<AnyElement>.

pub fn id(self, id: impl Into<Cow<'static, str>>) -> HtmlElement<El>

Adds an id to the element.

pub fn node_ref(self, node_ref: NodeRef<El>) -> HtmlElement<El>where HtmlElement<El>: Clone,

Binds the element reference to NodeRef.

pub fn on_mount( self, f: impl FnOnce(HtmlElement<El>) + 'static ) -> HtmlElement<El>

Runs the callback when this element has been mounted to the DOM.

Important Note

This method will only ever run at most once. If this element is unmounted and remounted, or moved somewhere else, it will not re-run unless you call this method again.

pub fn is_mounted(&self) -> bool

Checks to see if this element is mounted to the DOM as a child of body.

This method will always return None on non-wasm CSR targets.

pub fn attr( self, name: impl Into<Cow<'static, str>>, attr: impl IntoAttribute ) -> HtmlElement<El>

Adds an attribute to this element.

pub fn class( self, name: impl Into<Cow<'static, str>>, class: impl IntoClass ) -> HtmlElement<El>

Adds a class to an element.

pub fn classes(self, classes: impl Into<Cow<'static, str>>) -> HtmlElement<El>

Adds a list of classes separated by ASCII whitespace to an element.

pub fn dyn_classes<I, C>( self, classes_signal: impl Fn() -> I + 'static ) -> HtmlElement<El>where I: IntoIterator<Item = C>, C: Into<Cow<'static, str>>,

Sets the class on the element as the class signal changes.

pub fn prop( self, name: impl Into<Cow<'static, str>>, value: impl IntoProperty ) -> HtmlElement<El>

Sets a property on an element.

pub fn on<E>( self, event: E, event_handler: impl FnMut(<E as EventDescriptor>::EventType) + 'static ) -> HtmlElement<El>where E: EventDescriptor + 'static,

Adds an event listener to this element.

pub fn child(self, child: impl IntoView) -> HtmlElement<El>

Adds a child to this element.

pub fn inner_html(self, html: impl Into<Cow<'static, str>>) -> HtmlElement<El>

Sets the inner HTML of this element from the provided string slice.

Security

Be very careful when using this method. Always remember to sanitize the input to avoid a cross-site scripting (XSS) vulnerability.

Trait Implementations

impl<El> Clone for HtmlElement<El>where El: Clone + ElementDescriptor,

fn clone(&self) -> HtmlElement<El>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<El> Debug for HtmlElement<El>where El: ElementDescriptor,

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

Formats the value using the given formatter.

impl<El> Deref for HtmlElement<El>where El: ElementDescriptor + Deref,

type Target = <El as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &<HtmlElement<El> as Deref>::Target

Dereferences the value.

impl<El> IntoView for HtmlElement<El>where El: ElementDescriptor,

fn into_view(self, _: Scope) -> View

Converts the value into View.