Skip to content
This repository has been archived by the owner on Aug 5, 2020. It is now read-only.
/ lockup Public archive

A mobile first scroll blocking plugin.

License

Notifications You must be signed in to change notification settings

mobify/lockup

Repository files navigation

Mobify Lockup

A mobile first scroll blocking plugin

Bower version Dependency Status Circle CI

Dependencies

Installation

Lockup can be installed using bower:

bower install lockup

Usage with Require.js

We highly recommend using Require.js with Lockup. To use Require, you have to reference Lockup and Lockup's dependencies inside your require config file:

{
    'paths': {
    	'plugin': 'bower_components/plugin/dist/plugin.min',
        'lockup': 'bower_components/lockup/dist/lockup.min',
        'deckard': 'bower_components/deckard/dist/deckard.min'
    }
}

And then require Lockup in as needed:

define([
    'zepto',
    'lockup'
    ],
    function($) {
        $('.someElement').lockup();
    }
);