Skip to main content
Version: v5

ion-router-link

The router link component is used for navigating to a specified link. Similar to the browser's anchor tag, it can accept a href for the location, and a direction for the transition animation.

Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use an <a> and routerLink with the Angular router.

Properties

color

DescriptionThe color to use from your application's color palette.
Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark".
For more information on colors, see theming.
Attributecolor
Typestring \| undefined
Defaultundefined

href

DescriptionContains a URL or a URL fragment that the hyperlink points to.
If this property is set, an anchor tag will be rendered.
Attributehref
Typestring \| undefined
Defaultundefined

rel

DescriptionSpecifies the relationship of the target object to the link object.
The value is a space-separated list of link types.
Attributerel
Typestring \| undefined
Defaultundefined

routerAnimation

DescriptionWhen using a router, it specifies the transition animation when navigating to
another page using href.
Attributeundefined
Type((baseEl: any, opts?: any) => Animation) \| undefined
Defaultundefined

routerDirection

DescriptionWhen using a router, it specifies the transition direction when navigating to
another page using href.
Attributerouter-direction
Type"back" \| "forward" \| "root"
Default'forward'

target

DescriptionSpecifies where to display the linked URL.
Only applies when an href is provided.
Special keywords: "_blank", "_self", "_parent", "_top".
Attributetarget
Typestring \| undefined
Defaultundefined

CSS Custom Properties

NameDescription
--backgroundBackground of the router link
--colorText color of the router link
View Source