Over deze documentatie

Deze technische documentatie is bestemd voor de afnemers van de e-loket extensie global header extensies binnen het Widget-platform. Gebruik deze documentatie om de e-loket extensie(s) te gebruiken implementeren in de global header plugin.

E-Loket types

Er zijn 3 verschillende types die gebruikt kunnen worden:

...

Types extensies

U krijgt de keuze uit 3 types extensies.

None

Enkel de titelbar van de extensie wordt getoond.

Breadcrumbs

...

De titelbar en de bar met

...

de broodkruimel worden getoond.

Iframe
src https://codepen.io/m44rten/embed/jOzaxMO?default-tab=html%2Cresult&theme-id=light width 100% frameborder hide height 400px

Navigatie

...

De titel bar

...

en de bar met navigatie-items worden getoond.

Iframe
src https://codepen.io/m44rten/embed/RwMjyGB?default-tab=html%2Cresult&theme-id=light width 100% frameborder hide height 400px

API

Initieel wordt de header mee ingesteld via de standaard configuratiestandaardconfiguratie. Op die manier kan de e-loket extensie gebruikt worden zonder API. De API is enkel nodig in specifieke gevallen:

• Het aanpassen van de titel setTitle(title: String): this;

• Bij gebruik van het ‘navigationItems’ type: Het aangeven van het actieve navigatie item. Dit zorgt ervoor dat de styling up to date is. setActiveNavigationItemIndex(activeNavigationItemIndex: number): this;

• Het updaten van de breadcrumb items of navigatie items. setItems(items: Link[]): this;. Hier verwacht een link een object van deze vorm: { label: String, href: String }

Link redirect

Bij het klikken op een van de breadcrumb items of navigatie items, wordt er redirect gedaan naar de link die als href is meegegeven aan dat item.

Gebruik van de API

Om de e-loket extensie API te kunnen gebruiken is een referentie naar de global header widget nodig. Deze kan je vb. bekomen via de @govflanders/vl-widget-client-bibliotheek. Meer info hierover: Technische documentatie Widget-platform

...