Widget
Incrusta una demo del widget What's New en tus docs con el componente MDX Widget: un botón que abre tu changelog en un modal, sin script.
<Widget> coloca un trigger de What's New activo directamente en una página de docs. Haz clic y tu changelog de Jamdesk se abre en el mismo modal que ven tus clientes cuando incrustas el widget en tu app. La diferencia: aquí escribes una etiqueta MDX en lugar de un <script>, y la página resuelve tu sitio automáticamente.
Inicio rápido
<Widget />Eso renderiza un botón que abre /changelog (la ruta predeterminada) en un modal. Si tu changelog está en otro lugar, define page con su ruta real, o el modal abrirá un 404. (El changelog de Jamdesk mismo está en /reference/changelog, por ejemplo.)
<Widget page="/reference/changelog" label="What's new" /><Widget> resuelve tu origen canónico *.jamdesk.app por sí solo, así que funciona igual sin importar si tus docs están en un subdominio jamdesk.app o en un dominio personalizado. El modal siempre carga desde el subdominio, que es el único origen que puede renderizar la vista incrustada.
Props
| Prop | Type | Default | Purpose |
|---|---|---|---|
page | string | /changelog | Ruta de docs que abre el modal. |
label | string | What's new | Texto del botón trigger. |
theme | auto | light | dark | auto | Esquema de color del modal. |
trigger | CSS selector | (none) | Enlázalo a tu propio elemento en lugar de renderizar un botón. |
width / height | CSS length | 560px / 680px | Tamaño del modal. |
radius | CSS length | 12px | Radio de esquina del modal. |
unread | boolean | true | Muestra el punto de no leído. Define false para ocultarlo. |
unreadColor | hex / CSS color | #e5484d | Color del punto de no leído. |
project | string | derived | Sobrescribe la clave "visto" almacenada. |
Cuando defines trigger, asegúrate de que el selector coincida con un elemento ya presente 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), así que el estado visto de un visitante en tus docs y en tu app se rastrean por separado. No se sincronizan. Para un botón de demo, define unread={false} para omitir el punto por completo.
Ejemplo en vivo
Este botón abre el modal en el sitio de docs desplegado, donde <Widget> se enlaza a tu origen canónico *.jamdesk.app. En el preview local de jamdesk dev no hay un origen publicado desde el cual cargar el modal, así que el trigger no puede abrirse. En su lugar, muestra un texto "Live preview" junto al botón. Despliega la página (o ábrela en tu sitio en vivo) para probar la funcionalidad real.