1.0.4 • Published 5 years ago
xscroll-controller v1.0.4
xscroll-controller
Allowing horizontal scrolling when vertical scroll is moved to top or bottom
Install
Using npm:
npm install xscroll-controller --saveUsing a script tag:
<script src="./xscrollController.min.js"></script>API
Init
var wrapperDom = document.querySelector('.wrapper');
var innerDom = document.querySelector('.inner');
var xscrollController = XscrollController(wrapperDom, innerDom);Instance Functions
| Function | Description | Require Parameters |
|---|---|---|
| setOptions | pass an options object to update the instance's configuration (for more configurations plz see below) | Yes |
| destory | destory the instance | No |
configurations for "setOptions"
| Name | Description | Type | Default |
|---|---|---|---|
| allowXScroll | enable to control horizontal scrolling | Boolean | true |
Example
// setOptions
xscrollController.setOptions({allowXScroll: false});// destory
xscrollController.destory();