Ersetzung von Komponenten Referenz

Du kannst Starlights eingebaute Komponenten überschreiben, indem du Pfade zu Ersatzkomponenten in Starlights components-Konfigurationsoption angibst. Diese Seite listet alle Komponenten auf, die überschrieben werden können, und verweist auf ihre Standardimplementierungen auf GitHub.

Erfahre mehr in der Anleitung zum Überschreiben von Komponenten.

Komponenteneigenschaften (Props)

Alle Komponenten können auf ein Standardobjekt Astro.props zugreifen, welches Informationen über die aktuelle Seite enthält.

Um deine eigenen Komponenten zu schreiben, importiere den Props-Typ von Starlight:

---
import type { Props } from '@astrojs/starlight/props';

const { hasSidebar } = Astro.props;
//      ^ Typ: boolean
---

So erhaltest du die Autovervollständigung und Angabe des Datentyps beim Zugriff auf Astro.props.

Eigenschaften

Starlight wird die folgenden Props an deine eigenen Komponenten übergeben.

`dir`

Typ: 'ltr' | 'rtl'

Schreibrichtung der Seite.

`lang`

Typ: string

BCP-47-Sprachkennzeichen für das Gebietsschema dieser Seite, z.B. de, zh-CN oder pt-BR.

`locale`

Typ: string | undefined

Der Basispfad, unter dem eine Sprache angeboten wird. undefined für Root-Locale-Slugs.

`siteTitle`

Typ: string

Der Seitentitel für das Gebietsschema dieser Seite.

`siteTitleHref`

Typ: string

Der Wert für das Attribut href des Seitentitels, der auf die Homepage zurückverweist, z. B. /. Bei mehrsprachigen Websites wird hier das aktuelle Gebietsschema angegeben, z. B. /en/ oder /zh-cn/.

`slug`

Typ: string

Der aus dem Dateinamen des Inhalts generierte Slug für diese Seite.

Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version von Starlight entfernt werden. Stelle auf die neue Content Layer API um, indem du Starlights docsLoader benutzt und verwende stattdessen die Eigenschaft id.

`id`

Typ: string

Der Slug für diese Seite oder die eindeutige ID für diese Seite, die auf dem Dateinamen des Inhalts basiert, wenn du das Flag legacy.collections benutzt.

`isFallback`

Typ: true | undefined

true, wenn diese Seite in der aktuellen Sprache unübersetzt ist und Fallback-Inhalte aus dem Standardgebietsschema verwendet. Wird nur in mehrsprachigen Sites verwendet.

`entryMeta`

Typ: { dir: 'ltr' | 'rtl'; lang: string }

Gebietsschema-Metadaten für den Seiteninhalt. Du kannst von den Werten der Top-Level-Locale unterscheiden, wenn eine Seite Fallback-Inhalte verwendet.

`entry`

Der Astro-Inhaltssammlungseintrag für die aktuelle Seite. Beinhaltet Frontmatter-Werte für die aktuelle Seite in entry.data.

entry: {
  data: {
    title: string;
    description: string | undefined;
    // usw.
  }
}

Erfahre mehr über die Form dieses Objekts in der Astros Eintragstyp-Sammlung Referenz.

`sidebar`

Typ: SidebarEntry[]

Seitennavigationseinträge für diese Seite.

`hasSidebar`

Typ: boolean

Ob die Seitenleiste auf dieser Seite angezeigt werden soll oder nicht.

`pagination`

Typ: { prev?: Link; next?: Link }

Links zur vorherigen und nächsten Seite in der Seitenleiste, falls aktiviert.

`toc`

Typ: { minHeadingLevel: number; maxHeadingLevel: number; items: TocItem[] } | undefined

Inhaltsverzeichnis für diese Seite, falls aktiviert.

`headings`

Typ: { depth: number; slug: string; text: string }[]

Array aller Markdown-Überschriften, die aus der aktuellen Seite extrahiert wurden. Verwende stattdessen toc, wenn du einen Inhaltsverzeichnis-Komponenten erstellen willst, welches die Konfigurationsoptionen von Starlight berücksichtigt.

`lastUpdated`

Typ: Date | undefined

JavaScript Date Objekt, welches angibt, wann diese Seite zuletzt aktualisiert wurde, falls aktiviert.

`editUrl`

Typ: URL | undefined

URL-Objekt für die Adresse, unter der diese Seite bearbeitet werden kann, falls aktiviert.

Komponenten

Head

Diese Komponenten werden innerhalb des <head>-Elements jeder Seite gerendert. Sie sollten nur innerhalb von <head> erlaubte Elemente enthalten.

`Head`

Standardkomponente: Head.astro

Diese Komponente wird innerhalb des <head> einer jeden Seite gerendert. Enthält wichtige Tags wie <title>, und <meta charset="utf-8">.

Überschreibe diese Komponente nur, wenn es unbedingt notwendig ist. Bevorzuge die head Option der Starlight-Konfiguration wenn möglich.

`ThemeProvider`

Standardkomponente: ThemeProvider.astro

Diese Komponente wird innerhalb von <head> gerendert und richtet die Unterstützung für dunkle/helle Themen ein. Die Standard-Implementierung enthält ein Inline-Skript und ein <template>, welches vom Skript in <ThemeSelect /> verwendet wird.

Barrierefreiheit

`SkipLink`

Standardkomponente: SkipLink.astro

Diese Komponente wird als erstes Element innerhalb von <body> dargestellt und verweist aus Gründen der Barrierefreiheit auf den Hauptinhalt der Seite. Die Standardimplementierung ist ausgeblendet, bis ein Benutzer sie durch Tabulatorbewegungen mit der Tastatur aktiviert.

Layout

Diese Komponenten sind für das Layout der Starlight-Komponenten und die Verwaltung von Ansichten über verschiedene Haltepunkte hinweg verantwortlich. Das Überschreiben dieser Komponenten ist mit erheblicher Komplexität verbunden. Wenn möglich, bevorzuge das Überschreiben einer Komponente auf einer niedrigeren Ebene.

`PageFrame`

Standardkomponente: PageFrame.astro
Benannte Slots: header, sidebar

Diese Layout-Komponente beinhaltet den größten Teil des Seiteninhalts. Die Standardimplementierung konfiguriert das Kopfzeilen-Seitennavigation-Haupt-Layout und beinhaltet header und sidebar benannte Slots zusammen mit einem Standard-Slot für den Hauptinhalt. Sie rendert auch <MobileMenuToggle />, um das Umschalten der Seitenleistennavigation auf kleinen (mobilen) Viewports zu unterstützen.

`MobileMenuToggle`

Standardkomponente: MobileMenuToggle.astro

Diese Komponente wird innerhalb von <PageFrame> gerendert und ist für das Umschalten der Seitenleistennavigation auf kleinen (mobilen) Viewports verantwortlich.

`TwoColumnContent`

Standardkomponente: TwoColumnContent.astro
Benannter Slot: right-sidebar

Dies ist die Layout-Komponente, welche die Hauptinhaltsspalte und die rechte Seitenleiste (Inhaltsverzeichnis) beinhaltet. Die Standardimplementierung behandelt den Wechsel zwischen einem einspaltigen Layout mit kleinem Sichtfeld und einem zweispaltigen Layout mit größerem Sichtfeld.

Kopfzeile

Diese Komponenten stellen die obere Navigationsleiste von Starlight dar.

`Header`

Standardkomponente: Header.astro

Dies ist eine Kopfzielen-Komponente, welche oben auf jeder Seite angezeigt wird. Die Standardimplementierung zeigt <SiteTitle />, <Search />, <SocialIcons />, <ThemeSelect />, und <LanguageSelect />.

`SiteTitle`

Standardkomponente: SiteTitle.astro

Die Komponente wird die am Anfang des Site-Headers gerendert, um den Titel der Website darzustellen. Die Standardimplementierung enthält die Logik für die Darstellung von Logos, die in der Starlight-Konfiguration definiert sind.

`Search`

Standardkomponente: Search.astro

Diese Komponente wird verwendet, um Starlights Suchoberfläche darzustellen. Die Standardimplementierung enthält die Schaltfläche in der Kopfzeile und den Code für die Anzeige eines Suchmodals, wenn darauf geklickt wird, und das Laden von Pagefinds UI.

Wenn pagefind deaktiviert ist, wird die Standard-Suchkomponente nicht angezeigt. Wenn du jedoch Search überschreibst, wird deine benutzerdefinierte Komponente immer angezeigt, auch wenn die Konfigurationsoption pagefind auf false gesetzt ist. So kannst du eine Benutzeroberfläche für alternative Suchanbieter hinzufügen, wenn du Pagefind deaktivierst.

`SocialIcons`

Standardkomponente: SocialIcons.astro

Diese Komponente wird in der Kopfzeile der Website gerendert und enthält Links zu sozialen Symbolen. Die Standardimplementierung verwendet die Option social in der Starlight-Konfiguration, um Icons und Links darzustellen.

`ThemeSelect`

Standardkomponente: ThemeSelect.astro

Diese Komponente wird in der Kopfzeile der Website gerendert und ermöglicht es den Benutzern, ihr bevorzugtes Farbschema auszuwählen.

`LanguageSelect`

Standardkomponente: LanguageSelect.astro

Die Komponente wird in der Kopfzeile der Website angezeigt und ermöglicht es den Nutzern, die Sprache auszuwählen.

Globale Seitenleiste

Die globale Seitenleiste von Starlight enthält die Hauptnavigation der Website. Bei schmalen Ansichtsfenstern ist diese hinter einem Dropdown-Menü versteckt.

`Sidebar`

Standardkomponente: Sidebar.astro

Die Komponente wird die vor dem Seiteninhalt gerendert und enthält eine globale Navigation. Die Standardimplementierung wird als Seitenleiste in ausreichend breiten Ansichtsfenstern und innerhalb eines Dropdown-Menüs in kleinen (mobilen) Ansichtsfenstern angezeigt. Sie rendert auch <MobileMenuFooter />, um zusätzliche Elemente innerhalb des mobilen Menüs anzuzeigen.

`MobileMenuFooter`

Standardkomponente: MobileMenuFooter.astro

Diese Komponente wird die am unteren Ende des mobilen Dropdown-Menüs gerendert. Die Standardimplementierung rendert <ThemeSelect /> und <LanguageSelect />.

Seitenleiste des Inhalts

Die Seitenleiste von Starlight ist für die Anzeige eines Inhaltsverzeichnisses verantwortlich, welches die Untertitel der aktuellen Seite anzeigt. Bei schmalen Ansichtsfenstern wird diese Leiste zu einem Dropdown-Menü.

`PageSidebar`

Standardkomponente: PageSidebar.astro

Diese Komponente wird die vor dem Inhalt der Hauptseite gerendert, um ein Inhaltsverzeichnis anzuzeigen. Die Standardimplementierung rendert <TableOfContents /> und <MobileTableOfContents />.

`TableOfContents`

Standardkomponente: TableOfContents.astro

Eine Komponente zur Darstellung des Inhaltsverzeichnisses der aktuellen Seite in breiteren Ansichtsfenstern.

`MobileTableOfContents`

Standardkomponente: MobileTableOfContents.astro

Diese Komponete zeigt das Inhaltsverzeichnis der aktuellen Seite auf kleinen (mobilen) Bildschirmen an.

Inhalt

Folgende Komponenten werden in der Hauptspalte des Seiteninhalts wiedergegeben.

`Banner`

Standardkomponente: Banner.astro

Diese Bannerkomponente wird oben auf jeder Seite angezeigt. Die Standard-Implementierung verwendet den banner-Frontmatter-Wert der Seite, um zu entscheiden, ob sie gerendert wird oder nicht.

`ContentPanel`

Standardkomponente: ContentPanel.astro

Diese Layout-Komponente beinhaltet Abschnitte der Hauptinhaltsspalte.

`PageTitle`

Standardkomponente: PageTitle.astro

Eine Komponente, welche das <h1>-Element für die aktuelle Seite enthält.

Implementierungen sollten sicherstellen, dass sie id="_top" auf dem <h1> Element wie in der Standardimplementierung setzen.

`DraftContentNotice`

Standardkomponente: DraftContentNotice.astro

Hinweis, der den Nutzern während der Entwicklung angezeigt wird, wenn die aktuelle Seite als Entwurf markiert ist.

`FallbackContentNotice`

Standardkomponente: FallbackContentNotice.astro

Ein Hinweis, welcher den Benutzern auf der Website angezeigt wird, für die keine Übersetzung in der aktuellen Sprache verfügbar ist. Wird nur auf mehrsprachigen Seiten verwendet.

`Hero`

Standardkomponente: Hero.astro

Diese Komponente wird am oberen Rand der Seite angezeigt, wenn hero in frontmatter eingestellt ist. Die Standardimplementierung zeigt einen großen Titel, eine Tagline und Call-to-Action-Links neben einem optionalen Bild.

`MarkdownContent`

Standardkomponente: MarkdownContent.astro

Die Kompoente wird um den Hauptinhalt jeder Seite gerendert. Die Standardimplementierung richtet grundlegende Stile ein, die auf Markdown-Inhalte angewendet werden.

Die Markdown-Inhaltsstile werden auch in der Datei @astrojs/starlight/style/markdown.css veröffentlicht und auf die CSS-Klasse .sl-markdown-content bezogen.

Fußzeile

Diese Komponenten werden am unteren Ende der Hauptspalte des Seiteninhalts dargestellt.

`Footer`

Standardkomponente: Footer.astro

Diese Fußzeile-Komponente wird am unteren Rand jeder Seite angezeigt. Die Standardimplementierung zeigt <LastUpdated />, <Pagination />, und <EditLink />.

`LastUpdated`

Standardkomponente: LastUpdated.astro

Eine Komponente, die in der Fußzeile der Seite gerendert wird, um das zuletzt aktualisierte Datum anzuzeigen.

`EditLink`

Standardkomponente: EditLink.astro

Die Komponente wird in der Fußzeile der Seite gerendert, um einen Link anzuzeigen, über den die Seite bearbeitet werden kann.

`Pagination`

Standardkomponente: Pagination.astro

Diese Komponente wird in der Fußzeile der Seite gerendert, um Navigationspfeile zwischen vorherigen/nächsten Seiten anzuzeigen.