v1.8.0

[mourner]

A huge release (the first one in 1.5 years), focused on bug fixes, major reliability and accessibility improvements, cleaning up legacy code, and numerous improvements to documentation, development workflow and release process. A culmination of hundreds of contributions, and a preparation for bigger changes to come. 🍃

From now on, releases will become much more frequent. Thanks to our amazing community for all your help and patience. ❤️🙏 This release is dedicated to Ukrainian fight for freedom and democracy against the Russian invasion 🇺🇦 (see how you can support Ukraine here).

Special thanks to @johnd0e who revived Leaflet development after long stagnation and made the biggest contributions, @Falke-Design for doing the bulk of the work organizing development and preparing the release, @Malvoz for his numerous accessibility contributions, and @jonkoops for help with workflow automations. ❤️

⚠️ Breaking Changes

• Improve reliability of contextmenu event simulation on mobile Safari by introducing a new TapHold handler, replacing legacy Tap (#7026 by @johnd0e)
• Reorganize DivOverlay/Popup/Tooltip APIs (#7540 by @johnd0e)
  • Move Popup related options from DivOverlay to Popup (#7778 by @Falke-Design)
  • Change Tooltip class from leaflet-clickable to leaflet-interactive (#7719 by @Falke-Design)
  • Map.closeTooltip now requires a layer as argument (#7533 by @johnd0e)
• Improve error / argument handling for event listeners (#7518 by @johnd0e)
• Improve reliability of touch events simulation on non-touch devices (DomEvent.Pointer) (#7059, #7084, #7415 by @johnd0e)
• Improve reliability of dblclick event simulation on touch devices (DomEvent.DoubleTap) (#7027 by @johnd0e)
• Improve reliability of disableClickPropagation (#7439 by @johnd0e)
• Improve Map hasLayer() and LayerGroup hasLayer() to require a layer as argument (#6999 by @johnd0e)
• Fix Class.include to not overwrite options (#7756 by @johnd0e)
• Fix Class.extend to not modify source props object (#6766 by @johnd0e)
• Improve Browser.touch touch devices detection (#7029 by @johnd0e)
• Get rid of legacy Android hacks (#7022 by @johnd0e)
• Allow fonts to respect users' browser settings by making the font-size relative to the map container. (You can change the font size on leaflet-container to adjust it if needed.) (#7800 by @Chandu-4444)

❇️ API changes

• Make DivOverlay / Tooltip interactive (#7531, #7532 by @johnd0e)
• Add openOn, close, toggle functions to DivOverlay (#6639 by @johnd0e)
• Introduce DomEvent.off(el) to remove all listeners (#7125 by @johnd0e)
• Allow preventing round-off errors by passing false to Util.formatNum / toGeoJSON (#7100 by @johnd0e)
• Add autoPanOnFocus to Marker (#8042 by @IvanSanchez)
• Add referrerPolicy to TileLayer (#7945 by @natevw)
• Add playsInline to VideoOverlay (#7928 by @Falke-Design)
• Add getCenter to ImageOverlay (#7848 by @Falke-Design)
• Fire a tileabort event when a TileLayer load is cancelled (#6786 by @dstndstn)
• Add crossOrigin to Icon (#7298 by @syedmuhammadabid)

✨ Improvements

• Improve memory footprint by removing will-change CSS property on tile images (#7872 by @janjaap)
• Improve reliability of icons path detection heuristics (#7092 by @johnd0e)
• Improve performance of adding tiled sources by avoiding excessive updates in GridLayer.onAdd (#7570 by @johnd0e)
• Improve handling of edge cases in panInside (#7469 by @daverayment)
• Minify marker icon SVG (#7600 by @rala72)
• Allow template keys with spaces in TileLayer URL (#7216 by @lubojr)
• Improve behavior of Tooltip bound to ImageOverlay (#7306 by @IvanSanchez)
• Remove the gap between Popup tip and content dialog (#7920 by @Malvoz)
• Fire mousemove through Canvas to map if it has no layers (#7809 by @johnd0e)
• Add print styles to prevent printers from removing background-images in controls (#7851 by @Malvoz)
• Move attribution code from Layer to Control.Attribution (#7764 by @johnd0e)
• Refactor vmlCreate() so that it does not expose closure to TypeError (#7279 by @darcyparker)
• Improve reliability of Control.Layers by not relying on Browser android and touch properties (#7057 by @johnd0e)
• Improve reliability of Tooltip by not relying on Browser touch checks (#7535 by @johnd0e)
• Make Browser mutable for easier automated testing (#7335 by @bozdoz)
• Replace div with span in Control.Layers container to fix an HTML validation error (#7914 by @tmiaa)
• Add a Ukrainian flag to default attribution 🇺🇦 (by @mourner in Add a Ukrainian flag to default attribution 🇺🇦  #8109)

🙌 Accessibility

• Increase default font sizes and decrease attribution transparency for improved legibility (#8057, by @mourner)
• Improve accessibility of popup close button (#7908, by @Malvoz)
• Auto pan to markers on focus by default for improved keyboard operability (#8042 by @IvanSanchez)
• Add accessibility section to plugins guide (#7277 by @Malvoz)
• Update Marker to default to role="button" & alt="marker" for an improved screen reader experience (#7895 by @tmiaa)
• Set role="button" for appropriate semantics on the <a> layers control (#7850 by @Malvoz)
• Generally enable outlines for keyboard users by not stripping outline on focus for keyboard events (#7259 by @jafin)
• Enable outlines on leaflet-container for keyboard users (#7996 by @Malvoz)
• Multiple enhancements to popup's close button (#7794 by @Falke-Design)
• Use relative font-size units for resizable text (#7800 by @Chandu-4444)
• Apply :hover styles to :focus as well (#7274 by @Malvoz)
• Hide the decorative attribution separator from screen readers (#7969 by @Malvoz)
• Make the disabled state of zoom controls available to screen readers (#7280 by @akshataj96)
• Hide the +/- characters in zoom controls from screen readers to prevent erroneous announcements (#7795 by @Falke-Design)

🐞 Bug fixes

• Fix vector drift when dragging and immediately zooming (by @manubb @johnd0e @mourner in Fix vector drift when dragging and immediately zooming #8103)
• Reduce the occurrence of glitches on rapid zoom (by @mourner in Remove an old iOS hack to fix glitches on rapid zoom #8102)
• Fix Marker jumping position while zooming in certain cases (#7967 by @Falke-Design)
• Fix opening / closing Tooltip while dragging the map (#7862 by @Falke-Design)
• Break the reference to the options of the Class prototype (#7459 by @Falke-Design)
• Improve Tooltip options permanent & sticky to work together (#7563 by @Falke-Design)
• Check if map container is still connected with Leaflet in locate event listener (#7813 by @Falke-Design)
• Fix Tooltip bindTooltip to unbind existent tooltip (#7633 by @Falke-Design)
• Correct if condition, to add zoom limits for Layer (#7609 by @vcoppe)
• GridLayer redraw tiles after changing maxNativeZoom (#6443 by @cherniavskii)
• Fix Popup keepInView if the map needs to panned over a long distance (#7792 by @Falke-Design)
• Tolerate wrong event names in add/removePointerListener (#7808 by @johnd0e)
• Reset width & padding to prevent cascading CSS from breaking tile rendering (#6843 by @Spudley)
• Fix mousedown event calling after dragging Canvas map (#7781 by @johnd0e)
• Decrease console.warn pollution (#7748 by @johnd0e)
• Fix contextmenu event default-preventing when there are >1 target candidates (#7544 by @johnd0e)
• Prevent click on Popup-tip from firing on map. (#7541 by @johnd0e)
• Fix error by calling Path.setStyle before adding the layer to the map (#6941 by @NielsHolt)
• Reset BoxZoom after cancel with ESC (#7597 by @Falke-Design)
• Fix noConflict (#7855 by @Falke-Design)
• Fix popup appearance when content is empty (#8136, by @ansh-ag)
• Fix latLngToCoords and latLngsToCoords not accepting array form of lat/lngs (#7436, by @Relkfaw)

📝 Docs

• Add a new Leaflet accessibility tutorial (#8081, by @Malvoz)
• Upgrade Code of Conduct to Contributor Covenant v2 and improve its visibility (#7984 by @mourner)
• Lint examples (#7827 by @mourner)
• Update usability in Docs (#7982, #7703, #7950, #7906, #7907, #7696, #7816, #7345, #7815, #7948, #7901 by @Falke-Design, @avioli, @Malvoz, @fulldecent, @saerdnaer, @MxDui)
• Typos / Fixes in Docs, Samples, ... (#7263, #7284, #7339, #7349, #7381, #7371, #7485, #7380, #7578, #7758, #7602, #7857, #7860, #7336, #7819 by @timgates42, @IvanSanchez, @ipovos, @elfalem, @BakuCity, @simon04, @user073, @Dev-Steven, @vanillajonathan, @aquelle-cp, @matkoniecz, @Falke-Design)
• Clarify zoomend event (#7460 by @xeruf)
• Add false to prefix of Control.Attribution (#7814 by @Falke-Design)
• LayerGroup inherit from Interactive Layer (#7763 by @johnd0e)
• Improve Map.panInside documentation (#7397 by @daverayment)
• Update Renderer documentation to clarify tolerance option is for Canvas only (#7515 by @Hippl-Eric)
• Add documentation for Event-Listener propagate argument (#7103 by @riffaud)
• Fix an issue with top padding on non-API pages (#8083, by @wyankush)

🔧 Workflow

• Split plugins.md into many files for easier maintenance (#7805 by @Falke-Design)
• Add Bundlemon to watch bundle size (#7934, #7983, #7905 by @jonkoops)
• Add npm run serve to serve docs on localhost (#7973 by @Falke-Design)
• Rename master branch to main (#7921 by @jonkoops)
• Upload files to AWS even if the file-size is the same (#7853 by @jonkoops)
• Remove leaflet-include.js from debug samples (#7776 by @Falke-Design)
• Lint adjustments (#7676, #7743, #7757 by @jonkoops, @mourner)
• Simplify release process (#7711, #7854, #7727, #8039 by @mourner)
• Simplify docs update process on release (#7730 by @mourner)
• Update dependencies and add Dependabot config (#7455, #7653, #7677, #7725 by @jonkoops)
• Split main workflow into multiple parallel jobs (#7710 by @jonkoops)
• Run CI on Github actions (#7691, #7654, #7702 by @jonkoops)
• Continue running tests even if one fails (#7723 by @jonkoops)
• Add blocker Critical issue or PR that must be resolved before the next release check to release process (#8019 by @Malvoz)
• Remove all references of Bower (#7831 by @jonkoops)
• Add GitHub Actions dependency tracking with Dependabot (by @nathannaveen in Included githubactions in the dependabot config #8104)

🧪 Tests

• Improve unit tests organization (#7852, by @Falke-Design)
• Run tests on Internet Explorer 11 (#7741 by @jonkoops)
• Run tests on FirefoxNoTouch (#7736, #7742 by @johnd0e)
• Drop PhantomJS from test suite (#7660, #7724 by @jonkoops)
• Simplify .near and .nearLatLng usage (#7820 by @johnd0e)
• Enforce forbid-only rule in the continuous integration (#7448 by @johnd0e)
• Increase captureTimeout and browserSocketTimeout (#7856 by @Falke-Design)
• Added / update tests (#7790, #7147, #7721, #7461, #7126, #7451, #7450, #7447, #7438 by @Falke-Design, @johnd0e, @phloose)
• Added missing Test-Spec-Files to index.html (#7845 by @Falke-Design)
• Cover DomEvent with unit tests (by @stephenspol in Cover DomEvent with unit tests #8088)
• Cover DomUtil with unit tests (#7547, by @LGNorris)

🔩 Plugins

• Add / update demo URLs for all plugins, fix broken links (#8003, huge work by @valerio-bozzolan).
• Add / update plugins (#7986, #7956, #7942, #7888, #7896, #7885, #7875, #7874, #7833, #7834, #7832, #7812, #7786, #7802, #6534, #6547, #7367, #7392, #7412, #7631, #7437, #7408, #6500, #7957, #7484, #7236, #7053, #7050, #7312, #7623, #7534, #7626, #7553, #7423, #7619, #7065, #7663, #7690, #7180, #7714, #7665, #7179, #6641, #7647, #7635, #7473, #7471, #7363, #7323, #7295, #7292, #7291, #7257, #7276, #7470, #7700, #7617), #8097, #8096, #8049

---

This discussion was created from the release v1.8.0.

[nessor]

First of all, many many thanks for all the work and effort!

However, I have a small question regarding the version number. We have set up the projects so that renovate automatically updates package with patch and minor changes. Major changes are not automatically updated or merged due to possible breaking changes. Of course we have tested everything. But there is always the chance that something has not been tested and will not work anymore due to a major update. Maybe I'm completely wrong here, too. However, I learned in college that patch versions are for small fixes, minor for new features, and major versions for breaking changes. With this in mind, shouldn't the new version number of Leaflet be v2.0.0?

Please do not take this as criticism! Rather as an idea for a next release / a friendly inquiry :).

[mourner]

Most people should have no problem upgrading straight away — all the breaking changes in v1.8 are subtle and small. I believe major versions should only come with major changes. I'm not a fan of strict semver and think it usually doesn't work as advertised. Besides, NPM default semver range when installing packages is patch version only (after v1) — minor versions won't be automatically upgraded, and it's a bad practice to do so anyway.

[NielsHolt]

Hi

Thank you for a great job :-)

In v. 1.7.1 the /dist also contained src-files (leaflet-src.esm.js, leaflet-src.js, leaflet.js etc)
Would it be possible to have that in v 1.8.0 as well?

[Falke-Design]

Hi Robert

All versions since 0.7 contains src-files in /dist contained, so ”GitHub Releases in general only provide the source code in downloads. I'm not sure whether we should change that. Leaflet distribution is officially available through NPM and download links on the website.” Is not correct.

The change is that v 1.8.0 is the first release without src-files in /dist

Kind regards
Niels Holt

Originally posted by @NielsHolt in #8149 (comment)

@mourner please comment

[Falke-Design]

Let us discuss here: #8169

[mourner]

@jonkoops what do you think, is it easy to upload the distribution files for GitHub Releases through GitHub Actions?

[mourner]

The change is that v 1.8.0 is the first release without src-files in /dist

The fact we did this before doesn't mean we should continue doing so. It was a mistake (at least including distribution files in the "source code" auto-generated packages).

[Falke-Design]

Duplicate #8171

[mourner]

@Falke-Design there were some important fixes landing recently, e.g. the last one fixing some broken plugins — should we release v1.8.1 of the current Leaflet state?

[Falke-Design]

I would like to release a 1.9 we don't need to release all of the 1.9 milestone but there are many which are nearly done or need a decision. Would be nice if you could look over all of them once.

With the help of the team @Malvoz @IvanSanchez @jonkoops @mourner @Falke-Design i think we can make a release in 2 weeks with out much effort. We only need to communicate.

[jonkoops]

What are the essential issues? Anything we can take out of 1.9?