Widget
Binden Sie eine Live-Demo des What's-New-Widgets mit der MDX-Komponente Widget in Ihre Dokumentation ein: ein Auslöser-Button öffnet Ihr Changelog in einem Modal, ohne Script-Tag.
<Widget> fügt einen Live-What's-New-Auslöser direkt in eine Dokumentationsseite ein. Ein Klick öffnet Ihr Jamdesk-Changelog im selben Modal, das Ihre Kunden sehen, wenn Sie das Widget in Ihre App einbetten. Hier schreiben Sie statt eines <script> nur ein MDX-Tag. Die Seite ermittelt Ihre Site automatisch.
Schnellstart
<Widget />Das rendert einen Button, der /changelog (den Standardpfad) in einem Modal öffnet. Setzen Sie page auf die Route Ihres Changelogs, falls es woanders liegt. Ein falscher Pfad zeigt im Modal eine 404-Seite. (Das Changelog von Jamdesk selbst liegt z. B. unter /reference/changelog.)
<Widget page="/reference/changelog" label="What's new" /><Widget> ermittelt Ihren kanonischen *.jamdesk.app-Ursprung selbstständig. Es funktioniert auf einer jamdesk.app-Subdomain oder einer eigenen Domain gleichermaßen. Das Modal lädt immer von der Subdomain. Nur dieser Ursprung kann die eingebettete Ansicht rendern.
Props
| Prop | Typ | Standard | Zweck |
|---|---|---|---|
page | string | /changelog | Dokumentationspfad, den das Modal öffnet. |
label | string | What's new | Text des Auslöser-Buttons. |
theme | auto | light | dark | auto | Farbschema des Modals. |
trigger | CSS-Selektor | (keiner) | An Ihr eigenes Element binden, statt einen Button zu rendern. |
width / height | CSS-Länge | 560px / 680px | Größe des Modals. |
radius | CSS-Länge | 12px | Eckenradius des Modals. |
unread | boolean | true | Den Ungelesen-Punkt anzeigen. false setzen, um ihn zu verbergen. |
unreadColor | Hex / CSS-Farbe | #e5484d | Farbe des Ungelesen-Punkts. |
project | string | abgeleitet | Den gespeicherten „gesehen“-Schlüssel überschreiben. |
Richten Sie trigger auf ein Element, das bereits auf der Seite steht. Ein Selektor, der nichts trifft, lässt das Widget auf seinen eigenen schwebenden Launcher in der Ecke zurückfallen.
Der „gesehen“-Status des Ungelesen-Punkts wird pro Browser und pro Ursprung (die Seite, auf der das Widget läuft) gespeichert. Der Gesehen-Status eines Besuchers auf Ihrer Dokumentation und in Ihrer App wird getrennt verfolgt. Sie synchronisieren sich nicht. Setzen Sie unread={false} auf einem Demo-Button, um den Punkt wegzulassen.
Live-Beispiel
Dieser Button öffnet das Modal auf der veröffentlichten Dokumentationsseite. Dort bindet sich <Widget> an Ihren kanonischen *.jamdesk.app-Ursprung. In der lokalen Vorschau mit jamdesk dev gibt es keinen veröffentlichten Ursprung, von dem das Modal geladen werden könnte. Der Auslöser lässt sich dort nicht öffnen und zeigt stattdessen neben dem Button die Beschriftung „Live-Vorschau“. Veröffentlichen Sie die Seite (oder öffnen Sie sie auf Ihrer Live-Site), um es auszuprobieren.