Widget de documentación de la aplicación

la documentación contextual está integrada en su 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 puede 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 necesita hacer es incrustar el código html generado bajo configuraciones del espacio > integración del widget cómo funciona el widget mire el video a continuación que muestra el widget en acción cómo implementar el widget para integrar el widget, siga estos pasos selecciona tu espacio dentro del editor haz clic en el ícono de engranaje (⚙️) para acceder a configuraciones ve a integración de widgets haz clic en el botón de copiar y pega el código en tu index html archivo, 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 minificado es una descarga de apenas 56kb y se carga de manera asíncrona, por lo que tus usuarios no notarán la diferencia evento de inicio en el init evento, para el spaceid valor, 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 vista previa y no en tu dominio propiedad tipo descripción requerido idespacio cadena pase el id deseado para cargar sus documentos requerido jwt cadena pase el token jwt para ver los documentos protegidos por jwt opcional token compartible cadena pasa el shareabletoken de tus enlaces privados para proteger tus documentos opcional tipodewidget 'docs' | 'buscar' el valor predeterminado es docs esto abre el widget con el comportamiento deseado docs el tipo abrirá el widget con el comportamiento predeterminado, search abrirá una barra de widget de búsqueda que muestra una barra de búsqueda con soporte de ia (si está incluido en su suscripción) opcional ocultarbarranavegación booleano muestra u oculta la barra de navegación superior del modal del widget por defecto, la barra de navegación es visible si no deseas ver la barra de navegación, pásala con verdadero valor, de lo contrario simplemente omítelo estrategiadecarga perezoso | ansioso el valor predeterminado es perezoso mientras que perezoso la carga retrasa la inicialización de un recurso, ansioso la carga inicializa o carga el widget tan pronto como se ejecuta el código opcional burbuja invisible | preguntar el valor predeterminado es invisible si se establece en preguntar , se mostrará un globo en la esquina inferior derecha de su pantalla siempre que alguien haga clic en él, se abrirá el widget de búsqueda opcional placeholderburbuja cadena el marcador de posición que se mostrará en la sección de burbujas si no se pasa, se mostrará un valor predeterminado de haz una pregunta se mostrará opcional ancla cadena puedes proporcionar tu clase , id o ruta a un elemento dom donde te gustaría que el widget se anclara e instanciara se anclará al primer elemento encontrado en el dom, si hay múltiples elementos con la misma ruta presentes el contenedor proporcionado debe tener posición relativa ya que el widget se mostrará basado en el primer relativo padre encontrado p ej , ancla "#mi contenedor" / ancla " clase contenedor" opcional si quieres que una burbuja de búsqueda simple esté siempre presente en tu aplicación, usa el bubble "ask" prop mostrar evento de widget mostrar widget el evento activa la acción para mostrar el widget también tiene una opcional propiedad que puedes pasar para abrir un documento específico de tus espacios inicializados propiedad descripción requerido docid establece el valor del id del documento para abrir un documento específico si docid se pasa, widgettype se ignora, se abrirá en docs modo independientemente de la propiedad pasada nota debes agregar la palabra publicado delante del docid como publicado docid o vista previa spaceid ; de lo contrario, el widget abrirá el documento en modo de edición que podría tener cambios no publicados opcional blockid establece un cierto id de bloque, para poder desplazarte a la sección deseada en ese documento opcional eventos soportados aquí hay una breve descripción de nuestro api de eventos de widget nombre del evento descripción requerido init este evento ayuda a archbee widget a cargar los archivos requeridos en tu aplicación requerido mostrar widget este evento muestra el widget bajo demanda requerido ocultar widget este evento oculta el widget sí las mecánicas integradas 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 espacio deseado y los usuarios podrán ver todo directamente desde tu aplicación si deseas cargar un documento específico solamente, solo pasa docid `${docid}` a nuestro objeto inicial como en el ejemplo anterior no necesitas la closewidget función, 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 los mecanismos de cierre integrados, puedes usar hide widget tipo de evento 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);