Struct leptos_meta::BodyProps

pub struct BodyProps {
    pub class: Option<TextProp>,
    pub attributes: Option<MaybeSignal<AdditionalAttributes>>,
}

Expand description

Props for the Body component.

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

use leptos::*;
use leptos_meta::*;
#[component]
fn MyApp(cx: Scope) -> impl IntoView {
    provide_meta_context(cx);
    let (prefers_dark, set_prefers_dark) = create_signal(cx, false);
    let body_class = move || {
        if prefers_dark.get() {
            "dark".to_string()
        } else {
            "light".to_string()
        }
    };
    view! { cx,
      <main>
        <Body class=body_class/>
      </main>
    }
}

Required Props

cx: [Scope]

Optional Props

class: impl Into<TextProp>
- The class attribute on the <body>.
attributes: impl Into<MaybeSignal<AdditionalAttributes>>
- Arbitrary attributes to add to the <html>

Fields§

§class: Option<TextProp>

The class attribute on the <body>.

§attributes: Option<MaybeSignal<AdditionalAttributes>>

Arbitrary attributes to add to the <html>

Implementations§

impl BodyProps

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

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

Trait Implementations§

impl IntoView for BodyProps

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

Converts the value into [View].

Auto Trait Implementations§

impl !RefUnwindSafe for BodyProps

impl !Send for BodyProps

impl !Sync for BodyProps

impl Unpin for BodyProps

impl !UnwindSafe for BodyProps

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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