Struct Route 

pub struct Route { /* private fields */ }

Configures an element to render when a pattern matches the current path. It must be rendered within a Routes element.

Implementations

impl Route

pub fn new() -> Self

pub fn path(self, path: impl Into<SharedString>) -> Self

The path to match against the current location.

pub fn element<E: IntoElement>(self, element: E) -> Self

The element to render when the route matches. Panics if a layout is already set.

pub fn layout(self, layout: impl Layout + 'static) -> Self

The layout to use when the route matches. Panics if an element is already set.

pub fn index(self) -> Self

Sets the route as an index route. Panics if a path is already set.

pub fn child(self, child: Route) -> Self

Adds a Route as a child to the Route.

pub fn children(self, children: impl IntoIterator<Item = Route>) -> Self

Adds multiple Routes as children to the Route.

Trait Implementations

impl Debug for Route

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

Formats the value using the given formatter.

impl Default for Route

fn default() -> Route

Returns the “default value” for a type.

impl Display for Route

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

Formats the value using the given formatter.

impl IntoElement for Route

type Element = Component<Route>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Route

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.