Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@types/jquery-sticky
Advanced tools
TypeScript definitions for jquery-sticky
npm install --save @types/jquery-sticky
This package contains type definitions for jquery-sticky (https://github.com/garand/sticky).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery-sticky.
/// <reference types="jquery" />
interface JQueryStickyOptions {
/**
* Pixels between the page top and the element's top.
* @default 0
*/
topSpacing?: number | undefined;
/**
* Pixels between the page bottom and the element's bottom.
* @default 0
*/
bottomSpacing?: number | undefined;
/**
* CSS class added to the element's wrapper when "sticked".
* @default is-sticky
*/
className?: string | undefined;
/**
* CSS class added to the wrapper.
* @default 'sticky-wrapper'
*/
wrapperClassName?: string | undefined;
/**
* Boolean determining whether the sticky element should be horizontally centered in the page.
* @default false
*/
center?: boolean | undefined;
/**
* Selector of element referenced to set fixed width of "sticky" element.
* @default ''
*/
getWidthFrom?: string | undefined;
/**
* Boolean determining whether width of the "sticky" element should be updated to match the wrapper's width.
* Wrapper is a placeholder for "sticky" element while it is fixed (out of static elements flow), and its width depends on the context and CSS rules.
* Works only as long getWidthForm isn't set.
* @default true
*/
widthFromWrapper?: boolean | undefined;
/**
* Boolean determining whether widths will be recalculated on window resize (using getWidthfrom).
* @default false
*/
responsiveWidth?: boolean | undefined;
/**
* Controls z-index of the sticked element.
* @default inherit
*/
zIndex?: string | undefined;
}
interface JQuery {
/**
* Initializer. options is optional.
*/
sticky(options?: JQueryStickyOptions): JQuery;
/**
* Recalculates the element's position.
*/
sticky(method: "update"): JQuery;
/**
* To unstick an object.
*/
unstick(): JQuery;
}
These definitions were written by Matthieu Tabuteau.
FAQs
TypeScript definitions for jquery-sticky
We found that @types/jquery-sticky demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.