Widget de documentación de la aplicación

la documentación contextual se integra dentro de tu producto donde el usuario más la necesita el widget de documentación contextual 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 imprescindible 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 mira 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 en 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 se encargará de todo detrás de escena no te preocupes, todo está empaquetado y minimizado es una descarga de solo 56kb y se carga de forma asíncrona, así que tus usuarios no notarán la 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 documentos protegidos por jwt opcional shareabletoken string pasa el shareabletoken de tus enlaces privados para proteger tus documentos opcional widgettype 'docs' | 'search' el valor predeterminado es docs esto abre el widget con el comportamiento deseado el tipo docs abrirá el widget con el comportamiento por defecto, search abrirá una barra de búsqueda que muestra una barra de búsqueda con soporte de ia (si está incluido en tu suscripción) opcional hidenavbar boolean muestra u oculta la barra superior del modal del widget por defecto la barra es visible si no deseas verla, pásala con valor true , de lo contrario simplemente omítelo loadingstrategy lazy | eager el valor predeterminado es lazy mientras que la carga lazy retrasa la inicialización de un recurso, eager inicializa o carga el widget tan pronto como se ejecuta el código opcional bubble invisible | ask el valor predeterminado es invisible si se establece en ask mostrará una burbuja en la esquina inferior derecha de tu pantalla cuando alguien haga clic en ella, se abrirá el widget de búsqueda opcional bubbleplaceholder string el texto que se mostrará en la sección de la burbuja si no se pasa, se mostrará un valor predeterminado de haz una pregunta opcional anchor string puedes proporcionar tu clase , id o ruta a un elemento del dom donde deseas que el widget se ancle e instancie se anclará al primer elemento encontrado en el dom si hay múltiples elementos con la misma ruta el contenedor proporcionado debe tener position relative ya que el widget se mostrará basado en el primer pariente relativo encontrado ej , anchor "#my container" / anchor " container class" 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 evento desencadena 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 se ignora; se abrirá en modo docs independientemente de 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 block id 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 cargar 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 la mecánica integrada no es suficiente 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 espacio deseados y los usuarios podrán verlo todo directamente desde tu aplicación si quieres 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 incorporada, 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);