Widget de documentation de l'application

la documentation contextuelle est intégrée dans votre produit là où l'utilisateur en a le plus besoin le widget de documentation contextuelle aide les utilisateurs à lire la documentation sans avoir besoin de naviguer dans le portail du guide de l'utilisateur dans une autre fenêtre vous pouvez charger des articles spécifiques ou l'ensemble du portail du guide de l'utilisateur, ce qui est indispensable pour les entreprises qui souhaitent augmenter l'adoption et la rétention du produit tout ce que vous avez à faire est d'intégrer le code html généré sous paramètres de l'espace > intégration du widget comment fonctionne le widget regardez la vidéo ci dessous montrant le widget en action comment implémenter le widget pour intégrer le widget, suivez ces étapes sélectionnez votre espace dans l'éditeur cliquez sur l'icône d'engrenage (⚙️) pour accéder aux paramètres allez à intégration de widget cliquez sur le bouton de copie, et collez le code dans votre index html fichier, ou dans le code de votre application maintenant, le widget s'occupera de tout en arrière plan ne vous inquiétez pas, tout est regroupé et minifié c'est un simple téléchargement de 56 ko et il se charge de manière asynchrone, donc vos utilisateurs ne sentiront pas de différence événement d'initialisation dans le init événement, pour la spaceid valeur, vous pouvez utiliser le spaceid ou le published {spaceid} de cette façon, vous pouvez utiliser les espaces sans les publier, directement dans votre application utilisez preview {spaceid} lorsque vous souhaitez uniquement publier un espace en aperçu et non sur votre domaine propriété type description requis identifiantespace chaîne passez l'identifiant souhaité pour charger vos documents requis jwt chaîne passez le jeton jwt afin de voir les documents protégés par jwt optionnel jetonpartageable chaîne transmettez le shareabletoken de vos liens privés pour protéger vos documents optionnel typedewidget 'docs' | 'recherche' la valeur par défaut est docs cela ouvre le widget avec le comportement souhaité docs le type ouvrira le widget avec le comportement par défaut, search ouvrira une barre de widget de recherche qui affiche une barre de recherche avec support ai (si inclus dans votre abonnement) optionnel cacherbarredenavigation booléen il montre ou cache la barre de navigation supérieure du modal du widget par défaut, la barre de navigation est visible si vous ne voulez pas voir la barre de navigation, passez la avec vrai valeur, sinon il suffit de l'ignorer stratégiedechargement paresseux | avide la valeur par défaut est paresseux alors que paresseux le chargement retardé l'initialisation d'une ressource, avide le chargement initialise ou charge le widget dès que le code est exécuté optionnel bulle invisible | demander la valeur par défaut est invisible si défini sur demander cela affichera une bulle en bas à droite de votre écran chaque fois que quelqu'un clique dessus, le widget de recherche s'ouvrira optionnel espacedebulle chaîne le texte de remplacement qui sera affiché dans la section de bulle s'il n'est pas passé, une valeur par défaut de posez une question sera affiché optionnel ancre chaîne vous pouvez fournir votre classe , id ou chemin vers un élément dom où vous souhaitez ancrer et instancier le widget il s'ancrera au premier élément trouvé dans le dom, si plusieurs éléments avec le même chemin sont présents le conteneur fourni doit avoir position relative car le widget sera affiché en fonction du premier relatif parent trouvé par exemple ancre "#mon conteneur" / ancre " classe conteneur" optionnel si vous souhaitez qu'une bulle de recherche simple soit toujours présente dans votre application, utilisez la bulle "demander" propriété afficher l'événement du widget afficher widget l'événement déclenche l'action d'afficher le widget il a également une optionnelle propriété que vous pouvez passer pour ouvrir un document spécifique de vos espaces initialisés propriété description requis docid définissez la valeur de l'identifiant du document pour ouvrir un document spécifique si docid est passé, widgettype est ignoré, il s'ouvrira en docs mode, quel que soit le prop passé remarque vous devez ajouter le mot publié devant le docid comme publié docid ou aperçu spaceid ; sinon, le widget ouvrira le document en mode édition qui pourrait avoir des modifications non publiées optionnelle blockid définissez un certain identifiant de bloc, afin de faire défiler vers la section souhaitée dans ce document optionnelle événements pris en charge voici une brève description de notre api d'événements widget nom de l'événement description requis init cet événement aide archbee widget à intégrer les fichiers requis dans votre application requis show widget cet événement affiche le widget à la demande requis hide widget cet événement cache le widget si les mécanismes intégrés ne suffisent pas optionnel exemples de code ajoutez une fonction où que vous souhaitiez afficher le widget sur votre site, comme ceci const openabwidget = () => { window archbee push({ eventtype "show widget", // optional, only for loading a specific doc // and scroll to section // docid `published ${docid}`, // blockid "tbmm9" }); } cela chargera le widget, avec les docs et utilisateurs de l'espace souhaité, et les utilisateurs pourront voir tout directement depuis votre application si vous souhaitez charger un doc spécifique uniquement, il suffit de passer docid `${docid}` à notre objet initial comme dans l'exemple ci dessus vous n'avez pas besoin de la closewidget fonction, car le widget se fermera automatiquement si vous appuyez sur esc ou cliquez en dehors de celui ci cependant, si vous souhaitez fermer le widget de manière programmatique et ne pas compter sur les mécanismes de fermeture intégrés, vous pouvez utiliser hide widget type d'événement de cette manière const closeabwidgetafterseconds = (miliseconds) => { settimeout(() => { // settimeout is for demo purposes and it is not required window archbee push({eventtype "hide widget"}); }, miliseconds); } closeabwidgetafterseconds(5000);