README.md

Leaflet.fullscreen

A HTML5 fullscreen plugin for Leaflet.

Fork

Reason for the @runette fork: The root repo is not being actively managed. This fork starts with version 1.0.3.

Changes

• Rework Legacy PNG Icons with Font Awesome SVG (#118)
• Remove onFullscreenchange and replace with enterFullscreen event in README (#108)
• included index.d.ts (#106)
• changed the icon to SVG (#102 and #103)
• remove fullscreen listener (#100)
• Accessibility Fix (#2)
• Fix Typo in index.d.ts (#3)

Usage

To provide a button for toggling fullscreen on and off:

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

// or add to an existing map
map.addControl(new L.Control.Fullscreen());

The plugin also adds several methods to L.Map which are always available, even if you choose not to use the fullscreen button:

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

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

Localization

To change fullscreen control text:

map.addControl(new L.Control.Fullscreen({
    title: {
        'false': 'View fullscreen',
        'true': 'Exit fullscreen'
    }
}));

Including via NPM

npm install @runette/leaflet-fullscreen

Type definitions

This version includes a index.d.ts with Typescript type definitions for :

interface FullscreenOptions extends ControlOptions {}

and extensions to the following with the additional properties and methods

    interface Map {}

    namespace control  {}

    namespace Control {}

npm install
npm run test
npm run uglifyjs
npm run sass

Supported Leaflet Versions

Leaflet 1.0 and later is supported. Earlier versions may work, but are not tested.

License

ISC

SVG icons from Font Awesome v5.15.4: Creative Commons Attribution 4.0