A useful control to geolocate the user with many options.
Tested with Leaflet 0.7 in Firefox, Webkit and mobile Webkit. Tested with Font Awesome 4.3.0.
v0.34.0 introduced breaking changes to the API. Please check your code!
Check out the demo at http://domoritz.github.io/leaflet-locatecontrol/demo/
tl;dr
- Get CSS and JavaScript files
- Include CSS and JavaScript files
- Initialize plugin
For testing purposes and development, you can use the latest version directly from my repository using rawgithub. However, don't do this in production environments!
For production environments, use Bower and run bower install leaflet.locatecontrol or download the files from this repository. Bower will always download the latest version and keep the code up to date. The original JS and CSS files are in \src and the minified versions suitable for production are in \dist.
You can also get the latest version of the plugin with npm. This plugin is available in the npm repository. Just run npm install leaflet.locatecontrol.
If you don't need the latest version, you can use the mapbox CDN.
The control uses Font Awesome for the icons and if you don't have it included yet, you can use the CSS from the CDN.
Then include the CSS and JavaScript files.
This example shows how to include font awesome from a CDN and the locate control files through rawgit. Only use rawgit for testing and never in production! Always prefer using the bower (or Mapbox CDN).
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<link rel="stylesheet" href="//rawgithub.com/domoritz/leaflet-locatecontrol/gh-pages/dist/L.Control.Locate.min.css" />
<!--[if lt IE 9]>
<link rel="stylesheet" href="//rawgithub.com/domoritz/leaflet-locatecontrol/gh-pages/dist/L.Control.Locate.ie.min.css"/>
<![endif]-->
<script src="//rawgithub.com/domoritz/leaflet-locatecontrol/gh-pages/dist/L.Control.Locate.min.js" ></script>This snippet adds the control to the map. You can pass also pass a configuration.
L.control.locate().addTo(map);The locate controls inherits options from Leaflet Controls.
L.control.locate({
position: 'topleft', // set the location of the control
drawCircle: true, // controls whether a circle is drawn that shows the uncertainty about the location
follow: false, // follow the user's location
setView: true, // automatically sets the map view to the user's location, enabled if `follow` is true
keepCurrentZoomLevel: false, // keep the current map zoom level when displaying the user's location. (if `false`, use maxZoom)
stopFollowingOnDrag: false, // stop following when the map is dragged if `follow` is true (deprecated, see below)
remainActive: false, // if true locate control remains active on click even if the user's location is in view.
markerClass: L.circleMarker, // L.circleMarker or L.marker
circleStyle: {}, // change the style of the circle around the user's location
markerStyle: {},
followCircleStyle: {}, // set difference for the style of the circle around the user's location while following
followMarkerStyle: {},
icon: 'fa fa-map-marker', // class for icon, fa-location-arrow or fa-map-marker
iconLoading: 'fa fa-spinner fa-spin', // class for loading icon
circlePadding: [0, 0], // padding around accuracy circle, value is passed to setBounds
metric: true, // use metric or imperial units
onLocationError: function(err) {alert(err.message)}, // define an error callback function
onLocationOutsideMapBounds: function(context) { // called when outside map boundaries
alert(context.options.strings.outsideMapBoundsMsg);
},
showPopup: true, // display a popup when the user click on the inner marker
strings: {
title: "Show me where I am", // title of the locate control
metersUnit: "meters", // string for metric units
feetUnit: "feet", // string for imperial units
popup: "You are within {distance} {unit} from this point", // text to appear if user clicks on circle
outsideMapBoundsMsg: "You seem located outside the boundaries of the map" // default message for onLocationOutsideMapBounds
},
locateOptions: {} // define location options e.g enableHighAccuracy: true or maxZoom: 10
}).addTo(map);You can call start() or stop() on the locate control object to set the location of page load for example.
// create control and add to map
var lc = L.control.locate().addTo(map);
// request location update and set location
lc.start();You can also use the helper functions to automatically stop following when the map is panned. See the example below.
var lc = L.control.locate().addTo(map);
map.on('dragstart', lc._stopFollowing, lc);Alternatively, you can unload events when not following to avoid unnecessary events.
map.on('startfollowing', function() {
map.on('dragstart', lc._stopFollowing, lc);
}).on('stopfollowing', function() {
map.off('dragstart', lc._stopFollowing, lc);
});The locate control fires startfollowing and stopfollowing on the map object and passes self as data.
To customize the behavior of the plugin, use L.extend to override start, stop, drawMarker and/or removeMarker. Please be aware that functions may change and customizations become incompatible.
L.Control.MyLocate = L.Control.Locate.extend({
drawMarker: function() {
// override to customize the marker
}
});
var lc = new L.Control.MyLocate();Set the maxZoom in locateOptions (keepCurrentZoomLevel must not be set to true).
map.addControl(L.control.locate({
locateOptions: {
maxZoom: 10
}}));
Sites that use this locate control:
Run the demo locally with grunt serve and then open localhost:9000/demo/index.html.
To generate the minified JS and CSS files, use grunt and run grunt. However, don't include new minified files or a new version as part of a pull request.
A new version is released with grunt bump:minor. Then recompile the JS/CSS with grunt and commit the changes into the previous commit with git commit -a --amend. Then push the new code with git push and git push --tags and publish to npm with npm publish.
To all contributors and issue reporters.
MIT