0.1.1 • Published 3 years ago

@windsor-telecom/browser-check v0.1.1

Weekly downloads
76
License
MIT
Repository
-
Last release
3 years ago

browser-check

Provides a simple way to provide browser compatibility handling.

Quickstart to Use browser-check in Other Projects

In index.html:

  1. Add the onLoad function to the <body> tag:

    <body onLoad="javascript:onLoad();">
  2. Add the following script tags within the <body> tag:

    <script type="text/javascript" src="https://unpkg.com/@windsor-telecom/browser-check@latest/check.min.js"></script>
    <script type="text/javascript" src="https://unpkg.com/@windsor-telecom/browser-check@latest/bowser.min.js"></script>
  3. Add the following HTML error banner template within the <body> tag:

    <div class="v-alert error" id="browser-check" style="display: none">
        <i aria-hidden="true" class="v-icon material-icons theme--light v-alert__icon">warning</i>
        <div class="flex title">
            For a better experience, please download or use the latest version of Chrome, Edge, or Firefox.
        </div>
        <i aria-hidden="true" class="v-icon material-icons theme--light" style="cursor: pointer" onClick="javascript:onClose();">close</i>
    </div>

Your final index.html code should look something similar to what is shown below. Please note that this project assumes Vuetify is being used.

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width,initial-scale=1.0">
        <title>App Title</title>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900">
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Material+Icons">
    </head>
    <body onLoad="javascript:onLoad();">
    <script type="text/javascript" src="https://unpkg.com/@windsor-telecom/browser-check@0.0.1/check.min.js"></script>
    <script type="text/javascript" src="https://unpkg.com/@windsor-telecom/browser-check@0.0.1/bowser.min.js"></script>
    <noscript>
        <strong>
            We're sorry but App Title doesn't work properly without JavaScript enabled. Please enable it to continue.
        </strong>
    </noscript>
    <div class="v-alert error" id="browser-check" style="display: none">
        <i aria-hidden="true" class="v-icon material-icons theme--light v-alert__icon">warning</i>
        <div class="flex title">
            For a better experience, please download or use the latest version of Chrome, Edge, or Firefox.
        </div>
        <i aria-hidden="true" class="v-icon material-icons theme--light" style="cursor: pointer" onClick="javascript:onClose();">close</i>
    </div>
    <div id="app"></div>
    <!-- built files will be auto injected -->
    </body>
</html>

General Information

browser-check contains two important files:

  1. bowser.min.js, a minified copy of bowser which aids obtaining browser details.
  2. check.min.js, which contains an onLoad and onClose function to handle browser compatibility checks.

HTML Template

This project assumes Vuetify is being used.

The HTML shown below must be added to the index.html file in projects using browser-check.

<div class="v-alert error" id="browser-check" style="display: none">
    <i aria-hidden="true" class="v-icon material-icons theme--light v-alert__icon">warning</i>
    <div class="flex title">
        For a better experience, please download or use the latest version of Chrome, Edge, or Firefox.
    </div>
    <i aria-hidden="true" class="v-icon material-icons theme--light" style="cursor: pointer" onClick="javascript:onClose();">close</i>
</div>

Quickstart for Developers

  1. Clone this repo
  2. Make changes to check.min.js and/or bowser.js
  3. Run yarn run minify to update the minified files
  4. Test changes
  5. Create a merge request
  6. Merge the request
  7. Deploy the changes by running yarn run deploy (you must be logged in as it-support@windsor-telecom.co.uk in npm)
0.1.1

3 years ago

0.0.5

3 years ago

0.0.4

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago