Retrieve all Leaflet Default Icon options from CSS, in particular all icon images URL's, to improve compatibility with bundlers and frameworks that modify URL's in CSS. Demo with webpack (and without this plugin).
Size: < 2kB minified
Note: here, "compatibility" does not refer to browser compatibility, but with build engines and frameworks that modify URL's in CSS, which often conflicts with Leaflet built-in Default Icon images automatic management. See issue Leaflet/Leaflet#4698 for more details.
$ npm install leaflet-defaulticon-compatibility --save
Load this plugin CSS and JS files after Leaflet CSS and JS. Then the Leaflet default icon should automatically work again, even if your build engine or framework modifies the URL's in CSS, typically:
- webpack with style-loader + css-loader + file-loader or url-loader
- Rails with Asset Pipeline
- Django with pipeline
For example for webpack with style-loader + css-loader + file-loader:
import 'leaflet/dist/leaflet.css'; import 'leaflet-defaulticon-compatibility/dist/leaflet-defaulticon-compatibility.webpack.css'; // Re-uses images from ~leaflet package import * as L from 'leaflet'; import 'leaflet-defaulticon-compatibility';
This plugin provides 2 similar CSS files:
leaflet-defaulticon-compatibility.css: use it by default.
leaflet-defaulticon-compatibility.webpack.css: alternative for webpack / bundlers that understand the
~leafletsyntax to navigate to other packages in
node_modules. This avoids duplicating the
leaflet.css, hence saving some bytes, especially when the images is inlined as DataURI/base64 (even though with gzip compression this should not be an issue).
Warning: Data URI (base64) images performance
Some bundlers automatically replace
url(path) in CSS by Data URI (aka base64-encoded) image (i.e.
url(data:image/png;base64,SOME_DATA)). That is typically the case of webpack url-loader and Django pipeline.
If your map displays hundreds of Markers using this inlined image as icon, be aware that it will affect the browser performance much more quickly than using a normal URL file.
Fix: Firefox high contrast (colours override) option
This plugin also fixes an edge case in Firefox when a user has configured their browser to always override the websites colours.
When that option is set to "Always" in Firefox preferences, all background images are removed. Therefore Leaflet can no longer detect the default icon images path that was clued through CSS
In that case, this plugin will try to use the
cursor rule instead which is not affected by Firefox colours override option. Therefore the plugin CSS duplicates the images path in both
However, if you use this plugin to specify your own icon in CSS, make sure to still use
background-image rule as the first mean to pass your images path, because Internet Explorer always interpretes URL's in
cursor rule as absolute.
leaflet-defaulticon-compatibility is distributed under the BSD 2-clause "Simplified" License, like Leaflet.