mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
docs(link): improve docs
This commit is contained in:
parent
f08676e73d
commit
a92da8d9a4
1 changed files with 24 additions and 14 deletions
|
@ -8,17 +8,19 @@ components: ["Link", "OutboundLink"]
|
||||||
import Preview from "../../components/Preview.svelte";
|
import Preview from "../../components/Preview.svelte";
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
The `Link` component provides styled hyperlinks with various customization options. It supports different sizes, states, and can include icons. The `OutboundLink` variant automatically handles external links with proper security attributes.
|
||||||
|
|
||||||
## Default
|
## Default
|
||||||
|
|
||||||
|
Create a basic link with the default styling.
|
||||||
|
|
||||||
<Link href="https://www.carbondesignsystem.com/">
|
<Link href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Carbon Design System
|
||||||
</Link>
|
</Link>
|
||||||
|
|
||||||
## Target _blank
|
## Target _blank
|
||||||
|
|
||||||
If setting `target` to `"_blank"`, the `Link` component will automatically set `rel="noopener noreferrer"` to guard against [potential cross-origin security exploits](https://web.dev/external-anchors-use-rel-noopener/).
|
For external links, the component automatically adds security attributes. You can override the `rel` attribute if needed.
|
||||||
|
|
||||||
You can override the `rel` attribute with a custom value.
|
|
||||||
|
|
||||||
<Link href="https://www.carbondesignsystem.com/" target="_blank">
|
<Link href="https://www.carbondesignsystem.com/" target="_blank">
|
||||||
Carbon Design System
|
Carbon Design System
|
||||||
|
@ -26,7 +28,7 @@ You can override the `rel` attribute with a custom value.
|
||||||
|
|
||||||
## Outbound link
|
## Outbound link
|
||||||
|
|
||||||
An alternative to manually setting `target` to `"_blank"` is to use the `OutboundLink`.
|
Use `OutboundLink` as a convenient alternative for external links.
|
||||||
|
|
||||||
<OutboundLink href="https://www.carbondesignsystem.com/">
|
<OutboundLink href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Carbon Design System
|
||||||
|
@ -34,6 +36,8 @@ An alternative to manually setting `target` to `"_blank"` is to use the `Outboun
|
||||||
|
|
||||||
## Inline variant
|
## Inline variant
|
||||||
|
|
||||||
|
Create links that flow naturally with surrounding text.
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
Visit the
|
Visit the
|
||||||
<Link inline href="https://www.carbondesignsystem.com/">
|
<Link inline href="https://www.carbondesignsystem.com/">
|
||||||
|
@ -43,7 +47,7 @@ An alternative to manually setting `target` to `"_blank"` is to use the `Outboun
|
||||||
|
|
||||||
## Link with icon
|
## Link with icon
|
||||||
|
|
||||||
Note that `inline` must be `false` when rendering a link with an icon.
|
Add icons to links for better visual context. Note that `inline` must be `false` when using icons.
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
Visit the
|
Visit the
|
||||||
|
@ -52,28 +56,34 @@ Note that `inline` must be `false` when rendering a link with an icon.
|
||||||
</Link>.
|
</Link>.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Large size
|
## Size variants
|
||||||
|
|
||||||
|
The component supports different sizes to match your design needs:
|
||||||
|
|
||||||
<Link size="lg" href="https://www.carbondesignsystem.com/">
|
<Link size="lg" href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Large link
|
||||||
</Link>
|
</Link>
|
||||||
|
<br />
|
||||||
## Small size
|
<Link href="https://www.carbondesignsystem.com/">
|
||||||
|
Default link
|
||||||
|
</Link>
|
||||||
|
<br />
|
||||||
<Link size="sm" href="https://www.carbondesignsystem.com/">
|
<Link size="sm" href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Small link
|
||||||
</Link>
|
</Link>
|
||||||
|
|
||||||
## Disabled state
|
## Disabled state
|
||||||
|
|
||||||
A `disabled` link will render a `p` tag instead of an anchor element.
|
Disabled links render as plain text while maintaining accessibility.
|
||||||
|
|
||||||
<Link disabled href="https://www.carbondesignsystem.com/">
|
<Link disabled href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Disabled link
|
||||||
</Link>
|
</Link>
|
||||||
|
|
||||||
## Visited styles
|
## Visited styles
|
||||||
|
|
||||||
|
Show visited state styling for links.
|
||||||
|
|
||||||
<Link visited href="https://www.carbondesignsystem.com/">
|
<Link visited href="https://www.carbondesignsystem.com/">
|
||||||
Carbon Design System
|
Visited link
|
||||||
</Link>
|
</Link>
|
Loading…
Add table
Add a link
Reference in a new issue