Widget
Incorpore uma demonstração ao vivo do widget Novidades nos seus docs com o componente MDX Widget: um botão que abre seu changelog em um modal, sem precisar de tag script.
<Widget> adiciona um gatilho ao vivo de Novidades diretamente em uma página de documentação. Ao clicar, seu changelog Jamdesk abre no mesmo modal que seus clientes veem quando você incorpora o widget no seu app. Aqui você escreve uma única tag MDX em vez de um <script>. A página resolve seu site automaticamente.
Início rápido
<Widget />
Isso renderiza um botão que abre /changelog (o caminho padrão) em um modal. Defina page com a rota do seu changelog se ele estiver em outro lugar. Um caminho errado abre um 404 no modal. (O changelog da própria Jamdesk está em /reference/changelog, por exemplo.)
<Widget page="/reference/changelog" label="What's new" />
<Widget> resolve sozinho sua origem canônica *.jamdesk.app. Funciona da mesma forma em um subdomínio jamdesk.app ou em um domínio personalizado. O modal sempre carrega a partir do subdomínio, pois é a única origem capaz de renderizar a visualização incorporada.
Propriedades
| Propriedade | Tipo | Padrão | Finalidade |
|---|---|---|---|
page | string | /changelog | Caminho da documentação que o modal abre. |
label | string | O que há de novo | Texto do botão de gatilho. |
theme | auto | light | dark | auto | Esquema de cores do modal. |
trigger | seletor CSS | (nenhum) | Vincula a um elemento seu em vez de renderizar um botão. |
width / height | comprimento CSS | 560px / 680px | Tamanho do modal. |
radius | comprimento CSS | 12px | Raio dos cantos do modal. |
unread | boolean | true | Mostra o ponto de não lido. Defina false para ocultar. |
unreadColor | hex / cor CSS | #e5484d | Cor do ponto de não lido. |
project | string | derivado | Substitui a chave armazenada de "visto". |
Aponte trigger para um elemento já presente na página. Um seletor que não corresponde a nada faz o widget recorrer ao seu próprio lançador flutuante no canto.
O estado "visto" do ponto de não lido é armazenado por navegador e por origem (a página em que o widget roda). O estado de visto nos seus docs e no seu app é rastreado separadamente, e eles não sincronizam. Defina unread={false} em um botão de demonstração para omitir o ponto.
Exemplo ao vivo
Este botão abre o modal no site de docs publicado. Lá, <Widget> se vincula à sua origem canônica *.jamdesk.app. A pré-visualização local com jamdesk dev não tem origem publicada para carregar o modal, então o gatilho não abre ali e exibe uma legenda "Pré-visualização ao vivo" ao lado do botão. Publique a página (ou abra-a no seu site ao vivo) para testar.
