1.4.4 • Published 6 months ago
@types/jquery.stickem v1.4.4
Installation
npm install --save @types/jquery.stickem
Summary
This package contains type definitions for jquery.stickem.js (https://github.com/davist11/jQuery-Stickem).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery.stickem.
index.d.ts
// Type definitions for non-npm package jquery.stickem.js 1.4
// Project: https://github.com/davist11/jQuery-Stickem
// Definitions by: David Paz <https://github.com/davidmpaz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
/// <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: Thu, 08 Jul 2021 16:22:41 GMT
- Dependencies: @types/jquery
- Global values: none
Credits
These definitions were written by David Paz.