2.0.2 • Public • Published

    Direction Reveal

    A plugin that detects the direction a user enters or leaves an element allowing you to reveal or hide content based on this direction.

    View demo


    $ npm install direction-reveal --save-dev


    Import JS

    The script is an ES6(ES2015) module but the compiled version is included in the build as "src/scripts/direction-reveal-umd.js". You can also copy "src/scripts/direction-reveal.js" into your own site if your build process can accommodate ES6 modules.

    import DirectionReveal from 'direction-reveal';
    // Init with default setup
    const directionRevealDemo = DirectionReveal();
    // Init with all options at default setting
    const directionRevealDefault = DirectionReveal({
      selector: '.direction-reveal',
      itemSelector: '.direction-reveal__card',
      animationName: 'swing',
      animationPostfixEnter: 'enter',
      animationPostfixLeave: 'leave',
      enableTouch: true,
      touchThreshold: 250


    Property Default Type Description
    selector '.direction-reveal' String Container element selector.
    itemSelector '.direction-reveal__card' String Item element selector.
    animationName 'swing' String Animation class.
    animationPostfixEnter 'enter' String Animation CSS class postfix for enter event.
    animationPostfixLeave 'leave' String Animation CSS class postfix for leave event.
    enableTouch true Boolean Adds touch event to show content on first click then follow link on the second click.
    touchThreshold 250 Number(ms) The touch length in ms to trigger the reveal, this is to prevent triggering if user is scrolling.

    Import SASS

    @import "node_modules/direction-reveal/src/styles/direction-reveal.scss";


    <div class="direction-reveal">
      <a href="#" class="direction-reveal__card">
        <img src="images/image.jpg" alt="Image" class="img-fluid">
        <div class="direction-reveal__overlay direction-reveal__anim--enter">
          <h3 class="direction-reveal__title">Title</h3>
          <p class="direction-reveal__text">Description text.</p>

    Using other tags

    The demos use <a> tags for the "direction-reveal__card" but a <div> can be used as below, specifying the tabindex ensures keyboard navigation works as expected. They can all have a value of 0 and will follow the source order of the divs.

    <div class="direction-reveal__card" tabindex="0">

    Inverted animations

    Most of the animations above can be inverted so the overlay is visible by default and animates out on hover. Change the class 'direction-reveal__anim--enter' to 'direction-reveal__anim--leave' for this effect.

    You can also add the class 'direction-reveal__anim--enter' or 'direction-reveal__anim--leave' to the image to animate it at the same time as overlay. This effect can be seen in the Slide & Push demo.


    A 'directionChange' event is broadcast once a user enters/leaves an item with information about the action(enter,leave) and direction(top, right, bottom, left).

    document.querySelector('#test').addEventListener('directionChange', (event) => { 
      console.log(`Action: ${event.detail.action} Direction: ${event.detail.direction}`);


    Touch support

    The plugin will detect touch support and reveal the hidden content on first click then follow link on the second click. This can be disabled with the option enableTouch.

    Browser support

    Supports all modern browsers(Firefox, Chrome and Edge) released as of January 2018. For older browsers you may need to include polyfills for Nodelist.forEach, Element.classList and Passive Event Listeners.

    Demo site

    Clone or download from Github.

    $ npm install
    $ gulp serve


    Inspired by a Codepen by Noel Delgado, this Stack overflow answer, the article Get an Element's position using javascript and Images from Unsplash..


    MIT © Nigel O Toole


    npm i direction-reveal

    DownloadsWeekly Downloads






    Unpacked Size

    571 kB

    Total Files


    Last publish


    • nigelotoole