Jamdesk Documentation logo

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

PropriedadeTipoPadrãoFinalidade
pagestring/changelogCaminho da documentação que o modal abre.
labelstringO que há de novoTexto do botão de gatilho.
themeauto | light | darkautoEsquema de cores do modal.
triggerseletor CSS(nenhum)Vincula a um elemento seu em vez de renderizar um botão.
width / heightcomprimento CSS560px / 680pxTamanho do modal.
radiuscomprimento CSS12pxRaio dos cantos do modal.
unreadbooleantrueMostra o ponto de não lido. Defina false para ocultar.
unreadColorhex / cor CSS#e5484dCor do ponto de não lido.
projectstringderivadoSubstitui 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.

O que vem a seguir?

Incorpore no seu app

O trecho <script> para colocar o widget no seu próprio produto

Componente Update

Escreva as entradas do changelog que o widget lê

Código-fonte do Widget

Fixe uma versão, hospede você mesmo ou leia o código-fonte no GitHub