collant v1.3.0

collant

( prounouce kɔlɑ̃ ) À la française

(Another) Small package to stick your elements without jQuery (😈)

Installation

npm install --save collant

Usage

Markup

Here the .sidebar is the element you want to be sticky. You need put the class wrapper-collant on the container you want your element to be sticked to.

<div class='container wrapper-collant'>
  <div class='sidebar'>
    Je suis collant
  </div>
</div>

If you ask for wrapper: false (see Arguments 👇), the class wrapper-collant is needed on the body.

CSS

In order to work collant need some lines of CSS. Just paste them in your styles file.

.wrapper-collant{
    position: relative;
}
.collant{
    position: fixed !important;
}
.collant-stuck{
    position: absolute;
}

JS

Import the package. Then call the function with your arguments.

import collant from 'collant';
const collant = require('collant');

collant(element, offsetTop, options);

Arguments

• element DOM element
  The element you want to be sticky.

• offsetTop Number
  The offset between the top of your element and the top of the viewport. Value in pixel ( for viewport based value see options 👇 )

• options Object
  Object of optionnal arguments

  • unit String
    Choose the unit for the offsetTop.
        values: 'px' or 'vh'
        default: 'px'

  • updateHeightOnScroll Boolean
    If you need to update the height of your sticky element on scroll. For example if you changed its height dynamically.
        default: false

  • wrapper Boolean
    Whether you need or not a wrapper-collant. If not your sticky element will be sticked to the viewport.
        default: true
    
  • minimumWidth Number
    Viewport width where the sticky effect is applied. If the viewport is below this width your element won't be stiky anymore 👋
         default: false
  • bottom Boolean
    If you want your sidebar to stick to the bottom instead of the top      default: false

  • More to come

Example

  const el = document.querySelector('#sidebar');
  
  collant(el, 15, {
    unit = 'vh',
    minimuWidth: 780,
  });