https://github.com/Leaflet/Leaflet.fullscreen
A fullscreen control for Leaflet
https://github.com/Leaflet/Leaflet.fullscreen
Last synced: about 1 year ago
JSON representation
A fullscreen control for Leaflet
- Host: GitHub
- URL: https://github.com/Leaflet/Leaflet.fullscreen
- Owner: Leaflet
- License: isc
- Created: 2013-02-21T23:24:42.000Z (over 13 years ago)
- Default Branch: gh-pages
- Last Pushed: 2022-05-13T14:07:33.000Z (about 4 years ago)
- Last Synced: 2024-10-20T07:50:56.539Z (almost 2 years ago)
- Language: HTML
- Homepage: http://leaflet.github.io/Leaflet.fullscreen/
- Size: 159 KB
- Stars: 436
- Watchers: 33
- Forks: 117
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-maps-examples - Leaflet.fullscreen - Fullscreen control (Plugins Reference / Leaflet)
README
## Leaflet.fullscreen
A HTML5 fullscreen plugin for Leaflet.
### Usage
To provide a button for toggling fullscreen on and off:
``` js
// Create a new map with a fullscreen button:
var 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:
``` js
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');
}
});
```
### Localization
To change fullscreen control text:
``` js
map.addControl(new L.Control.Fullscreen({
title: {
'false': 'View Fullscreen',
'true': 'Exit Fullscreen'
}
}));
```
### Including via CDN
Leaflet.fullscreen is [available through the Mapbox Plugin CDN](https://www.mapbox.com/mapbox.js/plugins/#leaflet-fullscreen) - just copy this include:
```html
```
### 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.
### Supported Leaflet Versions
Leaflet 1.0 and later is supported. Earlier versions may work, but are not tested.