# @types/scrollreveal

> TypeScript definitions for scrollreveal

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

## Install

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

## 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.0.11 |
| Published | 2023-11-07 |
| First published | 2016-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

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

## Recent versions

- 0.0.11 (latest) — 2023-11-07
- 0.0.8 (ts3.9) — 2022-04-27
- 0.0.7 (ts3.6) — 2021-07-06
- 0.0.6 (ts2.8) — 2020-01-21
- 0.0.5 (ts2.0) — 2019-07-09
- 0.0.10 — 2023-10-18
- 0.0.9 — 2023-09-25
- 0.0.4 — 2018-08-24
- 0.0.3 — 2017-10-11
- 0.0.2 — 2016-10-05
- 0.0.1 — 2016-09-21

## README

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

# Summary
This package contains type definitions for scrollreveal (https://github.com/jlmakes/scrollreveal.js).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scrollreveal.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scrollreveal/index.d.ts)
````ts
declare const ScrollReveal: scrollReveal.ScrollRevealObject;

declare module "scrollreveal" {
    export = ScrollReveal;
}

declare namespace scrollReveal {
    interface ScrollRevealRotateObject {
        x?: number | undefined;
        y?: number | undefined;
        z?: number | undefined;
    }

    interface ScrollRevealPositionObject {
        top?: number | undefined;
        right?: number | undefined;
        bottom?: number | undefined;
        left?: number | undefined;
    }

    interface ScrollRevealObjectOptions {
        origin?: string | undefined;
        distance?: string | undefined;
        duration?: number | undefined;
        delay?: number | undefined;
        interval?: number | undefined;
        rotate?: ScrollRevealRotateObject | undefined;
        opacity?: number | undefined;
        scale?: number | undefined;
        easing?: string | undefined;
        cleanup?: boolean | undefined;
        container?: any;
        mobile?: boolean | undefined;
        reset?: boolean | undefined;
        useDelay?: string | undefined;
        viewFactor?: number | undefined;
        viewOffset?: ScrollRevealPositionObject | undefined;
        beforeReveal?(domEl: HTMLElement | NodeListOf<Element>): void;
        afterReveal?(domEl: HTMLElement | NodeListOf<Element>): void;
        beforeReset?(domEl: HTMLElement | NodeListOf<Element>): void;
        afterReset?(domEl: HTMLElement | NodeListOf<Element>): void;
    }

    interface ScrollRevealObject {
        (): ScrollRevealObject;
        (options: ScrollRevealObjectOptions): ScrollRevealObject;
        clean(selector: string | HTMLElement | NodeListOf<Element>): void;
        destroy(): void;
        reveal(selector: string | HTMLElement | NodeListOf<Element>): ScrollRevealObject;
        reveal(selector: string | HTMLElement | NodeListOf<Element>, interval: number): ScrollRevealObject;
        reveal(
            selector: string | HTMLElement | NodeListOf<Element>,
            options: ScrollRevealObjectOptions,
        ): ScrollRevealObject;
        reveal(
            selector: string | HTMLElement | NodeListOf<Element>,
            options: ScrollRevealObjectOptions,
            interval: number,
        ): ScrollRevealObject;

        sync(): void;
    }
}

````

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

# Credits
These definitions were written by [David Pires](https://github.com/Davidblkx).

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