pbojinov / arrow-js

A tiny library for displaying an arrow pointing to the browser download location
http://pbojinov.github.io/arrow-js/
MIT License
61 stars 13 forks source link

Arrow.js

Arrow.js is a tiny library (4.5kb gzipped) for displaying an arrow pointing to the browser download location. Perfect for pointing at that new file you downloaded!

Get Started

Include the javascript in your HTML

<script type="text/javascript" src="https://github.com/pbojinov/arrow-js/raw/master/bower_components/ArrowJS/src/js/arrow.js">

Or use the minified version

<script type="text/javascript" src="https://github.com/pbojinov/arrow-js/raw/master/bower_components/ArrowJS/dist/arrow-0.1.9.min.js">

Installing with Bower

Bower requires Node and npm.

bower install arrow-js --save

How to use

API

//Display the Arrow for 5 seconds
//
//@param milliseconds {integer} Show the arrow for this many milliseconds then fade
//out. Defaults to 6000 milliseconds (6 seconds)
Arrow.show(5000);

Properties

//Get Arrow.js Version
Arrow._version;

//Get Current Browser
Arrow._browser;

//Get Current Browser Version
Arrow._browserVersion 

Browser Support

Chrome 4+, Firefox 3.5+, IE 8+, Edge (Windows 10), Safari

Screenshots

Chrome

Chrome

Firefox

Firefox

IE 9/10 Wide Screen

IE 9/10 Wide

IE 9/10 Narrow Screen

IE 9/10 Narrow

IE 11

IE11

EDGE

EDGE

Safari

Safari

Library Size

Original: 12482 bytes.

Minified: 4547 bytes.

Maintainer

Petar Bojinov

License

The MIT License (MIT)

Copyright (c) 2017 Petar Bojinov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.