leaflet-fullscreen
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/leaflet-fullscreen package

1.0.2 • Public • Published

Leaflet.fullscreen

A HTML5 fullscreen plugin for Leaflet.

Usage

var map = new L.Map('map', {
    fullscreenControl: true,
    // OR
    fullscreenControl: {
        pseudoFullscreen: false // if true, fullscreen to page width and height
    }
});

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='https://api.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v1.0.1/Leaflet.fullscreen.min.js'></script>
<link href='https://api.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v1.0.1/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.

Dependencies (0)

    Dev Dependencies (2)

    Package Sidebar

    Install

    npm i leaflet-fullscreen

    Weekly Downloads

    16,002

    Version

    1.0.2

    License

    ISC

    Last publish

    Collaborators

    • mapbox-admin
    • tmcw
    • jfirebaugh
    • willwhite
    • yhahn
    • tristen
    • mourner
    • ansis