Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 2.63 KB

README.md

File metadata and controls

81 lines (62 loc) · 2.63 KB
Raw

Unsupported Browser Notification

With Internet Explorer becoming less prevalent and frameworks like Bootstrap 5 also dropping support for IE 10 and IE 11, it makes less and less sense to support these browsers.

Preview

To show someone who is still using IE or Edge (not Chromium based) that the site is not actually broken (it' only for him broken), the plugin gives the possibility to show the user a short message that he is using a browser that is no longer supported.

Install

Important: Because of older Browsers, we recommend to implement this plugin before any other JavaScript.

Option 1: Self Executing

Include the plugin's script at the bottom ot the HTML body:

<script src="https://cdn.jsdelivr.net/gh/bergwerk/[email protected]/dist/notification.js"></script>

If you want to overwrite some default options, you have the possibility to define ubnOptions on the window object. It's important that you define the options before you include the file.

<script>
    window.ubnOptions = {
        title: 'Uppps. Your browser is to old ...',
        showNotification: ['ie']
    }
</script>
<script src="https://cdn.jsdelivr.net/gh/bergwerk/[email protected]/dist/notification.js"></script>

Option 2: Call the plugin

Include the plugins's UMD script at the bottom of the HTML body:

<script src="https://cdn.jsdelivr.net/gh/bergwerk/[email protected]/dist/notification.umd.js"></script>

Call the plugin. Pass the options to the plugin initialization.

<script src="https://cdn.jsdelivr.net/gh/bergwerk/[email protected]/dist/notification.umd.js"></script>
<script>
    var notification = new UnsupportedBrowserNotification({
        showNotification: ['ie']
    });

    notification.init();
</script>

Options

title: '',
description: '',
injectCss: true,
injectHtml: true,
cssPrefix: 'ubn',
lang: 'auto', // Language key e.g. 'en', 'de'
translations: {
    en: {
        title: 'Uppps. Your browser is too old ...',
        description: 'We recommend that you use a newer version!'
    }
},
backdropOpacity: '0.5',
backdropColor: '#000000',
closeColor: '#ffffff',
cookie: 'ubn-hidden',
showNotification: ['ie', 'edge'] // Possible options 'edge', 'edge-chromium', 'opera', 'chrome', 'ie', 'firefox', 'safari'

License

Copyright © 2021 Marvin Hübner and contributors

Licensed under the MIT license, see LICENSE for details.