react-leaflet-deflate 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -1,35 +1,44 @@
-react-leaflet-deflate Changelog
-=========================
-
-
-## 3.1.0 (2025-12-05)
-
-* Add gh-pages docs
-* Update dependencies
-
-
-## 3.0.1 (2025-11-28)
-
-* NPM Audit Fix
-
-## 3.0.0 (2025-11-07)
-
-* Update Leaflet.Deflate dependency to 2.1.0.
-* Update Leaflet dependency to 1.9.4
-* Update react-leaflet dependency to 5.0.0
-* Update react dependency to 19.2.0
-
-## 2.2.1 (2019-02-11)
-
-* Update Leaflet.Deflate dependency to 1.1.0 ([PR #5](https://github.com/mhasbie/react-leaflet-deflate/pull/5) by _oliverroick_).
-* Remove unused dependencies
-
-
-## 2.2.0 (2019-01-20)
-
-* Make compatible with `react-leaflet@2.x`
-* Update dependencies
-* Update README
-* Add example
-* Add unit test
-* Bugs fixes
+react-leaflet-deflate Changelog
+=========================
+
+## 3.1.3 (2026-11-14)
+
+* Fix UMD build runtime error when `markerCluster` is enabled: use Leaflet's `DomUtil.addClass` instead of the mis-externalized `@react-leaflet/core` helper.
+* Remove unused dependencies.
+* Add `react` to `peerDependencies`.
+* Align `jest-environment-jsdom` with Jest 29.
+
+## 3.1.2 (2026-01-11)
+
+* NPM Audit Fix
+
+## 3.1.0 (2025-12-05)
+
+* Add gh-pages docs
+* Update dependencies
+
+## 3.0.1 (2025-11-28)
+
+* NPM Audit Fix
+
+## 3.0.0 (2025-11-07)
+
+* Update Leaflet.Deflate dependency to 2.1.0.
+* Update Leaflet dependency to 1.9.4
+* Update react-leaflet dependency to 5.0.0
+* Update react dependency to 19.2.0
+
+## 2.2.1 (2019-02-11)
+
+* Update Leaflet.Deflate dependency to 1.1.0 ([PR #5](https://github.com/mhasbie/react-leaflet-deflate/pull/5) by _oliverroick_).
+* Remove unused dependencies
+
+
+## 2.2.0 (2019-01-20)
+
+* Make compatible with `react-leaflet@2.x`
+* Update dependencies
+* Update README
+* Add example
+* Add unit test
+* Bugs fixes

package/LICENSE

@@ -1,19 +1,19 @@
-The MIT License (MIT)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,89 +1,116 @@
-# react-leaflet-deflate
-
-
-[![version](https://img.shields.io/npm/v/react-leaflet-deflate.svg?style=plastic)](http://npm.im/react-leaflet-deflate)
-[![react-leaflet compatibility](https://img.shields.io/npm/dependency-version/react-leaflet-deflate/peer/react-leaflet.svg?style=plastic)](https://github.com/mhasbie/react-leaflet-deflate)
-[![issues](https://img.shields.io/github/issues/mhasbie/react-leaflet-deflate.svg?style=plastic)](https://github.com/mhasbie/react-leaflet-deflate/issues)
-[![downloads](https://img.shields.io/npm/dt/react-leaflet-deflate.svg?style=plastic)](http://npm-stat.com/charts.html?package=react-leaflet-deflate&from=2018-01-01)
-[![MIT License](https://img.shields.io/npm/l/react-leaflet-deflate.svg?style=plastic)](http://opensource.org/licenses/MIT)
-
-React wrapper of [Leaflet.Deflate](
-https://github.com/oliverroick/Leaflet.Deflate)
-for [react-leaflet](https://github.com/PaulLeCam/react-leaflet).
-
-Substitutes polygons and lines with markers when their screen size falls below a defined threshold.
-
-*Tested with React 19.2.0, Leaflet 1.9.4, React-Leaflet 5.0.0, React-Leaflet 4.0.0, Leaflet.Deflate 2.1.0*
-
-![Example](https://cloud.githubusercontent.com/assets/159510/7164588/090c06fe-e399-11e4-956d-0283ef7e69cf.gif)
-
-## Demos
-
-| Version				| Demo	|
-| ---					| ---	|
-| `react-leaflet@1.9.1`	| [`CodePen`](https://codepen.io/m_hasbie/full/jvgeVR/) |
-| `react-leaflet@2.x`	| [`CodePen`](https://codepen.io/m_hasbie/full/MqNPRy/) |
-| `react-leaflet@5.x`	| [`CodePen`](https://codepen.io/m_hasbie/full/wBGampr) |
-
-
-## Installation
-
-### Install via NPM
-
-```bash
-npm install --save react-leaflet-deflate
-```
-
-`react-leaflet-deflate` requires `leaflet.markercluster` as [`peerDependency`](https://docs.npmjs.com/files/package.json#peerdependencies)
-
-(React, Leaflet, react-leaflet also should be installed)
-```bash
-npm install --save leaflet.markercluster
-```
-
-## Usage example
-
-### react-leaflet v5
-
-```javascript
-import { MapContainer, TileLayer } from 'react-leaflet';
-import Deflate from 'react-leaflet-deflate';
-
-const geojson = {...};
-
-<MapContainer center={[2.935403, 101.448205]} zoom={10}>
-  <TileLayer
-    url="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
-    attribution='&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
-  />
-
-  <Deflate
-    data={geojson}
-    minSize={10}
-    markerCluster={true}
-  />
-</MapContainer>
-```
-
-### Options
-
-Option          | Type      | Default | Description
---------------- | --------- | ------- | -------------
-`data`          | `object`     | `{}`    | Required. A valid [GeoJSON object](http://geojson.org/geojson-spec.html).
-`minSize`       | `int`     | `20`    | Defines the minimum width and height in pixels for a path to be displayed in its actual shape.
-`markerOptions` | `object` or `function`  | `{}`    | Optional. Customize the markers of deflated features using [Leaflet marker options](http://leafletjs.com/reference-1.3.0.html#marker).
-`markerCluster` | `boolean` | `false` | Indicates whether markers should be clustered. Requires `Leaflet.markercluster`.
-`markerClusterOptions` | `object` | `{}`    | Optional. Customize the appearance and behaviour of clustered markers using [`Leaflet.markercluster` options](https://github.com/Leaflet/Leaflet.markercluster#options).
-`pointToLayer`  | `function`  | `{}`    | [Leaflet geojson pointToLayer options](http://leafletjs.com/reference-1.3.0.html#geojson-pointtolayer).
-`style`         | `function`  | `{}`    | Style to apply to polygons or lines. [Leaflet geojson style options](https://leafletjs.com/reference.html#geojson-style).
-`onEachFeature` | `function`  | `{}`    | Function to execute on each geojson feature. [Leaflet geojson onEachFeature options](https://leafletjs.com/reference.html#geojson-oneachfeature).
-`filter`        | `function`  | `{}`    | Filter function to apply to geojson features. [Leaflet geojson filter options](https://leafletjs.com/reference.html#geojson-filter).
-
-
-# Credits
-  - [oliverroick](https://github.com/oliverroick) and the other [contributors](https://github.com/oliverroick/Leaflet.Deflate/graphs/contributors) to for the original work on `Leaflet.Deflate`.
-  - [clintharris](https://github.com/clintharris) for updating `react-leaflet-deflate` to reference `Leaflet.Deflate` as an external dependency, support property changes, and work with `react-leaflet` v2.
-
-# License
-
-MIT License
+# react-leaflet-deflate
+
+
+[![version](https://img.shields.io/npm/v/react-leaflet-deflate.svg?style=plastic)](http://npm.im/react-leaflet-deflate)
+[![react-leaflet compatibility](https://img.shields.io/npm/dependency-version/react-leaflet-deflate/peer/react-leaflet.svg?style=plastic)](https://github.com/mhasbie/react-leaflet-deflate)
+[![issues](https://img.shields.io/github/issues/mhasbie/react-leaflet-deflate.svg?style=plastic)](https://github.com/mhasbie/react-leaflet-deflate/issues)
+[![downloads](https://img.shields.io/npm/dt/react-leaflet-deflate.svg?style=plastic)](http://npm-stat.com/charts.html?package=react-leaflet-deflate&from=2018-01-01)
+[![MIT License](https://img.shields.io/npm/l/react-leaflet-deflate.svg?style=plastic)](http://opensource.org/licenses/MIT)
+
+React wrapper of [Leaflet.Deflate](
+https://github.com/oliverroick/Leaflet.Deflate)
+for [react-leaflet](https://github.com/PaulLeCam/react-leaflet).
+
+Substitutes polygons and lines with markers when their screen size falls below a defined threshold.
+
+*Tested with React 19.2.0, Leaflet 1.9.4, React-Leaflet 5.0.0, React-Leaflet 4.0.0, Leaflet.Deflate 2.1.0*
+
+![Example](https://cloud.githubusercontent.com/assets/159510/7164588/090c06fe-e399-11e4-956d-0283ef7e69cf.gif)
+
+## Demos
+
+| Version				| Demo	|
+| ---					| ---	|
+| `react-leaflet@1.9.1`	| [`CodePen`](https://codepen.io/m_hasbie/full/jvgeVR/) |
+| `react-leaflet@2.x`	| [`CodePen`](https://codepen.io/m_hasbie/full/MqNPRy/) |
+| `react-leaflet@5.x`	| [`CodePen`](https://codepen.io/m_hasbie/full/wBGampr) |
+
+
+## Installation
+
+### Install via NPM
+
+```bash
+npm install --save react-leaflet-deflate
+```
+
+`react-leaflet-deflate` requires `leaflet.markercluster` as [`peerDependency`](https://docs.npmjs.com/files/package.json#peerdependencies)
+
+(React, Leaflet, react-leaflet also should be installed)
+```bash
+npm install --save leaflet.markercluster
+```
+
+## Releases
+
+Merging a pull request into `master` runs the release workflow. Before merging a release PR, update the version in both `package.json` and `package-lock.json`. The workflow uses that version to stage the package on npm and create the GitHub Release tag (`v<version>`), and stops if the tag already exists. The GitHub Release is created when staging succeeds; the npm version is not publicly available until it is approved.
+
+## Usage example
+
+### react-leaflet v5
+
+```javascript
+import { MapContainer, TileLayer } from 'react-leaflet';
+import Deflate from 'react-leaflet-deflate';
+
+const geojson = {...};
+
+<MapContainer center={[2.935403, 101.448205]} zoom={10}>
+  <TileLayer
+    url="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
+    attribution='&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
+  />
+
+  <Deflate
+    data={geojson}
+    minSize={10}
+    markerCluster={true}
+  />
+</MapContainer>
+```
+
+### Options
+
+Option          | Type      | Default | Description
+--------------- | --------- | ------- | -------------
+`data`          | `object`     | `{}`    | Required. A valid [GeoJSON object](http://geojson.org/geojson-spec.html).
+`minSize`       | `int`     | `20`    | Defines the minimum width and height in pixels for a path to be displayed in its actual shape.
+`markerOptions` | `object` or `function`  | `{}`    | Optional. Customize the markers of deflated features using [Leaflet marker options](http://leafletjs.com/reference-1.3.0.html#marker).
+`markerCluster` | `boolean` | `false` | Indicates whether markers should be clustered. Requires `Leaflet.markercluster`.
+`markerClusterOptions` | `object` | `{}`    | Optional. Customize the appearance and behaviour of clustered markers using [`Leaflet.markercluster` options](https://github.com/Leaflet/Leaflet.markercluster#options).
+`pointToLayer`  | `function`  | `{}`    | [Leaflet geojson pointToLayer options](http://leafletjs.com/reference-1.3.0.html#geojson-pointtolayer).
+`style`         | `function`  | `{}`    | Style to apply to polygons or lines. [Leaflet geojson style options](https://leafletjs.com/reference.html#geojson-style).
+`onEachFeature` | `function`  | `{}`    | Function to execute on each geojson feature. [Leaflet geojson onEachFeature options](https://leafletjs.com/reference.html#geojson-oneachfeature).
+`filter`        | `function`  | `{}`    | Filter function to apply to geojson features. [Leaflet geojson filter options](https://leafletjs.com/reference.html#geojson-filter).
+
+
+# Credits
+  - [oliverroick](https://github.com/oliverroick) and the other [contributors](https://github.com/oliverroick/Leaflet.Deflate/graphs/contributors) to for the original work on `Leaflet.Deflate`.
+  - [clintharris](https://github.com/clintharris) for updating `react-leaflet-deflate` to reference `Leaflet.Deflate` as an external dependency, support property changes, and work with `react-leaflet` v2.
+
+# Tests
+
+For instructions on the browser debug example, see [example/README.md](example/README.md).
+
+Run the Jest/React Testing Library unit suite with:
+
+```bash
+npm test
+```
+
+The Playwright tests run a local Leaflet fixture without external tiles or CDN dependencies. Install the Chromium browser once, then run:
+
+```bash
+npx playwright install chromium
+npm run test:e2e
+```
+
+To run both suites:
+
+```bash
+npm run test:all
+```
+
+# License
+
+MIT License