App-Dokumentations-Widget

kontextbezogene dokumentation ist in ihr produkt eingebettet, genau dort, wo die benutzer sie am meisten benötigen das kontextbezogene docs widget hilft benutzern, die dokumentation zu lesen, ohne das benutzerhandbuch portal in einem anderen fenster durchsuchen zu müssen sie können spezifische artikel oder das gesamte benutzerhandbuch portal laden – ein muss für unternehmen, die die produktakzeptanz und bindung erhöhen möchten alles, was sie tun müssen, ist den unter space einstellungen > widget integration generierten html code einzubetten 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 weltraum im editor aus klicken sie auf das zahnradsymbol (⚙️), um zu den einstellungen gehen sie zu widget integration klicken sie auf die kopierschaltfläche und fügen sie den code in ihre index html datei oder in ihren anwendungscode ein jetzt übernimmt das widget alles im hintergrund keine sorge, alles ist gebündelt und minimiert es ist ein nur 56 kb großer download und wird asynchron geladen, sodass ihre benutzer keinen unterschied bemerken werden init event im init event können sie für den wert von spaceid entweder die spaceid oder veröffentlicht {spaceid} verwenden auf diese weise können sie spaces ohne veröffentlichung direkt in ihrer app verwenden verwenden sie vorschau {spaceid} wenn sie einen space nur für die vorschau und nicht auf ihrer domain veröffentlichen möchten eigenschaft typ beschreibung erforderlich spaceid zeichenkette übergeben sie die gewünschte id, um ihre dokumente zu laden erforderlich jwt zeichenkette übergeben sie das jwt token, um jwt geschützte dokumente zu sehen optional shareabletoken zeichenkette übergeben sie das shareabletoken aus ihren privaten links, um ihre dokumente zu schützen optional widgettype 'docs' | 'suche' standardwert ist dokumente dies öffnet das widget mit dem gewünschten verhalten dokumente typ öffnet das widget mit dem standardverhalten, suche öffnet eine such widget leiste, die eine suchleiste mit ai unterstützung anzeigt (falls in ihrem abonnement enthalten) optional hidenavbar boolean zeigt oder verbirgt die obere navigationsleiste im widget modal standardmäßig ist die navigationsleiste sichtbar wenn sie die navigationsleiste nicht sehen möchten, übergeben sie sie mit dem wert wahr , andernfalls überspringen sie sie einfach loadingstrategy faul | eifrig der standardwert ist faul während faul das initialisieren einer ressource verzögert, initialisiert eifrig das widget sofort, sobald der code ausgeführt wird optional blase unsichtbar | fragen der standardwert ist unsichtbar wenn auf fragen gesetzt, wird unten rechts auf ihrem bildschirm eine bubble angezeigt wann immer jemand darauf klickt, öffnet sich das such widget optional bubbleplaceholder zeichenkette der platzhalter, der im bubble bereich angezeigt wird wenn nicht übergeben, wird ein standardwert von eine frage stellen angezeigt optional anker zeichenkette sie können ihre klasse , id oder pfad zu einem dom element angeben, an dem das widget verankert und instanziiert werden soll es wird an das erste im dom gefundene element verankert, wenn mehrere elemente mit demselben pfad vorhanden sind der bereitgestellte container sollte position relativ haben, da das widget basierend auf dem ersten relativen elternteil angezeigt wird, das gefunden wird z b anchor "#my container" / anchor " container class" optional wenn sie möchten, dass in ihrer app immer eine einfache such bubble vorhanden ist, verwenden sie die bubble "fragen" eigenschaft widget ereignis anzeigen show widget ereignis löst die aktion zum anzeigen des widgets aus es verfügt außerdem über 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 unabhängig von der übergebenen eigenschaft im dokumente modus geöffnet hinweis sie müssen das wort published vor die docid setzen, also published docid oder preview spaceid ; andernfalls öffnet das widget das dokument im bearbeitungsmodus, das eventuell unveröffentlichte änderungen enthält optional blockid legen sie eine bestimmte blockid fest, um zu dem gewünschten abschnitt im dokument zu scrollen optional unterstützte ereignisse hier finden sie eine kurze beschreibung unserer widget ereignis api ereignisname beschreibung erforderlich init dieses ereignis hilft dem archbee widget, die erforderlichen dateien in ihre app zu laden erforderlich show widget dieses ereignis zeigt das widget bei bedarf an erforderlich widget ausblenden dieses ereignis blendet das widget aus, falls die integrierten mechanismen nicht ausreichen optional codebeispiele fügen sie eine funktion an einer beliebigen stelle hinzu, an der sie das widget auf ihrer seite anzeigen möchten, wie folgt const openabwidget = () => { window archbee push({ eventtype "show widget", // optional, only for loading a specific doc // and scroll to section // docid `published ${docid}`, // blockid "tbmm9" }); } dadurch wird das widget mit den gewünschten space dokumenten geladen und die nutzer können alles direkt in ihrer app sehen wenn sie nur ein bestimmtes dokument laden möchten, übergeben sie einfach docid `${docid}` an unser initialisierungsobjekt 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 möchten, können sie den widget ausblenden ereignistyp 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);