@pluginjs/sticky v0.8.12

Sticky

A flexible modern sticky js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/sticky

NPM

npm i @pluginjs/sticky

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/sticky/dist/sticky.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/sticky/dist/sticky.css">

Production:

<script src="https://unpkg.com/@pluginjs/sticky/dist/sticky.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/sticky/dist/sticky.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Sticky from "@pluginjs/sticky"
import "@pluginjs/sticky/dist/sticky.css"

Sticky.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/sticky/dist/sticky.css")
const Sticky = require("@pluginjs/sticky")

Sticky.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/sticky/dist/sticky.css">
<script src="https://unpkg.com/@pluginjs/sticky/dist/sticky.js"></script>
<script>
  Pj.sticky('.element', options)
</script>

API

Options

Options are called on sticky instances through the sticky options itself. You can also save the instances to variable for further use.

Events

Events are called on sticky instances through the sticky events itself. You can also save the instances to variable for further use.

Methods

Methods are called on sticky instances through the sticky method itself. You can also save the instances to variable for further use.

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-sticky "DISABLED" | Announce plugin is disabled | {namespace}-disabled "PARENT" | Announce element is parent | {namespace}-parent "STICKY" | Announce element is sticky | {namespace}-sticky "STUCK" | Announce element is stuck | {namespace}-stuck "WRAP" | Announce element is wrap | {namespace}-wrap "DEFAULT" | Announce element is default | {namespace}-default

Browser support

Tested on all major browsers.

License

@pluginjs/sticky is Licensed under the GPL-v3 license.

If you want to use @pluginjs/sticky project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us purchase@thecreation.co.

Copyright

Copyright (C) 2022 Creation Studio Limited.