# vue-mugen-scroll [![NPM version](https://img.shields.io/npm/v/vue-mugen-scroll.svg?style=flat-square)](https://npmjs.com/package/vue-mugen-scroll) [![NPM downloads](https://img.shields.io/npm/dm/vue-mugen-scroll.svg?style=flat-square)](https://npmjs.com/package/vue-mugen-scroll) [![Build Status](https://img.shields.io/circleci/project/egoist/vue-mugen-scroll/master.svg?style=flat-square)](https://circleci.com/gh/egoist/vue-mugen-scroll) **むげん [mugen]** means Infinity in English. ## Features - Small, only weighs 2kb - Insanely easy to use, it's just a component with a couple props ## Install ```bash $ npm install --save vue-mugen-scroll ``` CDN: https://unpkg.com/vue-mugen-scroll/dist/ Demo: [JSFiddle](https://jsfiddle.net/jericopulvera/wq07brjs/17/) ## Usage ```vue ``` ## API ### props #### handler Type: `function`
Required: `true` The handler function to run after you scroll to the bottom of the list. It will also be invoked on component mounted and the `mugen-scroll` component is visible in viewport. #### handleOnMount Type: `boolean`
Default: `true` Invoke the handler function on component mounted. #### shouldHandle Type: `boolean`
Default: `true` Add an additional condition to check if it should invoke the handler function, for example you don't want it to be invoked again as it's loading. #### threshold Type: `number`
Default: `0` Set the ratio of the ``'s height and width that needs to be visible for it to be considered in viewport. This defaults to 0, meaning any amount. A threshold of 0.5 or 1 will require that half or all, respectively, of the element's height and width need to be visible. threshold must be a number between 0 and 1 #### scrollContainer Type: `string` If the container of your list is scrollable, you can specific the reference ID of the container, so that we can detect the `scroll` event of this element instead of `window`. ```vue ``` ## Development You can run the example with [vbuild](https://github.com/egoist/vbuild) ```bash git clone https://github.com/egoist/vue-mugen-scroll.git cd vue-mugen-scroll yarn yarn example ``` ## Contributing 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` 3. Commit your changes: `git commit -am 'Add some feature'` 4. Push to the branch: `git push origin my-new-feature` 5. Submit a pull request :D ## License [MIT](https://egoist.mit-license.org/) © [EGOIST](https://github.com/egoist)

vue-mugen-scroll

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past