Een widget integreren op uw gastwebsite is mogelijk via embed-code of Javascript. Afhankelijk van het type widget bestaan er richtlijnen voor een optimale weergave. Bij de “Global Header” - de header van Digitaal Vlaanderen - is het aangeraden de widget zo dicht mogelijk bij het begin van de body-tag te plaatsen.
Widgets moeten altijd geïntegreerd worden bij de klant. De widgets zijn volledig responsive en passen zich dus aan de schermgrootte van de gebruiker aan.
Belangrijk:
Alle Javascript-afhankelijkheden van een widget worden altijd gedownload en geladen in een geïsoleerde scope. Zo ontstaan er geen versieconflicten tussen de webpagina en de widget. Stylesheets zijn hier echter een uitzondering op door het gebrek aan native ondersteuning om dit uit te voeren (bijvoorbeeld shadow-dom). Widgets vangen dit op door alle CSS-regels te prefixen met een unieke naam. Dit is echter geen garantie dat bepaalde CSS-regels voor een webpagina geen invloed hebben op de widget.
Een widget toevoegen aan een webpagina via embed-code
Een widget embed-code is een script-tag om toe te voegen binnen het body-element van een webpagina. Zo een embed-code maakt gebruik van synchrone operaties om een placeholder te voorzien in de webpagina. Hierdoor is het niet mogelijk om embed-codes asynchroon te gebruiken.
Belangrijk:
Vergeet de @govflanders/vl-widget-polyfill niet toe te voegen aan de webpagina (zie Browser Polyfills voor meer info).
Een widget toevoegen aan een webpagina via Javascript
Hierbij wordt Javascript-code voorzien waarbij door middel van de bootstrap-functie een widget-URL wordt omgezet naar een widget-instantie. Deze bootstrap-functie zal asynchroon een widget instantie aanmaken en een referentie terug geven. Zodra men een referentie verkrijgt kan het koppelen aan een DOM-element plaats vinden. Onderstaande code voorbeeld toont hoe men een widget instantie kan koppelen aan een DOM-element en vervolgens mount-gedrag triggeren.
Belangrijk:
Vergeet de @govflanders/vl-widget-polyfill niet toe te voegen aan de webpagina (zie Browser Polyfills voor meer info).
Een widget via Javascript toevoegen aan een webpagina vereist het gebruik van @govflanders/vl-widget-client bibliotheek (zie voor meer info).