Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pbojinov/arrow-js
A tiny library for displaying an arrow pointing to the browser download location
https://github.com/pbojinov/arrow-js
Last synced: 17 days ago
JSON representation
A tiny library for displaying an arrow pointing to the browser download location
- Host: GitHub
- URL: https://github.com/pbojinov/arrow-js
- Owner: pbojinov
- License: mit
- Created: 2014-07-08T03:16:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-11T11:35:31.000Z (almost 6 years ago)
- Last Synced: 2024-10-12T03:09:04.889Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://pbojinov.github.io/arrow-js/
- Size: 85.9 KB
- Stars: 62
- Watchers: 6
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
===
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
```html
```
Or use the minified version
```html
<script type="text/javascript" src="bower_components/ArrowJS/dist/arrow-0.1.9.min.js">
```
### Installing with Bower
Bower requires [Node](http://nodejs.org/) and [npm](http://npmjs.org/).
bower install arrow-js --save
### How to use
#### API
```javascript
//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
```javascript
//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
* The Firefox download manager was introduced in version 23 so the arrow will point in the top right.
* Chrome downloads start at the bottom left of the page.
* IE 9/10 downloads start in the bottom center.
* IE 8 downloads come up in the center of the screen unless the security warnings comes up at the top of the page. So the arrow points at the top left.
### Screenshots
Chrome
Firefox
IE 9/10 Wide Screen
IE 9/10 Narrow Screen
IE 11
EDGE
Safari
### Library Size
Original: 12482 bytes.
Minified: 4547 bytes.
### Maintainer
[Petar Bojinov](https://github.com/pbojinov)
### 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.