SharePoint Kompendium - Bd. 21

Von Marc André Zhou, Benjamin Lanzendörfer, Rainer Stropek und Johannes Woithon

Das SharePoint Kompendium ist ein Sammelband unterschiedlicher Artikel rund um das Thema SharePoint. Dieser Band gibt weitreichende Informationen zum Erstellen von wiederverwendbaren UI-Komponenten, zum effektiven Einsatz des SharePoint Frameworks, zeigt, wie Sie ihr Unternehmnensintranet sinnvoll und produktiv einsetzen, und gibt wertvolle Inputs zu den Themen Dokumenten- und Informationmanagement sowie der Bedeutung von Softwaredokumentation.

• Sprache: Deutsch
• Herausgeber: entwickler.press
• Erscheinungsdatum: 26. Nov. 2018
• ISBN: 9783868028003

Buchvorschau

geschützt.

SPFx: Einsatz von wiederverwertbaren UI-Komponenten

Kolumne: SharePoint ganz praktisch

von Marc André Zhou

In der letzten Ausgabe dieses Magazins wurden unter anderem die Office-UI-Fabric-Komponenten vorgestellt und deren Verwendung innerhalb von SharePoint Framework Webparts gezeigt. Neben diesen Steuerelementen können noch erweiterte Komponenten verwendet werden. Diese sogenannten wiederverwertbaren Steuerelemente übernehmen neben der Darstellung auch noch weitere Aufgaben.

Wie im letzten Teil demonstriert wurde, stehen innerhalb der Office-UI-Fabric-Komponenten-Bibliothek zahlreiche Steuerelemente zur Verfügung, die direkt für eigene clientseitige Webparts verwendet werden können. Durch den Einsatz dieser Komponenten wird dem Entwickler schon einiges an Arbeit abgenommen, und die Steuerelemente fügen sich nahtlos in das Look-and-Feel der Office-Umgebung ein. Somit entstehen durch den Einsatz der Steuerelemente automatisch Benutzeroberflächen, die sich sehr gut in Office-basierte Arbeitsumgebungen integrieren. Das ist insbesondere für Webparts ein wichtiger Punkt, damit diese auf einer SharePoint-Seite nicht wie ein Fremdkörper erscheinen. Bei genauerer Betrachtung können bei der Entwicklung von Webparts bestimmte Programmiermuster erkannt werden, die sich ständig wiederholen. Ein typisches Beispiel dafür ist die Auswahl einer Liste innerhalb der Webpart-Eigenschaften. Die ausgewählte Liste wird dann im späteren Verlauf durch das Webpart verarbeitet und Einträge werden auf der Oberfläche ausgegeben. Für die visuelle Darstellung und Auswahl der Liste kann dafür aus der Office UI Fabric ein geeignetes Steuerelement, wie zum Beispiel die Drop-down-Liste, eingesetzt werden. Anschließend muss dann auf SharePoint zugegriffen werden, um die verfügbaren Listen der aktuellen Website (SP Web) zu ermitteln. Sind diese ermittelt und geladen, muss die Auswahlliste damit gefüllt werden.

Und der REST?

Hierbei besteht dann auch oft die Anforderung, nur bestimmte Listentypen – wie zum Beispiel ausschließlich Dokumentenbibliotheken – zur Auswahl anzubieten. Innerhalb eines clientseitigen SPFx-basierten Webparts bedeutet das, unter Verwendung des SharePoint REST API auf SharePoint zuzugreifen. Ein weiteres und komplexeres Beispiel ist die Nutzung und Einbindung des Terminologiespeichers (Term Store) in die Webpart-Eigenschaften. Hierzu muss der Entwickler programmatisch selbst den Terminologiespeicher über die REST-Schnittstelle abfragen. Diese und weitere Szenarien werden durch den Einsatz der sogenannten wiederverwertbaren Komponenten (engl.: Reusable Controls) nun besser unterstützt. Diese Komponenten nutzen intern die Office-UI-Fabric-Steuerelemente, erweitern sie aber um spezielle SharePoint-Funktionalitäten. Diese übernehmen dann teilweise im Hintergrund die Kommunikation mit SharePoint und führen REST-basierte Zugriffe eigenständig aus. Für das erste oben geschilderte Szenario – die Auswahl einer SharePoint-Liste innerhalb der Webpart-Eigenschaften – steht eine wiederverwertbare Komponente zum direkten Einsatz bereit. Sobald diese Komponente in den Bereich für die Webpart-Eigenschaften platziert wurde, lädt sie automatisch die verfügbaren Listen in eine Auswahlliste. Für die Auswahl von Begriffen aus dem Terminologiespeicher steht ebenfalls eine entsprechende wiederverwertbare Komponente bereit. Neben diesen zwei exemplarisch genannten Komponenten stehen noch weitere zum Einsatz bereit, die helfen, typische Anforderungen an ein Webpart einfacher realisieren zu können.

Nutzung der wiederverwertbaren Komponenten

Bevor jedoch die Komponenten verwendet werden können, müssen sie installiert werden. Die Komponenten können über den Node-Paketmanager einem SharePoint-SPFx-Projekt hinzugefügt werden. Aktuell gliedern