Overlays

Modulbeschreibung

Mit diesem Modul können Sie eigene Overlays für Ihren OXID eShop ganz einfach im Admin-Bereich erstellen und verwalten.

Was sind Overlays? Wenn ein Kunde Ihren Onlineshop besucht, sieht er ein kleines Fenster, dass sich über die Inhalte im Shop legt. Dies wird "Overlay" genannt. In diesem Fenster können Sie wichtige Informationen, beispielsweise über eine Sommer-Rabatt-Aktion oder andere wichtige Informationen für Ihre Kunden, hinterlegen. Natürlich lässt sich das Overlay wieder ganz einfach schließen, damit das Einkaufserlebnis nicht gestört wird.

Bei der Umsetzung haben wir besonders darauf geachtet, dass die Overlays nicht nur auf einem Desktop-PC gut aussehen, sondern auch auf mobilen Endgeräten. Das Modul ist kompatibel mit unserem responsive Theme „RoxIVE“und dem Flow-Theme.

Das Modul ist erhältlich auf https://www.digidesk.de/produkte/overlays/

Systemvoraussetzungen

PHP-Version OXID 4 & 5

  • PHP 5.6

PHP-Version OXID 6

  • PHP 7.0 (OXID 6.0.x)

  • PHP 7.1 (OXID 6.1.x)

  • PHP 7.2 - 8.1 (OXID 6.2.x - 6.5.x)

Webserver-Konfiguration

  • IonCube Loader (mind. v5.0)

Kompatibel mit den Themes

  • Flow

  • Wave

  • RoxIVE

Kompatibel mit den OXID Versionen

  • OXID CE/PE 4.9.x bis 4.10.x

  • OXID EE 5.2.x bis 5.3.x

  • OXID CE/PE/EE 6.0.x bis 6.5.x

Installation

Ab OXID 6

  1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung. Sie erhalten dieses unter: https://www.digidesk.de/produkte/basis-modul/

  2. Für dieses Modul erstellen Sie nun einen weiteren Unterordner "overlay" im Ordner "packages/digidesk", in den die heruntergeladene Zip-Datei entpackt wird.

  3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus: composer require digidesk/overlay

  4. Nun kann das Modul im OXID eShop Admin aktiviert werden

  5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren

Bis OXID 5.3.x/4.10.x

  1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung. Sie erhalten dieses unter: https://www.digidesk.de/produkte/basis-modul

  2. Fügen Sie den Inhalt des Ordnerverzeichnisses des Moduls "modules/digidesk/" via FTP/SFTP unter dem gleichnamigen Pfad in Ihren Shop ein.

  3. Aktivieren Sie das Modul im OXID eShop Admin

  4. Ggf. Tmp-Verzeichnis leeren und Views neu generieren

  5. Bitte fahren Sie nun mit der Einrichtung des Moduls fort

Update

Ab OXID 6

  1. Entpacken Sie die neuen Modulversion in den Ordner "packages/digidesk/overlay"

  2. Deaktivieren Sie das Modul im OXID eShop Admin

  3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus: composer update digidesk/overlay

    Die Frage, ob Dateien des Pakets überschrieben werden sollen, bestätigen Sie bitte mit "Y".

  4. Aktivieren Sie das Modul im OXID eShop Admin

  5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren

Bis OXID 5.3.x/4.10.x

  1. Bitte aktualisieren Sie das Basis-Modul gemäß der darin enthaltenen Installationsanleitung.

  2. Deaktivieren Sie dieses Modul im OXID eShop Admin.

  3. Fügen Sie den Inhalt des Ordners "modules/digidesk/" via FTP/SFTP unter dem gleichnamigen Pfad in Ihren Shop ein und überschreiben Sie dabei die vorhandenen Dateien des Moduls.

  4. Aktivieren Sie dieses Modul im OXID eShop Admin.

  5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren.

Funktionsbeschreibung

Overlay erstellen

  1. Wechseln Sie im Admin-Bereich zu "Overlays">"Overlays bearbeiten". Sie erhalten dort eine Liste mit den bereits angelegten Overlays. Dort können Sie Ihre Overlays bearbeiten und neue Overlays durch einen Klick auf den grünen + Button erstellen.

  2. Nach dem Klick auf den grünen Button erhalten Sie die Oberfläche zum Bearbeiten. Siehe Screenshots:

Overlay-Einstellungen

  • Overlay aktivieren/deaktivieren.

  • Zeitraum festlegen, in dem das Overlay aktiv sein soll.

  • Titel und Inhalt des Overlays.

  • Priorität festlegen bei mehreren aktiven Overlays

  • Checkbox anzeigen, die das Overlay beim Kunden dauerhaft deaktiviert.

  • Overlay erst anzeigen, wenn der Kunde den Shop mit der Maus verlässt.

  • Festlegen, wann das Overlay angezeigt werden soll: immer oder nur einmalig.

  • Verzögerung einstellen, ab wann das Overlay erscheinen soll in ms.

  • Festlegen auf welchen Seiten das Overlay angezeigt werden soll.

  • Eine oder mehrere Kategorien auswählen wo das Overlay angezeigt werden soll.

Einbindung von Smarty-Tags

Seid der Version v.2.3.0 ist die Nutzung von Smarty-Tags im Overlay-Content möglich.

Nutzung von Formularen

Seid der Version v.2.3.0 ist die Nutzung von <form>-Tags in Overlays Möglich. Beim Einsatz von evoEdit sollte man die <form>-Tags in der Codeansicht wie folgend beschrieben mit einfachen HTML-Kommentaren auskommentieren:

Ansonsten passiert das Auskommentieren beim Verlassen der Code-Ansicht im Editor automatisch. Im Frontend werden die Kommentare automatisch entfernt und somit ist die Formular-Nutzung möglich.

Moduleinstellungen

Unter Moduleinstellungen kann man die Einbindung von jQuery durch das Modul deaktivieren, falls die Einbindung bereits an einer anderen Stelle geschieht. Für Modulfunktionalität wird jQuery jedoch zwingend benötigt.

Eine weitere Einstellung ermöglicht es, die Overlays im Frontend mit einem Mausklick außerhalb des Overlays zu schliessen.

Falls das Visual CMS im Shop verfügbar ist (PE oder EE- Editionen) und das Modul evoEdit installiert ist, kann man die Overlay-Einträge mit VisualCMS bearbeiten.

Hilfe & Support

Haben Sie Fragen oder benötigen Sie Hilfe bei der Installation? Gerne bieten wir Ihnen auch einen Installationsservice an. Kontaktieren Sie uns einfach über eine der unten stehenden Adressen.

PreviousNicht verwendete Bilder löschenNextPackstation

Last updated