LinkProps

Struct LinkProps 

Source
pub struct LinkProps<'a> {
    pub to: &'a str,
    pub class: Option<&'a str>,
    pub active_class: Option<&'a str>,
    pub id: Option<&'a str>,
    pub title: Option<&'a str>,
    pub autodetect: bool,
    pub external: bool,
    pub new_tab: bool,
    pub children: Element<'a>,
    pub onclick: Option<EventHandler<'a, MouseEvent>>,
}
Expand description

Props for the Link component.

Fields§

§to: &'a str

The route to link to. This can be a relative path, or a full URL.

// Absolute path
Link { to: "/home", "Go Home" }

// Relative path
Link { to: "../", "Go Up" }
§class: Option<&'a str>

Set the class of the inner link ‘a’ element.

This can be useful when styling the inner link element.

§active_class: Option<&'a str>

Set the class added to the inner link when the current route is the same as the “to” route.

To set all of the active classes inside a Router at the same time use the active_class prop on the Router component. If both the Router prop as well as this prop are provided then this one has precedence. By default set to "active".

§id: Option<&'a str>

Set the ID of the inner link ‘a’ element.

This can be useful when styling the inner link element.

§title: Option<&'a str>

Set the title of the window after the link is clicked..

§autodetect: bool

Autodetect if a link is external or not.

This is automatically set to true and will use http/https detection

§external: bool

Is this link an external link?

§new_tab: bool

New tab?

§children: Element<'a>

Pass children into the <a> element

§onclick: Option<EventHandler<'a, MouseEvent>>

The onclick event handler.

Implementations§

Source§

impl<'a> LinkProps<'a>

Source

pub fn builder() -> LinkPropsBuilder<'a, ((), (), (), (), (), (), (), (), (), ())>

Create a builder for building LinkProps. On the builder, call .to(...), .class(...)(optional), .active_class(...)(optional), .id(...)(optional), .title(...)(optional), .autodetect(...)(optional), .external(...)(optional), .new_tab(...)(optional), .children(...)(optional), .onclick(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of LinkProps.

Trait Implementations§

Source§

impl<'a> Properties for LinkProps<'a>

Source§

const IS_STATIC: bool = false

An indication if these props are can be memoized automatically.
Source§

type Builder = LinkPropsBuilder<'a, ((), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.
Source§

fn builder() -> Self::Builder

Create a builder for this component.
Source§

unsafe fn memoize(&self, other: &Self) -> bool

Memoization can only happen if the props are valid for the ’static lifetime Read more

Auto Trait Implementations§

§

impl<'a> !Freeze for LinkProps<'a>

§

impl<'a> !RefUnwindSafe for LinkProps<'a>

§

impl<'a> !Send for LinkProps<'a>

§

impl<'a> !Sync for LinkProps<'a>

§

impl<'a> Unpin for LinkProps<'a>

§

impl<'a> !UnwindSafe for LinkProps<'a>

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> 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 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> To for T
where T: ?Sized,

Source§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
Source§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
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> 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