Widget
Incrusta una demo en vivo del widget "Novedades" en tu documentación con el componente MDX Widget: un botón que abre tu changelog en un modal, sin necesidad de etiqueta script.
<Widget> inserta un activador en vivo de "Novedades" directamente en una página de documentación. Al hacer clic, tu changelog de Jamdesk se abre en el mismo modal que tus clientes ven cuando incrustas el widget en tu aplicación — excepto que aquí escribes una sola etiqueta MDX en lugar de un <script>, y la página resuelve tu sitio automáticamente.
Inicio rápido
<Widget />Esto renderiza un botón que abre /changelog (la ruta predeterminada) en un modal. Si tu changelog está en otra ubicación, establece page con su ruta real, o el modal abrirá un 404. (El changelog propio de Jamdesk está en /reference/changelog, por ejemplo.)
<Widget page="/reference/changelog" label="What's new" /><Widget> resuelve tu origen canónico *.jamdesk.app de forma automática, por lo que funciona igual tanto si tu documentación está en un subdominio jamdesk.app como en un dominio personalizado. El modal siempre carga desde el subdominio, que es el único origen que puede renderizar la vista incrustada.
Props
| Prop | Tipo | Valor predeterminado | Descripción |
|---|---|---|---|
page | string | /changelog | Ruta de la documentación que abre el modal. |
label | string | What's new | Texto del botón activador. |
theme | auto | light | dark | auto | Esquema de colores del modal. |
trigger | Selector CSS | (ninguno) | Vincula a tu propio elemento en lugar de renderizar un botón. |
width / height | Longitud CSS | 560px / 680px | Tamaño del modal. |
radius | Longitud CSS | 12px | Radio de las esquinas del modal. |
unread | boolean | true | Muestra el punto de no leído. Establece false para ocultarlo. |
unreadColor | hex / color CSS | #e5484d | Color del punto de no leído. |
project | string | derivado | Reemplaza la clave "visto" almacenada. |
Cuando estableces trigger, asegúrate de que el selector coincida con un elemento que ya esté en la página. Si no coincide con nada, el widget recurre a su propio lanzador flotante en la esquina en lugar de no hacer nada.
El estado "visto" del punto de no leído se almacena por navegador y por origen (la página donde se ejecuta el widget), por lo que el estado visto de un visitante en tu documentación y en tu aplicación se rastrean por separado. No se sincronizan. Para un botón de demo, establece unread={false} para omitir el punto por completo.