Widget
Incorpora nella documentazione una demo dal vivo del widget Novità tramite il componente MDX Widget: un pulsante che apre il changelog in un modal, senza bisogno di tag script.
<Widget> inserisce direttamente in una pagina della documentazione un pulsante live per le Novità. Cliccandolo si apre il tuo changelog Jamdesk nello stesso modal che i tuoi clienti vedono quando incorpori il widget nella tua app. Qui scrivi un solo tag MDX invece di uno <script>. La pagina risolve automaticamente il tuo sito.
Avvio rapido
<Widget />Viene visualizzato un pulsante che apre /changelog (il percorso predefinito) in un modal. Imposta page sul percorso del tuo changelog se si trova altrove. Un percorso errato apre una 404 nel modal. (Il changelog di Jamdesk, ad esempio, si trova in /reference/changelog.)
<Widget page="/reference/changelog" label="What's new" /><Widget> risolve da solo la tua origine canonica *.jamdesk.app. Funziona allo stesso modo su un sottodominio jamdesk.app o su un dominio personalizzato. Il modal si carica sempre dal sottodominio, unica origine in grado di mostrare la vista incorporata.
Proprietà
| Prop | Tipo | Predefinito | Scopo |
|---|---|---|---|
page | string | /changelog | Percorso della documentazione che il modal apre. |
label | string | Novità | Testo del pulsante di attivazione. |
theme | auto | light | dark | auto | Schema di colori del modal. |
trigger | selettore CSS | (nessuno) | Collega un tuo elemento invece di mostrare un pulsante. |
width / height | lunghezza CSS | 560px / 680px | Dimensioni del modal. |
radius | lunghezza CSS | 12px | Raggio degli angoli del modal. |
unread | boolean | true | Mostra il punto di non letto. Imposta false per nasconderlo. |
unreadColor | hex / colore CSS | #e5484d | Colore del punto di non letto. |
project | string | derivato | Sostituisce la chiave "visto" memorizzata. |
Punta trigger a un elemento già presente nella pagina. Un selettore che non corrisponde a nulla fa ricadere il widget sul proprio launcher flottante nell'angolo.
Lo stato "visto" del punto di non letto viene memorizzato per browser e per origine (la pagina su cui gira il widget). Lo stato di un visitatore nella documentazione e nella tua app viene tracciato separatamente e non si sincronizza. Imposta unread={false} su un pulsante demo per saltare il punto.
Esempio live
Questo pulsante apre il modal sul sito di documentazione pubblicato. Lì <Widget> si collega alla tua origine canonica *.jamdesk.app. In anteprima locale con jamdesk dev non esiste un'origine pubblicata da cui caricare il modal: il pulsante non può aprirlo e mostra accanto una didascalia "Anteprima live". Pubblica la pagina (o aprila sul tuo sito live) per provarlo.