@wikimedia/leaflet-sleep
v0.5.1
Published
Leaflet plugin preventing unwanted scroll capturing
Downloads
39
Maintainers
Keywords
Readme
Leaflet.Sleep
This is a fork of CliffCloud/Leaflet.Sleep. It is a lighter version of the plugin, optimized for Mediawiki use case.
Leaflet's stock maps are event-greedy and interfere with scrolling.
Leaflet.Sleep
is an interaction manager, helping your
map do what you want when you want.
Demo
Use
Available on npm, bower, and straight from the single. source file
Leaflet.Sleep
is enabled by default, and can be disabled with the map's sleep
option.
npm
bower
bower install leaflet-sleep
Config
These are the new options available for L.map
and their defaults.
{
// false if you want an unruly map
sleep: true,
// time(ms) until map sleeps on mouseout
sleepTime: 750,
// time(ms) until map wakes on mouseover
wakeTime: 750,
// should the user receive wake instructions?
sleepNote: true,
// should hovering wake the map? (non-touch devices only)
hoverToWake: true,
// a message to inform users about waking the map
wakeMessage: 'Click or Hover to Wake',
// a constructor for a control button
sleepButton: L.Control.sleepMapControl,
// opacity for the sleeping map
sleepOpacity: .7
}