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 | Component | sbb-icon | Yes | Kann am Anfang oder Ende gesetzt werden. |
| 2 | Text | Label | No |
Playground
Examples
The sbb-block-link component provides the same functionality as a native <a> enhanced with the SBB Design.
Slots
The text is provided via an unnamed slot; the component can optionally display a sbb-icon using
the iconName property or via custom content using the icon slot.
By default, the icon is placed at the component's end, but this can be changed using the iconPlacement property.
<sbb-block-link href="https://www.sbb.ch" icon-name="chevron-small-right-small">
Help
</sbb-block-link>
<sbb-block-link
href="https://www.sbb.ch"
icon-name="chevron-small-left-small"
icon-placement="start"
>
Contact
</sbb-block-link>
States
The component can be displayed in disabled state using the self-named property.
<sbb-block-link href="https://www.sbb.ch" disabled>Refunds</sbb-block-link>
Link properties
The component is internally rendered as a link,
accepting its associated properties (href, target, rel and download).
<sbb-block-link href="https://github.com/sbb-design-systems/lyne-components" target="_blank">
Travel-cards and tickets
</sbb-block-link>
Style
The component has three sizes (xs, s, which is the default, and m).
<sbb-block-link href="https://www.sbb.ch" size="m">Refunds</sbb-block-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. | |
iconName | icon-name | public | string | undefined | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | |
iconPlacement | icon-placement | public | SbbIconPlacement | undefined | 'start' | Moves the icon to the end of the component if set to true. |
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-block-link. | |
icon | Slot used to display the icon, if one is set. |