Widgets zur Integration des Beteiligungsportals in andere Webauftritte

Die Liste der aktuellen Beteiligungen sowie die Detailansicht einer Beteiligung können in andere Webauftritte integriert werden.

Zur Integration der Widgets in eine Seite muss

  1. die Javascript API geladen werden
  2. ein Element als Anker für die Integration bereitgestellt werden; das Element wird durch das Class-Attribut nbp-widget als Anker markiert.
  3. die Konfiguration des Widgets innerhalb des Ankerelements per data- Attribut vorgenommen werden

Integration der aktuellen Beteiligungen eines Mandanten

<!-- Beteiligungsportal Javascript API laden -->
<script async="async" defer="defer" src="https://beteiligung.nrw.de/portal/widgets/widgets-api.js"></script>
<!-- Beteiligungsportal Widget - innerhalb dieses Elements wird das Widget gerendert -->
<div class="nbp-widget" data-widget-typ="beteiligung-list" data-mandant="hauptportal"/>
        

Beispiel: Liste der Umfragen, Bauleitpläne und Veranstaltungen im Hauptportal

<script async="async" defer="defer" src="https://beteiligung.nrw.de/portal/widgets/widgets-api.js"></script>

<div class="nbp-widget"
     data-widget-typ="beteiligung-list"
     data-mandant="hauptportal"
     data-beteiligung-typ="umfrage veranstaltung bauleitplan"
     data-beteiligung-thema="'Freizeit und Tourismus' 'Umwelt, Klima und Nachhaltigkeit' 'Digitales'"/>
       

Konfiguration

Definition des Widget Typs Liste:

data-widget-typ="beteiligung-list"

Definition des Mandanten:

data-mandant="hauptportal"

Der Mandant kann aus der URL der Liste der aktuellen Beteiligungen ausgelesen werden (fett markiert):

https://beteiligung.nrw.de/portal/hauptportal/themen

Filtern nach Beteiligungstypen (optionaler Parameter):

data-beteiligung-typ="dialog umfrage"

Gültige Beteiligungstypen sind:

Soll nach mehreren Beteiligungstypen gefiltert werden, sind diese durch Leerzeichen zu trennen.

Filtern nach Beteiligungsthemen (optionaler Parameter):

data-beteiligung-thema="'Freizeit und Tourismus' 'Umwelt, Klima und Nachhaltigkeit' 'Digitales'"

Gültige Beteiligungsthemen sind:

Die Beteiligungsthemen sind in einfachen Anführungszeichen (') anzugeben.

Soll nach mehreren Beteiligungsthemen gefiltert werden, sind diese durch Leerzeichen zu trennen.

Begrenzung der Ergebnisliste (optionaler Parameter):

data-liste-max="5"

Erwartet wird eine positive Ganzzahl. Ist der übergebene Wert ungültig, wird er ignoriert und die Liste wird mit 10 Elementen ausgeliefert (Standardverhalten).