# @types/scroller

> TypeScript definitions for scroller

Latest version **0.1.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/scroller
pnpm add @types/scroller
yarn add @types/scroller
bun add @types/scroller
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/scroller
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scroller
- npm.io page: https://npm.io/package/@types/scroller

## Recent versions

- 0.1.5 (latest) — 2023-11-07
- 0.1.2 (ts3.6) — 2021-07-06
- 0.1.1 (ts2.0) — 2019-02-13
- 0.1.4 — 2023-10-18
- 0.1.3 — 2023-09-25
- 0.1.0 — 2017-12-29
- 0.0.29 — 2017-01-06
- 0.0.28 — 2016-09-19
- 0.0.27 — 2016-07-19
- 0.0.26 — 2016-07-14
- 0.0.25-alpha — 2016-07-08
- 0.0.24-alpha — 2016-07-04
- 0.0.23-alpha — 2016-07-02
- 0.0.22-alpha — 2016-07-01
- 0.0.21-alpha — 2016-07-01
- … 4 more at https://npm.io/package/@types/scroller/versions

## README

# Installation
> `npm install --save @types/scroller`

# Summary
This package contains type definitions for scroller (http://zynga.github.com/scroller/).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scroller.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scroller/index.d.ts)
````ts
declare namespace Scroller {
    interface Options {
        scrollingX?: boolean | undefined;
        scrollingY?: boolean | undefined;
        animating?: boolean | undefined;
        animationDuration?: number | undefined;
        bouncing?: boolean | undefined;
        locking?: boolean | undefined;
        paging?: boolean | undefined;
        snapping?: boolean | undefined;
        zooming?: number | undefined;
        minZoom?: number | undefined;
        maxZoom?: number | undefined;
    }
}

declare class Scroller {
    constructor(callback: (left: number, top: number, zoom: number) => void, options?: Scroller.Options);
    setDimensions(clientWidth: number, clientHeight: number, contentWidth: number, contentHeight: number): void;
    setPosition(clientLeft: number, clientTop: number): void;
    setSnapSize(width: number, height: number): void;
    activatePullToRefresh(height: number, activate: () => void, deactivate: () => void, start: () => void): void;
    finishPullToRefresh(): void;
    getValues(): {
        left: number;
        top: number;
        zoom: number;
    };
    getScrollMax(): { left: number; top: number };
    zoomTo(level: number, animate?: boolean, originLeft?: number, originTop?: number, callback?: () => void): void;
    zoomBy(factor: number, animate?: boolean, originLeft?: number, originTop?: number, callback?: () => void): void;
    scrollTo(left: number, top: number, animate?: boolean, zoom?: number): void;
    scrollBy(leftOffset: number, topOffset: number, animate?: boolean): void;

    doMouseZoom(wheelData: number, timeStamp: number, pageX: number, pageY: number): void;
    doTouchStart(
        touches: Array<{
            pageX: number;
            pageY: number;
        }>,
        timeStamp: number,
    ): void;
    doTouchMove(
        touches: Array<{
            pageX: number;
            pageY: number;
        }>,
        timeStamp: number,
        scale?: number,
    ): void;
    doTouchEnd(timeStamp: number): void;
}

declare class EasyScroller {
    constructor(content: any, options: Scroller.Options);

    render(): void;
    reflow(): void;
    bindEvents(): void;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Marcelo Haskell Camargo](https://github.com/haskellcamargo).

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