Skip to content

Latest commit

 

History

History
227 lines (144 loc) · 13.2 KB

CHANGELOG.md

File metadata and controls

227 lines (144 loc) · 13.2 KB
Raw

3.4.12 (2022-03-01)

Bug Fixes

3.4.11 (2021-02-01)

Bug Fixes

  • deps: [security] bump ini from 1.3.5 to 1.3.8 (2c138f7)

3.4.10 (2020-10-18)

Bug Fixes

  • deps: [security] bump npm-user-validate from 1.0.0 to 1.0.1 (108506c)

3.4.9 (2020-09-11)

Bug Fixes

  • deps: [security] bump node-fetch from 2.6.0 to 2.6.1 (be27be9)

3.4.8 (2020-07-10)

Bug Fixes

  • deps: bump @commitlint/cli from 8.3.5 to 9.0.1 (39ab8d8)

3.4.7 (2020-07-10)

Bug Fixes

  • deps: bump @commitlint/config-conventional from 8.3.4 to 9.0.1 (669d2a4)

3.4.6 (2020-07-10)

Bug Fixes

  • deps: bump @babel/preset-env from 7.10.2 to 7.10.4 (03ef58e)

3.4.5 (2020-07-10)

Bug Fixes

  • deps: bump @babel/core from 7.10.2 to 7.10.4 (03c089d)
  • deps: bump rollup from 2.17.0 to 2.21.0 (c9e6e13)

3.4.4 (2020-07-10)

Bug Fixes

  • deps: [security] bump npm-registry-fetch from 4.0.4 to 4.0.5 (6f3183a)

3.4.3 (2020-06-18)

Bug Fixes

  • build: push changelog during release (80f80bc)

3.3.3 (2020-06-17)

Bug Fixes

  • build: trigger publish action (512fb82)

3.3.2 (2020-06-17)

Bug Fixes

  • deps: bump @babel/core from 7.10.0 to 7.10.1 (3122d54)
  • deps: bump @babel/core from 7.10.1 to 7.10.2 (8c14cf4)
  • deps: bump @babel/core from 7.9.6 to 7.10.0 (277434f)
  • deps: bump @babel/preset-env from 7.10.0 to 7.10.1 (61ae559)
  • deps: bump @babel/preset-env from 7.10.1 to 7.10.2 (7ee6666)
  • deps: bump @babel/preset-env from 7.9.6 to 7.10.0 (6876854)
  • deps: bump rollup from 2.10.0 to 2.10.2 (c950b15)
  • deps: bump rollup from 2.10.2 to 2.10.3 (73faade)
  • deps: bump rollup from 2.10.3 to 2.10.4 (0ad14e8)
  • deps: bump rollup from 2.10.4 to 2.10.5 (d51a8f2)
  • deps: bump rollup from 2.10.5 to 2.10.7 (e554d04)
  • deps: bump rollup from 2.10.7 to 2.10.8 (6afa1d5)
  • deps: bump rollup from 2.10.8 to 2.11.0 (a2a44bb)
  • deps: bump rollup from 2.11.0 to 2.11.2 (fee09f4)
  • deps: bump rollup from 2.11.2 to 2.12.0 (7b52629)
  • deps: bump rollup from 2.12.0 to 2.12.1 (0029462)
  • deps: bump rollup from 2.12.1 to 2.13.0 (008a4c8)
  • deps: bump rollup from 2.13.0 to 2.13.1 (707f501)
  • deps: bump rollup from 2.13.1 to 2.15.0 (7b0478b)
  • deps: bump rollup from 2.15.0 to 2.16.1 (1dd3979)
  • deps: bump rollup from 2.8.2 to 2.9.0 (2482ff5)
  • deps: bump rollup from 2.9.0 to 2.9.1 (24b8875)
  • deps: bump rollup from 2.9.1 to 2.10.0 (7f017a4)
  • deps: bump serve from 11.3.0 to 11.3.1 (f25b2de)
  • deps: bump serve from 11.3.1 to 11.3.2 (f7d5db7)

3.3.1 (2020-05-07)

Bug Fixes

  • deps: bump @babel/core from 7.9.0 to 7.9.6 (5e11179)
  • deps: bump @babel/preset-env from 7.9.0 to 7.9.5 (faaf387)
  • deps: bump @babel/preset-env from 7.9.5 to 7.9.6 (4e209eb)
  • deps: bump husky from 4.2.3 to 4.2.5 (3c39a96)
  • deps: bump prettier from 2.0.2 to 2.0.3 (844ea3a)
  • deps: bump prettier from 2.0.3 to 2.0.4 (f49d888)
  • deps: bump prettier from 2.0.4 to 2.0.5 (f972304)
  • deps: bump rollup from 2.3.1 to 2.3.2 (1b33f02)
  • deps: bump rollup from 2.3.2 to 2.3.3 (17a966d)
  • deps: bump rollup from 2.3.3 to 2.3.4 (a43f5b9)
  • deps: bump rollup from 2.3.4 to 2.3.5 (80ed729)
  • deps: bump rollup from 2.3.5 to 2.4.0 (3e9ce75)
  • deps: bump rollup from 2.4.0 to 2.5.0 (d10e8ec)
  • deps: bump rollup from 2.5.0 to 2.6.0 (e623a13)
  • deps: bump rollup from 2.6.0 to 2.6.1 (0edd24a)
  • deps: bump rollup from 2.6.1 to 2.7.0 (c6f789e)
  • deps: bump rollup from 2.7.0 to 2.7.1 (abcefb0)
  • deps: bump rollup from 2.7.1 to 2.7.2 (66938e1)
  • deps: bump rollup from 2.7.2 to 2.7.3 (638794a)
  • deps: bump rollup from 2.7.3 to 2.7.5 (123549f)
  • deps: bump rollup from 2.7.5 to 2.7.6 (88770c6)
  • deps: bump rollup from 2.7.6 to 2.8.0 (f9b003b)
  • deps: bump rollup from 2.8.0 to 2.8.1 (ffefff7)
  • deps: bump rollup from 2.8.1 to 2.8.2 (19a4cac)
  • deps: bump standard-version from 7.1.0 to 8.0.0 (5a14273)
  • deps: fix security vulnerabilities (17cd717)

3.3.0 (2020-03-31)

Features

  • Pass sticky position back in event (1e7e04f)
  • Normalize event data (1e7e04f)

The data passed back in StickyEvents.CHANGE, StickyEvents.STUCK, and StickyEvents.UNSTUCK is now consistent.

The event.detail now looks like:

{
  isSticky: Boolean,
  position: StickyEvents.POSITION_BOTTOM|StickyEvents.POSITION_TOP,
}

3.1.3 (2020-02-22)

Testing out semi-automated releases!

Refactor

  • Remove unnecessary forEach from sentinel observers

3.1.0

New Features

  • Add addSticky, addStickies methods

3.0.0

Breaking changes

  • The StickyEvents class is now the only method of enabling and disabling sticky elements
  • Previously deprecated elements have been removed. See v2.3.0 Deprecations notes for list.

v2.3.0

New Features

  • The new StickyEvents class is now the preferred method of enabling and disabling sticky elements.
  • Add container option. Defaults to document
  • Add enabled option. Defaults to true
  • Add stickySelector option. Defaults to .sticky-events

Example:

import StickyEvents from "sticky-events";

// Create new StickyEvents instance, this enables sticky events automatically

const stickyEvents = new StickyEvents({
  container: document.querySelector(".my-sticky-container"),
  enabled: false,
  stickySelector: ".custom-sticky-selector",
});

// Enable events

stickyEvents.enableEvents();

// Add event listeners

const { stickyElements } = stickyEvents;

stickyElements.forEach((sticky) => {
  sticky.addEventListener(StickyEvents.CHANGE, (event) => {
    sticky.classList.toggle("bg-dark", event.detail.isSticky);
  });
});

// Disable events

stickyEvents.disableEvents();

Deprecations

  • sticky-events.css is no longer required, this file will be removed in v3.0.
  • observeStickyEvents function is now deprecated, it will be removed in v3.0.
  • unobserveStickyEvents function is now deprecated, it will be removed in v3.0.
  • StickyEvent export is now deprecated, it will be removed in v3.0.