Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

leaflet-fullscreen

Leaflet88kISC1.0.2TypeScript support: definitely-typed

A fullscreen control for Leaflet

leaflet, maps, fullscreen, client

readme

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.

changelog

1.0.2

  • Invalidate map size on fullscreen toggle (#61)

1.0.1

  • Fix package.json main
  • Switch license to ISC

1.0.0

  • pseudoFullscreen option
  • Fix project structure and CSS

0.0.4

  • Fix for multiple maps on one page
  • Fix cancel full screen mode in Firefox (#29)
  • Center icon on touch devices (#31)
  • Fix IE8 support (#32)

0.0.3

  • Added IE11 native fullscreen support (#27)

0.0.2

  • Set appropriate title when fullscreen (#17)
  • Replace on('load') with whenReady (#19)

0.0.1

  • Project restructuring
  • New icons, including retina icons

0.0.0

  • Initial release