Skip to content

digipolisantwerp/smart-widgets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Antwerp UI Smart Widgets

Welkom

Smart Widgets maken deel uit van het Digipolis DXP, of Digital eXperience Platform, en bouwen voort bovenop de Antwerp UI componenten.

Op deze plek vind je alles terug over het gebruiken en maken van Smart Widgets.

Inhoud

Wat is een Smart Widget?

Een Smart Widget is een front-end component die een concrete end-to-end functionaliteit encapsuleert en gebruikt wordt als onderdeel om een View in een App te bouwen. De Widget bestaat uit een UI component en een bijbehorende service die de doorverbinding maakt met achterliggende systemen.

Dit past in de referentie-architectuur SA2023 en ziet er als volgt uit:

Widget UI - Widget BFF - Engines

De Smart Widget bestaat uit volgende delen:

  • UI - widget user interface voorgekoppeld op de BFF
  • BFF - een backend-for-frontend service die de widget gaat verbinden met achterliggende systemen (API's en databronnen)

Bij het bouwen van de BFF voor een applicatie maakt de ontwikkelaar hergebruik van de voorverpakte Smart Widget functionaliteit.

Klik door naar de lijst van Smart Widgets om voorbeelden te zien.

Een widget gebruiken

Een Smart Widget gebruik je door volgende zaken te doen:

  1. Includeer en configureer de back-end

    In je BFF code ga je de back-end package voor de Smart Widget includeren en de instructies uit de README ervan volgen om een werkende BFF te maken die gebruikt kan worden door de Smart Widget front-end.

  2. Includeer en configureer de front-end

    In je applicatie front-end code ga je de front-end package voor de Smart Widget includeren en ook hier weer de instructies uit de README ervan volgen om die te verbinden met de BFF en gepast te configureren voor je noden.

Kijk bij de lijst van widgets hieronder welke packages ter beschikking zijn voor elke widget.

Afwerkingsniveaus

Een Smart Widget kent verschillende stadia van afwerking, en in functie daarvan kan je de keuze maken of de widget de juiste is voor jouw applicatie:

  • Doing

    De widget is in actieve ontwikkeling maar nog niet klaar voor gebruik. Hou deze pagina in de gaten!

  • Community

    De widget is klaar, maar is nog niet opgenomen in de Digipolis organisatie op github en voldoet mogelijk nog niet aan de basisvereisten rond kwaliteit.

  • Live

    De widget is klaar voor gebruik.

  • Archive

    De widget is niet langer ondersteund.

De widgets zijn ontworpen om gecombineerd te worden met de merkarchitectuur van de stad Antwerpen.

Een widget (ver)bouwen

Wil je een Smart Widget maken of verrijken met bijkomende functionaliteit, of wil je gewoon een suggestie doen of een bug melden, bekijk dan even onze contributiegids.

In elk geval ben je op voorhand al enorm bedankt voor jouw hulp! 👍

Huidige widgets

Widget Status
Contact Picker Status: Archive
Location Picker Status: Live
Chatbot Status: Archive
Smart Table Status: Archive
Notification Status: Archive
Location Viewer Status: Live
Cookie consent Status: Live
Metanavigation Status: Live

Contact Picker

Status: Archive

Een selectieveld om een persoon uit te kiezen, met standaardkoppeling op het M-profiel en mogelijkheid om extra databronnen aan te koppelen.

Voorbeeld van de Contact Picker widget.

Packages:

Location Picker

Status: Live

Een selectieveld om een straat, adres of plaats uit te kiezen, gekoppeld op de GIS databron van straten en adressen in Antwerpen. Kan getoond worden met en zonder kaart en heeft uitgebreide mogelijkheden tot customisatie.

Voorbeeld van de Location Picker widget.

Packages:

Chatbot

Status: Archive

Een chat UI die verbonden is met een chatbot in de chatbot engine.

Voorbeeld van de Chatbot widget.

Smart Table

Status: Archive

Een generieke front-end voor het tonen van filterbare, sorteerbare, paginerende lijsten van dingen. De front-end is zelfconfigurerend via data aangeleverd door de backend.

Voorbeeld van de Smart Table widget.

Notification

Status: Archive

Een notification dropdown om in-app notifications uit de notification engine te tonen.

Voorbeeld van de Notification widget.

Location Viewer

Status: Live

Een gemakkelijke manier om locaties of adressen te tonen binnen Antwerpen.

Voorbeeld van de Location Viewer widget.

Packages:

Cookie consent

Status: Live

Een cookie consent prompt conform aan de huisstijl- en GDPR-vereisten.

Cookie consent

Metanavigation

Status: Live

Een metanavigatie (header en footer) conform de huisstijlvereisten.

Metanavigation

Embeddable Widgets

Smart Widgets dien je te integreren in je frontend codebase, wat maakt dat ze beschikbaar moeten zijn voor hetzelfde frontend framework als waarin je werkt. Voor gevallen waar dit niet kan hebben we ook embeddable widgets. Dit is een manier om via iframes stukken functionaliteit toe te voegen aan een applicatie, zelfs als die geschreven is in een andere frontend-technologie en wordt die gehost door een andere applicatie.

About

Smart Widgets documentation hub

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •