# @types/jquery.stickem

> TypeScript definitions for jquery.stickem

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

## Install

```sh
npm install @types/jquery.stickem
pnpm add @types/jquery.stickem
yarn add @types/jquery.stickem
bun add @types/jquery.stickem
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.4 |
| Published | 2023-11-07 |
| First published | 2018-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.4.4 (latest) — 2023-11-07
- 1.4.2 (ts3.6) — 2021-07-08
- 1.4.1 (ts2.3) — 2019-02-14
- 1.4.3 — 2023-10-18
- 1.4.0 — 2018-02-13

## README

# Installation
> `npm install --save @types/jquery.stickem`

# Summary
This package contains type definitions for jquery.stickem (https://github.com/davist11/jQuery-Stickem).

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

interface StickemSettings {
    /**
     * selector for element to make sticky
     */
    item?: string | undefined;

    /**
     * selector for content container, sizes matched with `item`
     */
    container?: string | undefined;

    /**
     * css class used to apply
     */
    stickClass?: string | undefined;

    /**
     * css class used to apply when ending sticky
     */
    endStickClass?: string | undefined;

    /**
     * offset to use for the sticky element in the parent element
     */
    offset?: number | string | undefined;

    /**
     * where to place sticky element
     */
    start?: number | string | undefined;

    /**
     * Callback to execute when in stick state
     */
    onStick?: (() => void) | undefined;

    /**
     * Callback to execute when getting out of stick state
     */
    onUnstick?: (() => void) | undefined;
}

interface JQuery {
    stickem(settings?: StickemSettings): JQuery;
}

````

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

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

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