# mobilescroll

> small tool for smooth and easy touch in mobile device

Latest version **1.5.8** (published 2019-12-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install mobilescroll
pnpm add mobilescroll
yarn add mobilescroll
bun add mobilescroll
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.8 |
| Published | 2019-12-30 |
| First published | 2017-12-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 104 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | markli |
| Maintainers | limark |
| Keywords | scroll, mobile, touch, safari |

## Links

- npm: https://www.npmjs.com/package/mobilescroll
- Repository: https://github.com/benbenkoulan/MobileScroll
- Homepage: https://github.com/benbenkoulan/MobileScroll#readme
- Issues: https://github.com/benbenkoulan/MobileScroll/issues
- npm.io page: https://npm.io/package/mobilescroll

## Dependencies (1)

- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0

## Recent versions

- 1.5.8 (latest) — 2019-12-30
- 1.5.7 — 2019-12-30
- 1.5.6 — 2019-07-24
- 1.5.5 — 2019-07-24
- 1.5.4 — 2019-07-24
- 1.5.3 — 2019-07-24
- 1.5.2 — 2019-07-23
- 1.5.1 — 2019-07-23
- 1.5.0 — 2019-07-23
- 1.4.0 — 2019-06-17
- 1.3.0 — 2018-08-22
- 1.2.2 — 2018-07-31
- 1.2.1 — 2018-07-31
- 1.2.0 — 2018-01-22
- 1.1.4 — 2018-01-19
- … 7 more at https://npm.io/package/mobilescroll/versions

## README

# MobileScroll
A small tool for smooth and easy touch in mobile device;

## **Install**

npm install mobilescroll --save

## **Usage**

```
<script src="mobile.scroll.mini.js"></script>

or

import MobileScroll from 'mobilescroll';

when your project is client-side render, you can use mobilescroll as above, 
but if your project is server-side render, you may use it as follows.

import('mobilescroll').then((MobileScroll) => {
    // ......
});

```
```
<div class="wrapper">
    <div class="scroller">
        <p class="item"></p>
        <p class="item"></p>
        <p class="item"></p>
        <p class="item"></p>
    </div>
</div>
```

```
new MobileScroll('.wrapper', //selector or dom element of the wrapper
{
        
    deceleration: 0.002, //Default 0.002
    noOutOfBounds: true, //optional flag which allow to be out of bounds, Default: false
    noBounce: true, //switch of bounce. Default: false. Optional
    wheel: true,    //the property about 3D. Default: false. Optional
    slide: true,    //the property about inertance. Default: false. Optional
    loop: true,     //switch of loop. Default: false. Optional
    step: 200,      //the step at each slide. Optional
    name: 'mscroll',    //the name of your mobilescroll instance. Optional
    vertical: true,     //whether the direction is vertical. Default: false
    bounceThreshold: 0.5,   //the threshod of bounce. Default: 0.5
    min: -100,  //the min value of scoller can move. Required
    max: 0     //the max value of scroll can move. Required
})
```


## **API**

### methods

### slideTo
---
#### Description
    slide to the block with specific index
#### Parameters
    i   index
    duration    slide duration


### getIndex
---
#### Description
    get the current index
#### Parameters
   none

### startAutoPlay
---
#### Description
    open the auto-play mode
#### Parameters
    none

### stopAutoPlay
---
#### Description
    close the auto-play mode
#### Parameters
    none
    
### pause
---
#### Description
    pause auto-play
#### Parameters
    none

    
### destroy
---
#### Description
    destroy the mobilescroll instance
#### Parameters
    none

---
### 
### events

#### start
#### move
#### end

```
ms.on('start', function(){
    // note that the context 'this' is point to MobileScroll instance "ms"
    // or you can give a arrow function an access the instance by "ms" directly
});
```

---
_Source: https://npm.io/package/mobilescroll · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._