|
| 1 | +--- |
| 2 | +title: Abzeichen |
| 3 | +description: Lerne, wie du in Starlight Abzeichen verwenden kannst, um zusätzliche Informationen anzuzeigen. |
| 4 | +--- |
| 5 | + |
| 6 | +import { Badge } from '@astrojs/starlight/components'; |
| 7 | + |
| 8 | +Um wenige Informationen, wie z.B. einen Status oder eine Kategorie, anzuzeigen, verwende die Komponente `<Badge>`. |
| 9 | + |
| 10 | +import Preview from '~/components/component-preview.astro'; |
| 11 | + |
| 12 | +<Preview> |
| 13 | + |
| 14 | +<Badge slot="preview" text="Neu" /> |
| 15 | + |
| 16 | +</Preview> |
| 17 | + |
| 18 | +## Import |
| 19 | + |
| 20 | +```tsx |
| 21 | +import { Badge } from '@astrojs/starlight/components'; |
| 22 | +``` |
| 23 | + |
| 24 | +## Verwendung |
| 25 | + |
| 26 | +Zeige ein Abzeichen mit der Komponente `<Badge>` an und übergib den Inhalt, den du anzeigen möchtest, an das Attribut [`text`](#text) der Komponente `<Badge>`. |
| 27 | + |
| 28 | +Standardmäßig wird für das Abzeichen die Akzentfarbe des Aussehens deiner Website verwendet. |
| 29 | +Um eine eingebaute Abzeichen-Farbe zu verwenden, setze das Attribut [`variant`](#variant) auf einen der unterstützten Werte. |
| 30 | + |
| 31 | +<Preview> |
| 32 | + |
| 33 | +```mdx |
| 34 | +import { Badge } from '@astrojs/starlight/components'; |
| 35 | + |
| 36 | +<Badge text="Hinweis" variant="note" /> |
| 37 | +<Badge text="Erfolg" variant="success" /> |
| 38 | +<Badge text="Tipp" variant="tip" /> |
| 39 | +<Badge text="Warnung" variant="caution" /> |
| 40 | +<Badge text="Gefahr" variant="danger" /> |
| 41 | +``` |
| 42 | + |
| 43 | +<Fragment slot="markdoc"> |
| 44 | + |
| 45 | +```markdoc |
| 46 | +{% badge text="Hinweis" variant="note" /%} |
| 47 | +{% badge text="Erfolg" variant="success" /%} |
| 48 | +{% badge text="Tipp" variant="tip" /%} |
| 49 | +{% badge text="Warnung" variant="caution" /%} |
| 50 | +{% badge text="Gefahr" variant="danger" /%} |
| 51 | +``` |
| 52 | + |
| 53 | +</Fragment> |
| 54 | + |
| 55 | +<Fragment slot="preview"> |
| 56 | + <Badge text="Hinweis" variant="note" /> |
| 57 | + <Badge text="Erfolg" variant="success" /> |
| 58 | + <Badge text="Tipp" variant="tip" /> |
| 59 | + <Badge text="Warnung" variant="caution" /> |
| 60 | + <Badge text="Gefahr" variant="danger" /> |
| 61 | +</Fragment> |
| 62 | + |
| 63 | +</Preview> |
| 64 | + |
| 65 | +### Verschiedene Größen verwenden |
| 66 | + |
| 67 | +Verwende das Attribut [`size`](#size), um die Größe des Abzeichentextes zu steuern. |
| 68 | + |
| 69 | +<Preview> |
| 70 | + |
| 71 | +```mdx /size="\w+"/ |
| 72 | +import { Badge } from '@astrojs/starlight/components'; |
| 73 | + |
| 74 | +<Badge text="Neu" size="small" /> |
| 75 | +<Badge text="Neu und verbessert" size="medium" /> |
| 76 | +<Badge text="Neu, verbessert und größer" size="large" /> |
| 77 | +``` |
| 78 | + |
| 79 | +<Fragment slot="markdoc"> |
| 80 | + |
| 81 | +```markdoc /size="\w+"/ |
| 82 | +{% badge text="Neu" size="small" /%} |
| 83 | +{% badge text="Neu und verbessert" size="medium" /%} |
| 84 | +{% badge text="Neu, verbessert und größer" size="large" /%} |
| 85 | +``` |
| 86 | + |
| 87 | +</Fragment> |
| 88 | + |
| 89 | +<Fragment slot="preview"> |
| 90 | + <Badge text="Neu" size="small" /> |
| 91 | + <Badge text="Neu und verbessert" size="medium" /> |
| 92 | + <Badge text="Neu, verbessert und größer" size="large" /> |
| 93 | +</Fragment> |
| 94 | + |
| 95 | +</Preview> |
| 96 | + |
| 97 | +### Abzeichen anpassen |
| 98 | + |
| 99 | +Passe Abzeichen an, indem du andere `<span>`-Attribute wie `class` oder `style` mit benutzerdefiniertem CSS verwendest. |
| 100 | + |
| 101 | +<Preview> |
| 102 | + |
| 103 | +```mdx "style={{ fontStyle: 'italic' }}" |
| 104 | +import { Badge } from '@astrojs/starlight/components'; |
| 105 | + |
| 106 | +<Badge text="Individuell" variant="success" style={{ fontStyle: 'italic' }} /> |
| 107 | +``` |
| 108 | + |
| 109 | +<Fragment slot="markdoc"> |
| 110 | + |
| 111 | +```markdoc 'style="font-style: italic;"' |
| 112 | +{% badge text="Individuell" variant="success" style="font-style: italic;" /%} |
| 113 | +``` |
| 114 | + |
| 115 | +</Fragment> |
| 116 | + |
| 117 | +<Badge |
| 118 | + slot="preview" |
| 119 | + text="Individuell" |
| 120 | + variant="success" |
| 121 | + style={{ fontStyle: 'italic' }} |
| 122 | +/> |
| 123 | + |
| 124 | +</Preview> |
| 125 | + |
| 126 | +## `<Badge>`-Eigenschaften |
| 127 | + |
| 128 | +**Implementation:** [`Badge.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Badge.astro) |
| 129 | + |
| 130 | +Die `<Badge>`-Komponente akzeptiert die folgenden Eigenschaften und auch alle [anderen `<span>`-Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes): |
| 131 | + |
| 132 | +### `text` |
| 133 | + |
| 134 | +**Erforderlich** |
| 135 | +**Typ:** `string` |
| 136 | + |
| 137 | +Der Textinhalt, der in dem Abzeichen angezeigt werden soll. |
| 138 | + |
| 139 | +### `variant` |
| 140 | + |
| 141 | +**Typ:** `'note' | 'danger' | 'success' | 'caution' | 'tip' | 'default'` |
| 142 | +**Voreinstellung:** `'default'` |
| 143 | + |
| 144 | +Die zu verwendende Farbvariante des Abzeichens: `note` (blau), `tip` (lila), `danger` (rot), `caution` (orange), `success` (grün) oder `default` (Akzentfarbe des Aussehens). |
| 145 | + |
| 146 | +### `size` |
| 147 | + |
| 148 | +**Typ:** `'small' | 'medium' | 'large'` |
| 149 | + |
| 150 | +Bestimmt die Größe des anzuzeigenden Abzeichens. |
0 commit comments