| Table of Contents | ||||
|---|---|---|---|---|
|
Over deze documentatie
Deze technische documentatie is bestemd voor de afnemers van de global header extensie “e-loket” binnen het Widget-platform. Gebruik deze documentatie om deze extensie te implementeren in de global header plugin.
| Info |
|---|
Disclaimer:
|
Elementen
U krijgt de keuze uit 3 elementen om toe te voegen aan de global header.
Titelbar
Enkel de titelbar van de extensie wordt getoond.
| Iframe | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Broodkruimel
De titelbar en de bar met de broodkruimel(s) worden getoond.
| Iframe | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Navigatie
De titelbar en de bar met navigatie-items worden getoond.
| Iframe | ||||||||
|---|---|---|---|---|---|---|---|---|
|
API
Initieel wordt de header mee ingesteld via de standaardconfiguratie. Op die manier kan de global header extensie gebruikt worden zonder API.
...
Om de titel aan te passen:
setTitle(title: String): this;.Om het ‘navigationItems’ type te gebruiken en het actieve navigatie-item aan te geven. Dit zorgt ervoor dat de styling up-to-date is:
setActiveNavigationItemIndex(activeNavigationItemIndex: number): this;.Om de broodkruimel-items of navigatie-items te gebruiken:
setItems(items: Link[]): this;. Hier wordt een object in deze vorm verwacht:{ label: String, href: String }.
Link redirect
Wanneer er op één van de broodkruimel-items of navigatie-items wordt geklikt, gebeurt er een redirect naar de link die als href is meegegeven aan dat item.
Gebruik van de API
Om de global header extensie e-loket API te kunnen gebruiken is een referentie naar de global header widget nodig. Die referentie is te vinden via de @govflanders/vl-widget-client-bibliotheek.
| Info |
|---|
Codevoorbeeld
Dit is een codevoorbeeld van het gebruik van de API om bepaalde acties uit te voeren:
...