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
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.
See the Router documentation for more information.
Propertiesâ
colorâ
| Description | The 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. |
| Attribute | color |
| Type | "danger" īŊ "dark" īŊ "light" īŊ "medium" īŊ "primary" īŊ "secondary" īŊ "success" īŊ "tertiary" īŊ "warning" īŊ string īŊ undefined |
| Default | undefined |
hrefâ
| Description | Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. |
| Attribute | href |
| Type | string īŊ undefined |
| Default | undefined |
relâ
| Description | Specifies the relationship of the target object to the link object. The value is a space-separated list of link types. |
| Attribute | rel |
| Type | string īŊ undefined |
| Default | undefined |
routerAnimationâ
| Description | When using a router, it specifies the transition animation when navigating to another page using href. |
| Attribute | router-animation |
| Type | ((baseEl: any, opts?: any) => Animation) īŊ undefined |
| Default | undefined |
routerDirectionâ
| Description | When using a router, it specifies the transition direction when navigating to another page using href. |
| Attribute | router-direction |
| Type | "back" īŊ "forward" īŊ "root" |
| Default | 'forward' |
targetâ
| Description | Specifies where to display the linked URL. Only applies when an href is provided. Special keywords: "_blank", "_self", "_parent", "_top". |
| Attribute | target |
| Type | string īŊ undefined |
| Default | undefined |
Eventsâ
No events available for this component.
Methodsâ
No public methods available for this component.
CSS Shadow Partsâ
No CSS shadow parts available for this component.
CSS Custom Propertiesâ
| Name | Description |
|---|---|
--background | Background of the router link |
--color | Text color of the router link |
Slotsâ
No slots available for this component.