# @types/scrolltofixed

> TypeScript definitions for scrolltofixed

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

## Install

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

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

## Links

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

## Dependencies (1)

- [@types/jquery](https://npm.io/package/@types/jquery.md) *

## Recent versions

- 0.0.33 (latest) — 2023-11-07
- 0.0.30 (ts3.6) — 2021-07-06
- 0.0.29 (ts3.0) — 2020-05-15
- 0.0.28 (ts2.3) — 2017-06-15
- 0.0.27 (ts2.0) — 2016-09-19
- 0.0.32 — 2023-10-18
- 0.0.31 — 2023-09-25
- 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
- 0.0.20-alpha — 2016-05-25
- 0.0.19-alpha — 2016-05-20
- … 2 more at https://npm.io/package/@types/scrolltofixed/versions

## README

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

# Summary
This package contains type definitions for scrolltofixed (https://github.com/bigspotteddog/ScrollToFixed).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scrolltofixed.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scrolltofixed/index.d.ts)
````ts
/// <reference types="jquery" />

declare namespace ScrollToFixed {
    interface ScrollToFixedOptions {
        marginTop?: number | (() => number) | undefined;
        limit?: number | (() => number) | undefined;
        bottom?: number | undefined;
        zIndex?: number | undefined;
        spacerClass?: string | undefined;
        preFixed?: (() => void) | undefined;
        postFixed?: (() => void) | undefined;
        fixed?: (() => void) | undefined;
        unfixed?: (() => void) | undefined;
        preUnfixed?: (() => void) | undefined;
        postUnfixed?: (() => void) | undefined;
        preAbsolute?: (() => void) | undefined;
        postAbsolute?: (() => void) | undefined;
        offsets?: boolean | undefined;
        minWidth?: number | undefined;
        maxWidth?: number | undefined;
        dontCheckForPositionFixedSupport?: boolean | undefined;
        dontSetWidth?: boolean | undefined;
        removeOffsets?: boolean | undefined;
        baseClassName?: string | undefined;
        className?: string | undefined;
    }
}

interface JQuery {
    scrollToFixed: (options?: ScrollToFixed.ScrollToFixedOptions) => JQuery[];
}

interface JQueryStatic {
    isScrollToFixed(el: Element): JQuery;
    isScrollToFixed(el: Element[]): JQuery;
    isScrollToFixed(el: {}): JQuery;
    isScrollToFixed(el: JQuery): JQuery;

    ScrollToFixed(el: Element, options: ScrollToFixed.ScrollToFixedOptions): void;
    ScrollToFixed(el: Element, options: ScrollToFixed.ScrollToFixedOptions): JQuery;
    ScrollToFixed(el: Element[], options: ScrollToFixed.ScrollToFixedOptions): JQuery;
    ScrollToFixed(el: {}, options: ScrollToFixed.ScrollToFixedOptions): JQuery;
    ScrollToFixed(el: JQuery, options: ScrollToFixed.ScrollToFixedOptions): JQuery;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/jquery](https://npmjs.com/package/@types/jquery)

# Credits
These definitions were written by [Ben Dixon](https://github.com/bmdixon).

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