Link
Links are used to apply styles to hyperlink text.
On this page
Description
Use Link for navigating from one page to another. Link styles anchor tags with default blue styling and hover text-decoration.
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
href | String |
| URL to be used for the Link. Required. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered. |
scheme | Symbol |
| One of |
muted | Boolean |
| Uses light gray for Link color, and blue on hover. |
underline | Boolean |
| Whether or not to underline the link. |
system_arguments | Hash | N/A |
Examples
Slots
tooltip
Tooltip that appears on mouse hover or keyboard focus over the link. Use tooltips sparingly and as a last resort.
Important: This tooltip defaults to type: :description. In a few scenarios, type: :label may be more appropriate.
The tooltip will appear adjacent to the anchor element. Both the tooltip and the anchor will be nested
under a positioning wrapper.
Consult the Tooltip documentation for more information.
| Name | Type | Default | Description |
|---|---|---|---|
type | Symbol |
| One of |
system_arguments | Hash | N/A | Same arguments as Tooltip. |
leading_visual
Leading visuals appear to the left of the link text.
Use:
leading_visual_iconwhich accepts the arguments accepted by Octicon.
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A | Same arguments as Octicon. |
trailing_visual
Trailing visuals appear to the right of the link text.
Use:
trailing_visual_iconwhich accepts the arguments accepted by Octicon.
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A | Same arguments as Octicon. |