weprovide/magento2-module-headroom

data-mage-init integration for Headroom.js

Installs: 18 159

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 6

Forks: 3

Open Issues: 0

Language:JavaScript

1.0.7 2022-12-08 12:00 UTC

This package is auto-updated.

Last update: 2024-04-08 16:25:00 UTC


README

data-mage-init integration for Headroom.js

Installation

  1. composer require weprovide/magento2-module-headroom
  2. bin/magento setup:upgrade

Usage example

<script type="text/x-magento-init">
  {
    ".page-header": {
      "WeProvide_Headroom/headroom": {
         "classes": {
             "initial": "animated",
             "pinned": "slideDown",
             "unpinned": "slideUp"
         }
       }
    }
  }
</script>

Programmatic API

define(['WeProvide_Headroom/headroom'], function (headroom) {
  // Headroom configuration. See http://wicky.nillia.ms/headroom.js for all options
  var configuration = {
    classes: {
      initial: 'animated',
      pinned: 'slideDown',
      unpinned: 'slideUp'
    }
  }

  // Element to intialize Headroom on.
  var element = document.querySelector("header")

  var instance = headroom(configuration, element)

  // Dynamically update options after initializing
  instance.classes.pinned = 'slideDown-new'
});

Using Headroom.js directly

define(['headroom'], function (Headroom) {
  // Headroom configuration. See http://wicky.nillia.ms/headroom.js for all options
  var configuration = {}

  // Element to intialize Headroom on.
  var element = document.querySelector("header")

  var instance = new Headroom(element, configuration)

  instance.init()
});