Struct leptos::HtmlElement

source ·

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

Expand description

Represents an HTML element.

Implementations§

source §

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

source

pub fn with_view_marker(self, marker: impl Into<String>) -> HtmlElement<El>

Adds an optional marker indicating the view macro source.

source

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

Converts this element into HtmlElement<AnyElement>.

source

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

Adds an id to the element.

source

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

Binds the element reference to NodeRef.

source

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.

source

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 false on non-wasm CSR targets.

source

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

Adds an attribute to this element.

source

pub fn attrs( self, attrs: impl IntoIterator<Item = (&'static str, Attribute)>, ) -> HtmlElement<El>

Adds multiple attributes to the element.

source

pub fn bindings<B>( self, bindings: impl IntoIterator<Item = B>, ) -> HtmlElement<El>
where B: Into<Binding>,

Adds multiple bindings (attributes or event handlers) to the element.

source

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

Adds a class to an element.

Note: In the builder syntax, this will be overwritten by the class attribute if you use .attr("class", /* */). In the view macro, they are automatically re-ordered so that this over-writing does not happen.

§Panics

This directly uses the browser’s classList API, which means it will throw a runtime error if you pass more than a single class name. If you want to pass more than one class name at a time, you can use HtmlElement::classes.

source

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

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

source

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

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

source

pub fn style( self, name: impl Into<Oco<'static, str>>, style: impl IntoStyle, ) -> HtmlElement<El>

Sets a style on an element.

Note: In the builder syntax, this will be overwritten by the style attribute if you use .attr("style", /* */). In the view macro, they are automatically re-ordered so that this over-writing does not happen.

source

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

Sets a property on an element.

source

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.

source

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

Optionally adds an event listener to this element.

§Example

#[component]
pub fn Input(
    #[prop(optional)] value: Option<RwSignal<String>>,
) -> impl IntoView {
    view! {  <input/> }
        // only add event if `value` is `Some(signal)`
        .optional_event(
            ev::input,
            value.map(|value| move |ev| value.set(event_target_value(&ev))),
        )
}

source

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

Adds a child to this element.

source

pub fn inner_html(self, html: impl Into<Oco<'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.

source §

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

source

pub fn directive<T, P>( self, handler: impl Directive<T, P> + 'static, param: P, ) -> HtmlElement<El>
where P: Clone + 'static, T: ?Sized,

Bind the directive to the element.

Trait Implementations§

source §

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

source §

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

Returns a copy 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<T> DOMEventResponder for HtmlElement<T>
where T: ElementDescriptor + 'static,

source §

fn add<E>( self, event: E, handler: impl FnMut(<E as EventDescriptor>::EventType) + 'static, ) -> HtmlElement<T>
where E: EventDescriptor + 'static,

Adds handler to specified event

source §

fn add_handler(self, handler: impl EventHandler) -> Self

Same as add, but with EventHandler

source §

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

source §

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

Formats the value using the given formatter. Read more

source §

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

source §

type Target = <El as Deref>::Target

The resulting type after dereferencing.

source §

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

Dereferences the value.

source §