Erste Schritte bei der Entwicklung von Erweiterungen
Um Ihnen den Einstieg und die Erstellung von Erweiterungen zu erleichtern, verwenden wir das Open-Source-Tool für Strukturvorlagen, das von Entwicklern von Adobe zur Verfügung gestellt wird, um die erforderlichen Dateien und Dateistrukturen für Ihr Erweiterungspaket zu erstellen, sodass Sie nur noch den entscheidenden Teil beitragen müssen: den eigentlichen Code schreiben.
Voraussetzungen
- Installieren Sie Node.js.
Setup der Erweiterung
Erstellen Sie einen Ordner, in dem die Erweiterungsdateien gespeichert werden.
mkdir example && cd example
In dieser Anleitung wird das Tool zum Erstellen einer Strukturvorlage für Erweiterungen verwendet, um die anfängliche Erweiterungsstruktur zu erstellen, damit Entwickler schnell mit der Codierung beginnen können. Falls gewünscht, kann dieser Vorgang manuell ohne das scaffold-Tool durchgeführt werden.
Führen Sie das scaffold-Tool aus.
npx @adobe/reactor-scaffold
Das scaffold-Tool fordert Sie zur Eingabe folgender anfänglicher Konfigurationsoptionen auf:
- Anzeigename: Der sichtbare Name der Erweiterung
- Version: Die Version der Erweiterung
- Beschreibung: Eine kurze Beschreibung des Zwecks der Erweiterung
- Autor: Der Name des Autors der Erweiterung
Das scaffold-Tool stellt anschließend Optionen zum Erstellen der Erweiterungsstruktur bereit:
- Erweiterungskonfigurationsansicht: Die Ansicht, HTML-Datei, über die eine Erweiterung globale Einstellungen eines Benutzers erfasst.
- Ereignistypen: Definiert eine zu überwachende Aktivität. Sie erfahren beispielsweise, wenn ein Benutzer schnell scrollt oder mit einem Seitenelement interagiert. Ereignisse können in Regeln zum Ausführen von Aktionen verwendet werden.
- Bedingungstypen: Bedingungstypen auswerten, ob etwas wahr oder falsch ist.
So kann beispielsweise ermittelt werden, ob der Benutzer den Browser Chrome verwendet, ob er ein iPad benutzt oder ob er sich in einer bestimmten Domain befindet. - Aktionstypen: Die Aktion, die ausgeführt werden soll, wenn ein Ereignis eintritt. So können Sie beispielsweise einen Analytics-Beacon senden, ein Angebot anzeigen, ein Cookie speichern oder einen Support-Chat öffnen.
- Datenelementtypen: Datenelementtypen rufen Daten ab. Diese Daten können sich in einem lokalen Datenspeicher, in einem Cookie, in einem DOM-Element oder an einem benutzerdefinierten Speicherort befinden.
- Freigegebene Module: Ein freigegebenes Modul ist ein Mechanismus, mit dem Erweiterungen mit anderen Erweiterungen kommunizieren können.
- Ansichten: Jedes Ereignis, jede Bedingung, jede Aktion und jeder Datenelementtyp kann eine Ansicht bereitstellen, in der Benutzer Einstellungen angeben können.
- Bei jeder nachfolgenden Ausführung des scaffold-Tools wird die anfängliche Konfiguration übersprungen.
- Es können mehrere Ereignisse, Bedingungen und Aktionen hinzugefügt werden.
- Es darf nur eine Konfigurationsansicht vorhanden sein.