What does the component do?
A link is an interactive text element that navigates users to another page or resource.
When should the component be used?
- To lead users to further content, pages or external resources.
- To provide links to related information or documents.
- To provide navigation within the website or application.
Rules
- Use descriptive and meaningful link texts to help users understand the target content.
- Links should open in a new tab if they lead to external resources.
Variants
Sibling Components
| Number | Type | Description | Optional | Info |
|---|---|---|---|---|
| 1 | Text | Label | No |
Examples
The sbb-link component provides the same functionality as a native <a> enhanced with the SBB Design.
Slots
The text is provided via an unnamed slot.
<sbb-link value="help"> Help </sbb-link>
States
The component can be displayed in disabled state using the self-named property.
<sbb-link href="https://www.sbb.ch" disabled>Refunds</sbb-link>
Link properties
The component is internally rendered as a link,
accepting its associated properties (href, target, rel and download).
<sbb-link href="https://github.com/sbb-design-systems/lyne-components" target="_blank">
Travel-cards and tickets
</sbb-link>
Properties
| Name | Attribute | Privacy | Type | Default | Description |
|---|---|---|---|---|---|
accessibilityLabel | accessibility-label | public | string | undefined | This will be forwarded as aria-label to the inner anchor element. | |
disabled | disabled | public | boolean | false | Whether the component is disabled. |
download | download | public | boolean | undefined | Whether the browser will show the download dialog on click. | |
href | href | public | string | undefined | The href value you want to link to. | |
negative | negative | public | boolean | false | Negative coloring variant flag. |
rel | rel | public | string | undefined | The relationship of the linked URL as space-separated link types. | |
size | size | public | SbbLinkSize | 's' | Text size, the link should get in the non-button variation. With inline variant, the text size adapts to where it is used. |
target | target | public | LinkTargetType | string | undefined | Where to display the linked URL. |
Slots
| Name | Description |
|---|---|
Use the unnamed slot to add content to the sbb-link. |