Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shinnn/get-scrollmax-y.js

Get the value equivalent to window.scrollMaxY
https://github.com/shinnn/get-scrollmax-y.js

Last synced: 27 days ago
JSON representation

Get the value equivalent to window.scrollMaxY

Awesome Lists containing this project

README

        

# get-scrollmax-y.js

[![Bower version](https://badge.fury.io/bo/get-scrollmax-y.svg)](https://github.com/shinnn/get-scrollmax-y.js/releases)
[![NPM version](https://badge.fury.io/js/get-scrollmax-y.svg)](https://www.npmjs.org/package/get-scrollmax-y)
[![Build Status](https://travis-ci.org/shinnn/get-scrollmax-y.js.svg?branch=master)](https://travis-ci.org/shinnn/get-scrollmax-y.js)
[![devDependency Status](https://david-dm.org/shinnn/get-scrollmax-y.js/dev-status.svg)](https://david-dm.org/shinnn/get-scrollmax-y.js#info=devDependencies)

[![browser support](https://ci.testling.com/shinnn/get-scrollmax-y.js.png)](https://ci.testling.com/shinnn/get-scrollmax-y.js)

Cross-browser library to get the value equivalent to [`window.scrollMaxY`](https://developer.mozilla.org/docs/Web/API/window.scrollMaxY)

## Installation

### Package managers

#### [Bower](http://bower.io/)

```sh
bower i --save get-scrollmax-y
```

#### [npm](https://www.npmjs.org/)

```sh
npm i --save get-scrollmax-y
```

#### [Duo](http://duojs.org/)

```javascript
var getScrollMaxY = require('shinnn/get-scrollmax-y.js');
```

### Standalone

[Download the script file directly.](https://raw.githubusercontent.com/shinnn/get-scrollmax-y.js/master/dist/get-scrollmax-y.js "view raw")

### [AMD](https://github.com/amdjs/amdjs-api/blob/master/AMD.md) support

This repository includes [the AMD-friendly build](https://raw.githubusercontent.com/shinnn/get-scrollmax-y.js/master/dist/get-scrollmax-y-amd.js) but the package managers doesn't include it. If you want to use it, download it directly.

## API

### getScrollMaxY()

Return: `Number`

## License

Copyright (c) 2014 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).