App documentation widget

la documentación contextual está integrada en tu producto donde el usuario más la necesita el widget de documentos contextuales ayuda a los usuarios a leer la documentación sin necesidad de navegar por el portal de la guía del usuario en otra ventana puedes cargar artículos específicos o todo el portal de la guía del usuario, lo cual es indispensable para las empresas que desean aumentar la adopción y retención del producto todo lo que necesitas hacer es incrustar el código html generado en configuración del espacio > integración del widget cómo funciona el widget consulta el video a continuación que muestra el widget en acción cómo implementar el widget para integrar el widget, sigue estos pasos selecciona tu espacio dentro del editor haz clic en el ícono de engranaje (⚙️) para entrar a configuración ve a integración de widget haz clic en el botón de copiar y pega el código en tu index html o en el código de tu aplicación ahora, el widget manejará todo detrás de escena no te preocupes, todo está empaquetado y minimizado es una descarga de solo 56kb y se carga de manera asíncrona, por lo que tus usuarios no notarán ninguna diferencia evento de inicialización en el init evento, para el valor spaceid puedes usar el spaceid o el published {spaceid} de esta manera puedes usar spaces sin publicarlos, directamente en tu aplicación usa preview {spaceid} cuando solo quieras publicar un espacio en preview y no en tu dominio propiedad tipo descripción requerido spaceid string pasa el id deseado para cargar tus documentos requerido jwt string pasa el token jwt para ver los documentos protegidos por jwt opcional si quieres que una burbuja de búsqueda simple esté siempre presente en tu aplicación, usa la bubble "ask" prop mostrar evento del widget show widget activa la acción para mostrar el widget también tiene una propiedad opcional que puedes pasar para abrir un documento específico desde tus spaces inicializados propiedad descripción requerido docid establece el valor del doc id para abrir un documento específico si docid es pasado, widgettype es ignorado; se abrirá en modo docs sin importar la propiedad pasada nota debes agregar la palabra published delante del docid como published docid o preview spaceid ; de lo contrario, el widget abrirá el documento en modo edición, que podría tener cambios no publicados opcional blockid establece un cierto id de bloque para desplazarse a la sección deseada en ese documento opcional eventos compatibles aquí hay una breve descripción de nuestra api de eventos del widget nombre del evento descripción requerido init este evento ayuda al widget de archbee a iniciar los archivos necesarios en tu aplicación requerido show widget este evento muestra el widget bajo demanda requerido hide widget este evento oculta el widget si las mecánicas incorporadas no son suficientes opcional ejemplos de código agrega una función donde quieras mostrar el widget en tu sitio, así const openabwidget = () => { window archbee push({ eventtype "show widget", // optional, only for loading a specific doc // and scroll to section // docid `published ${docid}`, // blockid "tbmm9" }); } esto cargará el widget, con los documentos del space deseado y los usuarios podrán ver todo directamente desde tu aplicación si deseas cargar solo un documento específico, simplemente pasa docid `${docid}` a nuestro objeto inicial como en el ejemplo anterior no necesitas la función closewidget , ya que el widget se cerrará automáticamente si presionas esc o haces clic fuera de él sin embargo, si deseas cerrar el widget programáticamente y no depender de la mecánica de cierre integrada, puedes usar el tipo de evento hide widget de esta manera const closeabwidgetafterseconds = (miliseconds) => { settimeout(() => { // settimeout is for demo purposes and it is not required window archbee push({eventtype "hide widget"}); }, miliseconds); } closeabwidgetafterseconds(5000);