App-Dokumentations-Widget

kontextbezogene dokumentation ist in ihr produkt eingebettet, wo der benutzer sie am meisten benötigt das widget für kontextbezogene dokumente hilft benutzern, die dokumentation zu lesen, ohne das benutzerhandbuch portal in einem anderen fenster durchsuchen zu müssen sie können bestimmte artikel oder das gesamte benutzerhandbuch portal laden – ein muss für unternehmen, die die produktakzeptanz und bindung steigern möchten sie müssen lediglich den unter space einstellungen > widget integration wie das widget funktioniert sehen sie sich das folgende video an, das das widget in aktion zeigt wie sie das widget implementieren um das widget zu integrieren, folgen sie diesen schritten wählen sie ihren bereich im editor aus klicken sie auf das zahnradsymbol (⚙️), um zu einstellungen gehen sie zu widget integration klicken sie auf die schaltfläche kopieren und fügen sie den code in ihre index html datei oder in ihren anwendungscode ein jetzt übernimmt das widget alles hinter den kulissen keine sorge, alles ist gebündelt und minimiert es sind nur 56 kb download und es wird asynchron geladen, sodass ihre nutzer keinen unterschied bemerken init ereignis im init event kannst du für den wert spaceid entweder die spaceid oder published {spaceid} verwenden auf diese weise kannst du spaces direkt in deiner app nutzen, ohne sie zu veröffentlichen verwende preview {spaceid} wenn du einen space nur für die vorschau veröffentlichen möchtest und nicht auf deiner domain eigenschaft typ beschreibung erforderlich spaceid string geben sie die gewünschte id ein, um ihre dokumente zu laden erforderlich jwt string geben sie das jwt token ein, um jwt geschützte dokumente einzusehen optional shareabletoken string geben sie das shareabletoken aus ihren privaten links ein, um ihre dokumente zu schützen optional widgettype 'docs' | 'search' standardwert ist docs dies öffnet das widget mit dem gewünschten verhalten docs öffnet das widget mit dem standardverhalten, search öffnet eine suchleiste mit ki unterstützung (falls im abonnement enthalten) optional hidenavbar boolean zeigt oder versteckt die obere navigationsleiste im widget modalfenster standardmäßig ist die navigationsleiste sichtbar wenn sie sie ausblenden möchten, setzen sie sie auf true ansonsten lassen sie das feld einfach aus loadingstrategy lazy | eager der standardwert ist lazy während lazy die initialisierung einer ressource verzögert, lädt eager das widget sofort, sobald der code ausgeführt wird optional bubble invisible | ask der standardwert ist invisible wenn auf ask gesetzt, wird unten rechts ein bubble button angezeigt bei einem klick darauf öffnet sich das such widget optional bubbleplaceholder string der platzhalter, der im bubble bereich angezeigt wird wenn nicht gesetzt, wird der standardwert eine frage stellen angezeigt optional anchor string sie können eine class , id oder einen path zu einem dom element angeben, an dem das widget verankert und instanziiert werden soll es wird am ersten passenden element im dom verankert, wenn mehrere übereinstimmende elemente vorhanden sind der container sollte position relative haben, da das widget basierend auf dem ersten relativen elternteil angezeigt wird beispiel anchor "#my container" / anchor " container class" optional wenn in ihrer app stets eine einfache suchblase angezeigt werden soll, verwenden sie die bubble "ask" eigenschaft widget ereignis anzeigen show widget ereignis löst die aktion aus, das widget anzuzeigen es hat außerdem eine optionale eigenschaft, die sie übergeben können, um ein bestimmtes dokument aus ihren initialisierten spaces zu öffnen eigenschaft beschreibung erforderlich docid legen sie den docid wert fest, um ein bestimmtes dokument zu öffnen wenn docid übergeben wird, wird widgettype ignoriert es wird im docs modus geöffnet, unabhängig von der übergebenen eigenschaft hinweis sie müssen das wort published vor die docid setzen, wie z b published docid oder preview spaceid ; andernfalls öffnet das widget das dokument im bearbeitungsmodus, der unveröffentlichte änderungen enthalten kann optional blockid legen sie eine bestimmte block id fest, um zu dem gewünschten abschnitt in diesem dokument zu scrollen optional unterstützte ereignisse hier ist eine kurze beschreibung unserer widget ereignis api ereignisname beschreibung erforderlich init dieses ereignis hilft dem archbee widget, erforderliche dateien in ihre app zu bootstrappen erforderlich show widget dieses ereignis zeigt das widget bei bedarf an erforderlich hide widget dieses ereignis blendet das widget aus, wenn die integrierten mechanismen nicht ausreichen optional codebeispiele fügen sie eine funktion an einer beliebigen stelle hinzu, an der sie das widget auf ihrer website anzeigen möchten, etwa so const openabwidget = () => { window archbee push({ eventtype "show widget", // optional, only for loading a specific doc // and scroll to section // docid `published ${docid}`, // blockid "tbmm9" }); } dies lädt das widget mit den gewünschten space dokumenten, und benutzer können alles direkt in ihrer app sehen wenn sie nur ein bestimmtes dokument laden möchten, übergeben sie einfach docid `${docid}` an unser anfangsobjekt wie im obigen beispiel sie benötigen die funktion closewidget nicht, da das widget automatisch geschlossen wird, wenn sie esc drücken oder außerhalb davon klicken wenn sie das widget jedoch programmatisch schließen möchten und sich nicht auf die integrierten schließmechanismen verlassen wollen, können sie den event typ hide widget auf diese weise verwenden const closeabwidgetafterseconds = (miliseconds) => { settimeout(() => { // settimeout is for demo purposes and it is not required window archbee push({eventtype "hide widget"}); }, miliseconds); } closeabwidgetafterseconds(5000);