https://github.com/jasonmit/landmark.js
Sticks headers as user scrolls
https://github.com/jasonmit/landmark.js
Last synced: 2 months ago
JSON representation
Sticks headers as user scrolls
- Host: GitHub
- URL: https://github.com/jasonmit/landmark.js
- Owner: jasonmit
- Created: 2013-05-02T18:08:01.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-08-03T21:42:22.000Z (almost 11 years ago)
- Last Synced: 2025-02-10T04:44:12.965Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 172 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Landmark.js
Landmark.js is a simple, light-weight, jquery plugin that allows you to display, what I call, "landmarks" as the user passes them while scrolling.
It's useful for notifying the user of the context of what they're reading if your page covers multiple topics. This allows for the user to rapidly scroll through your document to get to what they interested in.
## Demo
http://codepen.io/anon/pen/lHGId?editors=100
## Usage
$(document).ready(function() {
$('.landmark').landmark(
{ id: 'landmark-id' } /* this options object is optional */
);
});
This is optional, if you do not specify where landmark.js should display the landmarks one will be created for you.
Anchor 1
Included is example.html which should help you can get a better feeling for how this plugin is used.