Struct dioxus_router::components::LinkProps

pub struct LinkProps {
    pub class: Option<String>,
    pub active_class: Option<String>,
    pub children: Element,
    pub new_tab: bool,
    pub onclick: Option<EventHandler<MouseEvent>>,
    pub onmounted: Option<EventHandler<MountedEvent>>,
    pub onclick_only: bool,
    pub rel: Option<String>,
    pub to: IntoRoutable,
    /* private fields */
}

The properties for a Link.

Fields

class: Option<String>

The class attribute for the a tag.

active_class: Option<String>

A class to apply to the generate HTML anchor tag if the target route is active.

children: Element

The children to render within the generated HTML anchor tag.

new_tab: bool

When true, the target route will be opened in a new tab.

This does not change whether the Link is active or not.

onclick: Option<EventHandler<MouseEvent>>

The onclick event handler.

onmounted: Option<EventHandler<MountedEvent>>

The onmounted event handler. Fired when the element is mounted.

onclick_only: bool

Whether the default behavior should be executed if an onclick handler is provided.

1. When onclick is None (default if not specified), onclick_only has no effect.
2. If onclick_only is false (default if not specified), the provided onclick handler will be executed after the links regular functionality.
3. If onclick_only is true, only the provided onclick handler will be executed.

rel: Option<String>

The rel attribute for the generated HTML anchor tag.

For external as, this defaults to noopener noreferrer.

to: IntoRoutable

The navigation target. Roughly equivalent to the href attribute of an HTML anchor tag.

Implementations

impl LinkProps

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

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

Trait Implementations

impl Clone for LinkProps

fn clone(&self) -> LinkProps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkProps

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

Formats the value using the given formatter.

impl PartialEq for LinkProps

fn eq(&self, other: &LinkProps) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for LinkProps

where Self: Clone,

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

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

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, component_name: &'static str, ) -> VComponent

where M: 'static,

Create a component from the props.

impl StructuralPartialEq for LinkProps