# jquery-scrollsync

> A jQuery plug-in that synchronizes the scrolling of several containers with scrollbars, such as iframe.(It works like bidirectional bindings, which let containers' scrollTop and scrollLeft synchronous, and using conditional bidirectional bindings which ca

Latest version **1.0.4** (published 2018-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install jquery-scrollsync
pnpm add jquery-scrollsync
yarn add jquery-scrollsync
bun add jquery-scrollsync
```

## 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.0.4 |
| Published | 2018-03-01 |
| First published | 2018-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | 1010543618 |

## Links

- npm: https://www.npmjs.com/package/jquery-scrollsync
- Repository: https://github.com/1010543618/jquery-ScrollSync
- Homepage: https://github.com/1010543618/jquery-ScrollSync#readme
- Issues: https://github.com/1010543618/jquery-ScrollSync/issues
- npm.io page: https://npm.io/package/jquery-scrollsync

## Dependencies (2)

- [jquery](https://npm.io/package/jquery.md) ^3.3.1
- [jquery-smartresizeandscroll](https://npm.io/package/jquery-smartresizeandscroll.md) ^1.0.4

## Recent versions

- 1.0.4 (latest) — 2018-03-01
- 1.0.3 — 2018-02-28
- 1.0.2 — 2018-02-28
- 1.0.1 — 2018-02-27
- 1.0.0 — 2018-02-26

## README

# jquery-ScrollSync
A jQuery plug-in that synchronizes the scrolling of several containers with scrollbars, such as iframe.(It works like bidirectional bindings, which let containers' scrollTop and scrollLeft synchronous, and using conditional bidirectional bindings which can avoid cycle synchronizes.)

## Installation
npm安装：

```
npm install jquery-scrollsync
```

## Usage

默认同步滚动：

```
$('selector').scrollsync()
```

取消同步滚动：

```
$('selector').closeScrollsync()
```

不同步横向滚动条：

```
$('selector').scrollsync({x_sync: false})
```

不同步纵向滚动条：

```
$('selector').scrollsync({y_sync: false})
```

使用smartscroll（使滚动事件执行频率降低，默认10ms内只触发一次）：

```
$('selector').scrollsync({use_smartscroll: true})
```

使用smartscroll且自定义触发间隔时间为30ms：

```
$('selector').scrollsync({smartscroll_delay: true, smartscroll_delay: 30})
```

## Options

Option | Default value | Type | Description
---|---|---|---
x_sync|true|Boolean|是否绑定横向滚动条
y_sync|true|Boolean|是否绑定纵向滚动条
use_smartscroll|false|Boolean|是否使滚动事件执行频率降低，默认10ms内只触发一次
smartscroll_delay|10|Number|自定义use\_smartscroll的触发间隔

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