Sovelluksen dokumentaatiowidget
Kontekstuaalinen dokumentaatio upotetaan tuotteeseenne sinne, missä käyttäjä tarvitsee sitä eniten. Kontekstuaalisten dokumenttien widget auttaa käyttäjiä lukemaan dokumentaatiota ilman, että heidän tarvitsee selata käyttöopasportaalia toisessa ikkunassa.
Voitte ladata yksittäisiä artikkeleita tai koko käyttöopasportaalin, mikä on välttämätöntä yrityksille, jotka haluavat lisätä tuotteen käyttöönottoa ja käyttäjien pysyvyyttä.
Teidän tarvitsee vain upottaa kohdassa Tila-asetukset -> Widget-integraatio luotu HTML-koodi.
Miten widget toimii
Katso alla oleva video, jossa widget esitellään käytännössä:
Widgetin käyttöönotto
Integroi widget seuraamalla näitä vaiheita:
Valitkaa Avaruus editorissa.
Napsauttakaa rataskuvaketta (⚙️) siirtyäksenne kohtaan Asetukset.
Siirtykää kohtaan Widget-integraatio.
Napsauttakaa kopiointipainiketta ja liittäkää koodi index.html-tiedostoonne tai sovelluksenne koodiin.
Nyt widget hoitaa kaiken taustalla. Älkää huolehtiko, kaikki on paketoitu ja minifioitu. Latauskoko on vain 56 Kb ja se latautuu asynkronisesti, joten käyttäjänne eivät huomaa eroa.
Init-tapahtuma
Tapahtumassa init voitte käyttää arvona spaceId joko spaceId tai JULKAISTU-{spaceId}-arvoa. Näin voitte käyttää Spaceja julkaisematta niitä suoraan sovelluksessanne.
Käyttäkää ESIKATSELU-{spaceId}-arvoa, kun haluatte julkaista Spacen vain Preview-tilaan ettekä verkkotunnuksellenne.
Ominaisuus | Tyyppi | Kuvaus | Pakollinen |
|---|---|---|---|
spaceId | merkkijono | Välitä haluttu id ladataksesi dokumenttisi. | pakollinen |
jwt | merkkijono | Välitä jwt-token nähdäksesi jwt-suojatut dokumentit. | valinnainen |
jaettava tunnus | merkkijono | Välitä shareableToken yksityisistä linkeistäsi suojataksesi dokumenttisi. | valinnainen |
widgetType | 'docs' | 'search' | Oletusarvo on asiakirjat-. Tämä avaa widgetin halutulla toiminnallisuudella. asiakirjat-tyyppi avaa widgetin oletustoiminnallisuudella, haku avaa hakuwidget-palkin, joka näyttää hakupalkin AI-tuella (jos se sisältyy tilaukseesi). | valinnainen |
hideNavbar | totuusarvo | Se näyttää tai piilottaa ylänavigointipalkin widget-modaalista. Oletuksena navigointipalkki on näkyvissä. Jos et halua nähdä navigointipalkkia, välitä sille arvo tosi, muussa tapauksessa jätä se pois. | |
latausstrategia | laiska | innokas | Oletusarvo on laiska. Kun laiska-lataus viivästyttää resurssin alustamista, innokas-lataus alustaa tai lataa widgetin heti, kun koodi suoritetaan. | valinnainen |
kupla | näkymätön | kysy | Oletusarvo on näkymätön. Jos arvoksi asetetaan kysy se näyttää kuplan näytön oikeassa alakulmassa. Kun joku napsauttaa sitä, hakuwidget avautuu. | valinnainen |
bubblePlaceholder | merkkijono | Paikkamerkkiteksti, joka näytetään kuplaosiossa. Jos sitä ei anneta, oletusarvo Esitä kysymys näytetään. | valinnainen |
ankkuri | merkkijono | Voit antaa luokka, id- tai polku-arvon DOM-elementille, johon haluat widgetin ankkuroida ja alustaa. Se ankkuroidaan ensimmäiseen DOM:sta löytyvään elementtiin, jos useita samalla polulla olevia elementtejä on olemassa. Annetulla containerilla tulisi olla position: relative sillä widget näytetään ensimmäisen löydetyn suhteellinen vanhempi-elementin perusteella. Esimerkiksi: ankkuri: "#my-container" / ankkuri: ".container-class" | valinnainen |
Jos haluat yksinkertaisen hakukuplan olevan aina näkyvissä sovelluksessasi, käytä bubble: "kysy" -propia.
Näytä widget -tapahtuma
show-widget-tapahtuma käynnistää widgetin näyttämisen. Sillä on myös valinnainen ominaisuus, jonka voit välittää avataksesi tietyn dokumentin alustetuista Spaces-tiloistasi.
Ominaisuus | Kuvaus | Pakollinen |
|---|---|---|
docId | Aseta doc id -arvo avataksesi tietyn dokumentin. Jos docId välitetään, widgetType jätetään huomiotta, ja se avautuu asiakirjat-tilassa riippumatta välitetystä propista. Huomautus: Sinun täytyy lisätä sana PUBLISHED docId:n eteen muodossa PUBLISHED-docId tai ESIKATSELU-spaceId; muuten widget avaa dokumentin muokkaustilasta, jossa saattaa olla julkaisemattomia muutoksia. | valinnainen |
blockId | Aseta tietty block id vierittääksesi haluttuun osioon kyseisessä dokumentissa. | valinnainen |
Tuetut tapahtumat
Tässä on lyhyt kuvaus Widget-tapahtumarajapinta-ominaisuudestamme:
Tapahtuman nimi | Kuvaus | Pakollinen |
|---|---|---|
init | Tämä tapahtuma auttaa Archbee-widgetiä lataamaan tarvittavat tiedostot sovellukseesi. | pakollinen |
show-widget | Tämä tapahtuma näyttää widgetin pyydettäessä. | pakollinen |
piilota-widget | Tämä tapahtuma piilottaa widgetin, jos sisäänrakennetut mekanismit eivät riitä. | valinnainen |
Koodiesimerkit
Lisää funktio kohtaan, jossa haluat näyttää widgetin sivustollasi, esimerkiksi näin:
const openAbWidget = () => {
window._archbee.push({
eventType: "show-widget",
// optional, only for loading a specific doc
// and scroll to section
// docId: `PUBLISHED-${docId}`,
// blockId: "TBMm9"
});
}Tämä lataa widgetin halutuilla Space-dokumenteilla, ja käyttäjät voivat nähdä kaiken suoraan sovelluksestasi.
Jos haluat ladata vain tietyn dokumentin, välitä vain docId: `${docId}` alkuobjektiimme kuten yllä olevassa esimerkissä.
Et tarvitse closeWidget-funktiota, koska widget sulkeutuu automaattisesti, jos painat Esc tai napsautat sen ulkopuolelle.
Jos kuitenkin haluatte sulkea widgetin ohjelmallisesti ettekä luottaa sisäänrakennettuun sulkemismekanismiin, voitte käyttää piilota-widget -tapahtumatyyppiä tällä tavalla:
const closeAbWidgetAfterSeconds = (miliseconds) => {
setTimeout(() => {
// setTimeout is for demo purposes and it is not required...
window._archbee.push({eventType: "hide-widget"});
}, miliseconds);
}
closeAbWidgetAfterSeconds(5000);