/Leaflet.fullscreen

A fullscreen control for Leaflet

Primary LanguageJavaScriptBSD 2-Clause "Simplified" LicenseBSD-2-Clause

Leaflet.fullscreen

A HTML5 fullscreen plugin for Leaflet.

Usage

var map = new L.Map('map', {
    fullscreenControl: true
});

API

map.isFullscreen() // Is the map fullscreen?
map.toggleFullscreen() // Either go fullscreen, or cancel the existing fullscreen.

// `fullscreenchange` Event that's fired when entering or exiting fullscreen.
map.on('fullscreenchange', function () {
    if (map.isFullscreen()) {
        console.log('entered fullscreen');
    } else {
        console.log('exited fullscreen');
    }
});

L.Control.Fullscreen // A fullscreen button. Or use the `{fullscreenControl: true}` option when creating L.Map.

Including via CDN

Leaflet.fullscreen is available through the Mapbox Plugin CDN - just copy this include:

<script src='//api.tiles.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v0.0.2/Leaflet.fullscreen.min.js'></script>
<link href='//api.tiles.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v0.0.2/leaflet.fullscreen.css' rel='stylesheet' />

Building

npm install && make

ProTip You may want to install watch so you can run watch make without needing to execute make on every change.