Jamdesk Documentation logo

Panel

Verwenden Sie Panel, um eigene Inhalte wie Warnungen oder Kurzreferenzen in der Seitenleiste anzuheften, wo sie beim Scrollen sichtbar bleiben.

Panel zeigt eigene Inhalte in der rechten Seitenleiste an, anstelle des Inhaltsverzeichnisses. Die Inhalte bleiben beim Scrollen sichtbar. Verwenden Sie es für Kurzreferenzen, wichtige Warnungen oder Support-Links.

Verwenden Sie Panel, wenn:

  • Kritische Informationen beim Scrollen nicht aus dem Blick geraten sollen
  • Kurzreferenzen den Hauptinhalt ergänzen
  • Dauerhafte Handlungsaufforderungen sichtbar bleiben müssen (Support-Links, API-Schlüssel)

Diese Notiz wird im Seitenleisten-Panel angezeigt!

Scrollen Sie nach unten, um zu sehen, dass das Panel sichtbar bleibt.

Grundlegende Verwendung

Umschließen Sie Inhalte mit einem Panel, um sie in der rechten Seitenleiste anzuzeigen:

<Panel>
  <Info>This content appears in the sidebar!</Info>
</Panel>

Häufige Anwendungsfälle

Ein Panel kann angeheftete Warnungen, Kurzreferenz-Karten und Support-Links enthalten:

<Panel>
  <Warning>

    API rate limits: 100 requests/minute

</Warning>
  <Card title="Quick Reference" icon="list">

    **Methods:** GET, POST, PUT, DELETE
    **Auth:** Bearer token required

</Card>
  <Card title="Need Help?" icon="circle-question" href="https://example.com/support">

    Contact our support team

</Card>
</Panel>

Wann Sie Panel NICHT verwenden sollten

  • Kurze Seiten: Das Inhaltsverzeichnis hilft Lesern bei der Navigation. Ersetzen Sie es nur durch etwas wertvolleres
  • Standarddokumentation: Die meisten Seiten funktionieren mit dem Standard-Inhaltsverzeichnis besser
  • Mobilgeräte: Panel-Inhalte sind auf kleineren Bildschirmen ausgeblendet. Platzieren Sie wichtige Informationen auch im Hauptinhalt

Verhalten

  • Erscheint auf dem Desktop in der rechten Seitenleiste (ab 1280px), auf kleineren Bildschirmen ausgeblendet
  • Ein Panel pro Seite. Es ersetzt das Inhaltsverzeichnis
  • Nimmt beliebige Komponenten auf: Callouts, Cards, CodeGroup, Accordions usw.

Wie geht es weiter?

Komponenten-Übersicht

Alle verfügbaren Komponenten durchsuchen

MDX-Grundlagen

Erfahren Sie, wie Sie Komponenten in MDX verwenden