An open API service indexing awesome lists of open source software.

https://github.com/dnadesign/silverstripe-browser-update

Browser update integration for Silverstripe CMS
https://github.com/dnadesign/silverstripe-browser-update

browser-update silverstripe

Last synced: 10 months ago
JSON representation

Browser update integration for Silverstripe CMS

Awesome Lists containing this project

README

          

# Silverstripe Browser Update

[Browser update](https://browser-update.org/) integration for Silverstripe CMS.

## Installation 👷‍♀️

Install via composer.

```sh
composer require dnadesign/silverstripe-browser-update
```

Rebuild your application.

```sh
vendor/bin/sake dev/build flush=1
```

## Configuration 🚧

Add the `$BrowserUpdate` function to anywhere in your page body.

```diff

+{$BrowserUpdate}
...

```

## Usage 🤔

### Creating a browser update announcement ➕
Navigate to `/admin/browser-update-announcements` to add a new announcement.

This page contains 'global' settings that will affect all announcements on all browsers. By default, all insecure and unsupported browsers will be notified. All full reference for the settings can be found [here](https://browser-update.org/customize.html).

![](docs/_img/creating-a-browser-announcement.png)

### Activating the browser update announcement 🚨

To activate the announcement, it must be set as active in `/admin/settings`.

![](docs/_img/activating-the-browser-update-announcement.png)

Now navigate to the frontend of your site, if your browser is insecure or unsupported, you should recieve a notification.

![](docs/_img/firefox.png)

## Targeting specific browsers 🎯

In order to target a specific browser you can add a 'browser version'.

![](docs/_img/adding-a-browser-version.png)

From here you can select a browser, select the version constraints, and customise the message that the users will recieve. If the message fields are left empty, then they will default back to the global settings.

![](docs/_img/browser-version-settings.png)