Insertar páginas en línea

Shayan TaslimActualizado

Las inserciones muestran tus páginas públicas de UserJot dentro de tu propio diseño, en lugar de hacerlo mediante un widget flotante. Puedes insertar tus tablones de comentarios, hoja de ruta, registro de cambios y centro de ayuda. La sección Mensajes de Conversaciones solo está disponible en el widget y no se puede insertar.

Configuración básica

Añade un elemento contenedor a tu página:

HTML
<div data-userjot-embed style="height: 700px"></div>

A continuación, inicializa el SDK y monta la inserción:

JavaScript
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();

La inserción ocupa todo el contenedor, así que establece la altura del contenedor con CSS. Pasar widget: false desactiva el widget flotante; también puedes dejarlo activado para usar ambos a la vez.

Opciones y rutas compatibles

JavaScript
uj.createEmbed({
  container: '#my-container', // CSS selector or DOM element, default '[data-userjot-embed]'
  path: '/roadmap',           // initial page, default '/'
  theme: 'auto'               // 'auto', 'light', or 'dark'
});

Valores válidos de path:

Ruta

Qué muestra

/ (o /feedback)

Tu tablón de comentarios predeterminado

/feedback/<board-slug>

Un tablón público específico

/feedback/p/<post-slug>

Una publicación específica de comentarios

/roadmap

Hoja de ruta pública

/updates

Índice del registro de cambios

/updates/<slug>

Una actualización específica del registro de cambios

/help

Página de inicio del centro de ayuda (cuando esté publicado)

/help/collections/<slug>

Una colección específica del centro de ayuda

/help/articles/<slug>

Un artículo específico del centro de ayuda

Las rutas heredadas /board/<board-slug> y /board/p/<post-slug> redirigen a /feedback/<board-slug> y /feedback/p/<post-slug>.

Controlar un embed

uj.createEmbed devuelve un controlador cuando se carga el script del SDK:

JavaScript
const embed = uj.createEmbed({ path: '/' });

embed.navigate('/roadmap'); // switch to another page
embed.destroy();            // unmount the embed

Sincronizar con tu URL

Pasa basePath para que la inserción mantenga sincronizada la URL del navegador mientras los usuarios navegan:

JavaScript
uj.createEmbed({
  container: '#feedback-page',
  basePath: '/feedback'
});

Con basePath: '/feedback', la página principal de comentarios permanece en /feedback; al abrir una publicación, se actualiza la URL del navegador a /feedback/feedback/p/<post-slug>, y al cargar esa URL directamente, el contenido incrustado se abre en esa publicación.

Para que funcionen los enlaces profundos, configura el enrutador de tu aplicación para que tanto /feedback como /feedback/* muestren la página que llama a uj.createEmbed.

La identidad se transfiere automáticamente

Llamar a uj.identify inicia sesión del usuario en todas las inserciones de la página (incluidas las que se creen más tarde), y uj.logout cierra su sesión.

Como el inicio de sesión de los usuarios en páginas insertadas se realiza mediante Inicio de sesión automático, asegúrate de que la opción Inicio de sesión automático esté activada en Configuración → Inicio de sesión (plan Starter o Professional). Si no lo está, las inserciones se cargarán con la sesión cerrada, incluso si pasas una identidad autenticada.

JavaScript
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();

Varios embeds

Monta varias inserciones en la misma página asignando a cada una su propio contenedor y ruta:

JavaScript
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });

¿Embed o widget?

  • Usa el widget cuando quieras que los comentarios, la ayuda, las novedades y los mensajes estén a un clic de distancia desde cualquier lugar de tu aplicación.

  • Usa una inserción cuando quieras una página dedicada dentro de tu propio diseño, como yourapp.com/feedback o yourapp.com/help.

Muchos productos usan ambos. Consulta la referencia del SDK para ver todas las opciones de inserción.

¿Respondió esto a tu pregunta?