Free scanFree scan

Install guide · Module

Install the visitor toolbar on OXID eShop

By Published

How to add the visitor toolbar to OXID eShop. The toolbar lets a visitor change how your pages look and read for themselves; it fixes nothing in your site, does not change whether it meets WCAG or the BFSG, and our scans never see it.

Before you start

  • Your site key. It is in the Reviseberg dashboard, under Settings › Visitor toolbar, on the Install tab. In the steps below it is written YOUR-SITE-KEY.
  • Switch the toolbar on for your site on the same screen. Until it is on, the tag loads and shows nothing.
  • What the platform needs: OXID eShop 7.

Download

The package is reviseberg-toolbar-oxid-1.0.0.zip. It is not listed in any platform’s store yet: you install it from this download.

Download for OXID eShop (version 1.0.0)

Steps

  1. Download the module above and unpack it into a folder of its own in your project, for example extensions/reviseberg/oxid-toolbar.
  2. Add that folder to composer.json as a path repository and run composer require reviseberg/oxid-toolbar.
  3. In the admin, go to Extensions › Modules, open Reviseberg visitor toolbar and activate it.
  4. On the module’s Settings tab, paste your site key, switch the toolbar on and save.

Good to know

OXID eShop 7 installs modules with Composer, so this needs access to the server.

The module is not in the OXID eXchange yet.

Check that it works

  • Open a page of your site in a private window — not in the platform’s editor or preview, where most plugins leave the tag out on purpose.
  • View the page source, or search the developer tools’ Elements panel, for widget/v1.js. There should be exactly one tag, with your key.
  • The toolbar’s button appears once the toolbar is switched on in the dashboard. On the same screen, “Last seen on your site” says when the tag last loaded on one of your pages.
  • No button? The browser console has a line beginning “Reviseberg toolbar:” that says why — a key with the wrong shape, for example, or the tag on the page twice.
  • The toolbar answers only on the addresses allowed under Settings › Visitor toolbar; your site’s own address always is. Add a staging address there before you test on it.

More