refactor(link): minor feedbacks

sbb-design-systems · Feb 28, 2024 · 67a63ff · 67a63ff
1 parent 43b7fab
commit 67a63ff
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 14 deletions.
diff --git a/src/components/action-group/readme.md b/src/components/action-group/readme.md
@@ -1,5 +1,5 @@
 The `sbb-action-group` component is a generic content container which can contain up to three action items
-([sbb-button](/docs/components-sbb-button--docs) or [sbb-link](/docs/components-sbb-link--docs) or other HTML elements)
+([sbb-button](/docs/components-sbb-button--docs) or [sbb-block-link](/docs/components-sbb-link-sbb-block-link--docs) or other HTML elements)
 in various [allocations](#allocations).
 
 ## Style

diff --git a/src/components/link-list/readme.md b/src/components/link-list/readme.md
@@ -1,4 +1,4 @@
-The `sbb-link-list` is a component that can be used to collect and display more [sbb-block-link](/docs/components-sbb-block.link--docs)s.
+The `sbb-link-list` is a component that can be used to collect and display more [sbb-block-link](/docs/components-sbb-link-sbb-block-link--docs).
 
 ```html
 <sbb-link-list>

diff --git a/src/components/link/link-button/readme.md b/src/components/link/link-button/readme.md
@@ -5,6 +5,10 @@ despite its appearance as a link enhanced with the SBB Design.
 
 The text is provided via an unnamed slot.
 
+```html
+<sbb-link-button value="help"> Help </sbb-link-button>
+```
+
 ## States
 
 The component can be displayed in `disabled` state using the self-named property.

diff --git a/src/components/link/link-static/readme.md b/src/components/link/link-static/readme.md
@@ -1,14 +1,14 @@
 The `sbb-link-static` component mimics the look of the `<sbb-link>`,
 and it's meant to be used whenever is required to nest one link inside another without breaking the HTML functionality.
 
-```html
-<sbb-link-static>Fake link</sbb-link-static>
-```
-
 ## Slots
 
 The text is provided via an unnamed slot.
 
+```html
+<sbb-link-static>Fake link</sbb-link-static>
+```
+
 ## States
 
 The component can be displayed in `disabled` state using the self-named property.

diff --git a/src/components/link/link/readme.md b/src/components/link/link/readme.md
@@ -4,6 +4,10 @@ The `sbb-link` component provides the same functionality as a native `<a>` enhan
 
 The text is provided via an unnamed slot.
 
+```html
+<sbb-link value="help"> Help </sbb-link>
+```
+
 ## States
 
 The component can be displayed in `disabled` state using the self-named property.

diff --git a/src/components/skiplink-list/skiplink-list.ts b/src/components/skiplink-list/skiplink-list.ts
@@ -13,12 +13,7 @@ import {
   SbbNamedSlotListElementMixin,
   type WithListChildren,
 } from '../core/common-behaviors';
-import type {
-  SbbLinkElement,
-  SbbLinkButtonElement,
-  SbbBlockLinkElement,
-  SbbBlockLinkButtonElement,
-} from '../link';
+import type { SbbBlockLinkElement, SbbBlockLinkButtonElement } from '../link';
 import type { TitleLevel } from '../title';
 
 import style from './skiplink-list.scss?lit&inline';
@@ -32,7 +27,7 @@ import '../title';
  */
 @customElement('sbb-skiplink-list')
 export class SbbSkiplinkListElement extends SbbNamedSlotListElementMixin<
-  SbbLinkElement | SbbLinkButtonElement | SbbBlockLinkElement | SbbBlockLinkButtonElement,
+  SbbBlockLinkElement | SbbBlockLinkButtonElement,
   typeof LitElement
 >(LitElement) {
   public static override styles: CSSResultGroup = style;

diff --git a/src/components/toast/readme.md b/src/components/toast/readme.md
@@ -38,7 +38,7 @@ A `sbb-toast` can also be given a custom action that, if marked with the `sbb-to
   Toast content
   <!-- Toast action can be a button -->
   <sbb-button slot="action" icon-name="clock-small" sbb-toast-close></sbb-button>
-  <!-- Or a link -->
+  <!-- Or an inline link -->
   <sbb-link-button slot="action">Link action</sbb-link-button>
 </sbb-toast>
 ```