Struct leptos_meta::HtmlProps

source ·
pub struct HtmlProps {
    pub lang: Option<TextProp>,
    pub dir: Option<TextProp>,
    pub class: Option<TextProp>,
    pub attributes: Option<MaybeSignal<AdditionalAttributes>>,
}
Expand description

Props for the Html component.

A component to set metadata on the document’s <html> element from within the application.

use leptos::*;
use leptos_meta::*;
#[component]
fn MyApp(cx: Scope) -> impl IntoView {
    provide_meta_context(cx);
    view! { cx,
      <main>
        <Html
          lang="he"
          dir="rtl"
          // arbitrary additional attributes can be passed via `attributes`
          attributes=AdditionalAttributes::from(vec![("data-theme", "dark")])
        />
      </main>
    }
}

Required Props

  • cx: [Scope]

Optional Props

Fields§

§lang: Option<TextProp>

The lang attribute on the <html>.

§dir: Option<TextProp>

The dir attribute on the <html>.

§class: Option<TextProp>

The class attribute on the <html>.

§attributes: Option<MaybeSignal<AdditionalAttributes>>

Arbitrary attributes to add to the <html>

Implementations§

source§

impl HtmlProps

source

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

Create a builder for building HtmlProps. On the builder, call .lang(...)(optional), .dir(...)(optional), .class(...)(optional), .attributes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of HtmlProps.

Trait Implementations§

source§

impl IntoView for HtmlProps

source§

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

Converts the value into [View].

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more