Integreren met een widget

Over de client-bibliotheek

In sommige situaties is het nodig om te integreren met het widget-platform of met een widget, bijvoorbeeld om de global header broodkruimelextensie aan te sturen.

Hiervoor stellen we de @govflanders/vl-widget-client-bibliotheek te beschikking. Deze bibliotheek werkt als de toegangspoort naar het widget-platform en de widgets.

Een widget opvragen via de capture-functie

De capture-functie is een eenvoudige manier om één of meerdere widgets op te vragen die al aanwezig zijn op de pagina. Deze capture-functie werkt asynchroon en zal voor elke widget-instantie op de webpagina opgeroepen worden. De volgorde waarin de capture-functie wordt uitgevoerd ten opzichte van het toevoegen van een widget aan een webpagina, maakt niet uit.

De capture-functie wordt bijvoorbeeld gebruikt om de status van de sessie op te vragen, zie ook Technische documentatie global header - global footer | De status van de sessie rapporteren .

Bijkomende filter-functie

Soms is een meer geavanceerde filterlogica nodig, zodat niet alle widgets worden teruggegeven worden via de capture-functie. Geef een filter-functie mee als een optioneel argument. De return-waarde van zo een filter-functie moet altijd een boolean-waarde zijn waarbij alleen de waarde true de widget-instantie doorgeeft aan de capture-functie.