From f285f385314ac61e068a31525b0da7160bc00be9 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Tue, 30 Jul 2024 14:24:27 +0200 Subject: [PATCH 1/5] Update deprecated boolean of movable parameter to enum value --- packages/clients/afm/CHANGELOG.md | 2 ++ packages/clients/afm/example/polar-example.js | 2 +- packages/clients/dish/CHANGELOG.md | 2 ++ packages/clients/dish/src/mapConfig.ts | 2 +- packages/clients/meldemichel/CHANGELOG.md | 5 +++++ packages/clients/meldemichel/src/mapConfigurations.ts | 2 +- packages/clients/snowbox/src/mapConfiguration.ts | 2 +- packages/plugins/Pins/README.md | 2 +- pages/examples/address.html | 2 +- 9 files changed, 15 insertions(+), 6 deletions(-) diff --git a/packages/clients/afm/CHANGELOG.md b/packages/clients/afm/CHANGELOG.md index c6fb9430d..8fa41f1de 100644 --- a/packages/clients/afm/CHANGELOG.md +++ b/packages/clients/afm/CHANGELOG.md @@ -4,6 +4,8 @@ - Feature: This client now supports the `@polar/core`'s field `stylePath`. The usage is documented in the API.md file. - Feature: Update icon of `layerChooser` in `iconMenu` to `fa-layer-group` to clear-up the content hidden behind the menu button. +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. ## 1.0.1 diff --git a/packages/clients/afm/example/polar-example.js b/packages/clients/afm/example/polar-example.js index a9d64fa8e..3ba7422ec 100644 --- a/packages/clients/afm/example/polar-example.js +++ b/packages/clients/afm/example/polar-example.js @@ -67,7 +67,7 @@ const mapConfiguration = { }, pins: { toZoomLevel: 9, - movable: true, + movable: 'drag', appearOnClick: { show: true, atZoomLevel: 3, diff --git a/packages/clients/dish/CHANGELOG.md b/packages/clients/dish/CHANGELOG.md index 4c3268f4a..e01c4db81 100644 --- a/packages/clients/dish/CHANGELOG.md +++ b/packages/clients/dish/CHANGELOG.md @@ -3,6 +3,8 @@ ## unpublished - Feature: If a user is geolocated outside of the map's extent, the client will inform the user of why geolocation did not take effect via a textbox. +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. ## 1.1.1 diff --git a/packages/clients/dish/src/mapConfig.ts b/packages/clients/dish/src/mapConfig.ts index bd19f59e6..17cf69ebb 100644 --- a/packages/clients/dish/src/mapConfig.ts +++ b/packages/clients/dish/src/mapConfig.ts @@ -208,7 +208,7 @@ export const mapConfiguration = { }, pins: { toZoomLevel: 7, - movable: true, + movable: 'drag', style: { fill: shBlue, }, diff --git a/packages/clients/meldemichel/CHANGELOG.md b/packages/clients/meldemichel/CHANGELOG.md index cea9d999f..bd509e024 100644 --- a/packages/clients/meldemichel/CHANGELOG.md +++ b/packages/clients/meldemichel/CHANGELOG.md @@ -1,5 +1,10 @@ # CHANGELOG +## unpublished + +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. + ## 1.1.2 - Chore: Fix bugs via dependency updates. diff --git a/packages/clients/meldemichel/src/mapConfigurations.ts b/packages/clients/meldemichel/src/mapConfigurations.ts index 06a129ebb..0f9e7b626 100644 --- a/packages/clients/meldemichel/src/mapConfigurations.ts +++ b/packages/clients/meldemichel/src/mapConfigurations.ts @@ -104,7 +104,7 @@ const addressSearch: AddressSearchConfiguration = { const commonPins: Partial = { toZoomLevel: 7, - movable: true, + movable: 'drag', style: { fill: hamburgRed, }, diff --git a/packages/clients/snowbox/src/mapConfiguration.ts b/packages/clients/snowbox/src/mapConfiguration.ts index e46eb155b..8e4a1eadd 100644 --- a/packages/clients/snowbox/src/mapConfiguration.ts +++ b/packages/clients/snowbox/src/mapConfiguration.ts @@ -179,7 +179,7 @@ export const mapConfiguration = { pins: { boundaryLayerId: hamburgBorder, toZoomLevel: 9, - movable: true, + movable: 'drag', appearOnClick: { show: true, atZoomLevel: 0, diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index 218493a8a..98ce40056 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -17,7 +17,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | | initial | initial? | Configuration options for setting an initial pin. | -| movable | boolean? \| 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | +| movable | 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | | style | style? | Display style configuration. | | toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | | toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | diff --git a/pages/examples/address.html b/pages/examples/address.html index cd6537975..431b3a589 100644 --- a/pages/examples/address.html +++ b/pages/examples/address.html @@ -63,7 +63,7 @@ pins: { coordinateSource: 'plugin/addressSearch/chosenAddress', toZoomLevel: 7, - movable: true, + movable: 'drag', }, reverseGeocoder: { url: 'https://geodienste.hamburg.de/HH_WPS', From 734d1f5b9ae78508e9fceeec30a55645eaa06b6a Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:56:13 +0200 Subject: [PATCH 2/5] Update packages/clients/afm/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/afm/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/afm/CHANGELOG.md b/packages/clients/afm/CHANGELOG.md index 8fa41f1de..1fd2ee12d 100644 --- a/packages/clients/afm/CHANGELOG.md +++ b/packages/clients/afm/CHANGELOG.md @@ -4,8 +4,7 @@ - Feature: This client now supports the `@polar/core`'s field `stylePath`. The usage is documented in the API.md file. - Feature: Update icon of `layerChooser` in `iconMenu` to `fa-layer-group` to clear-up the content hidden behind the menu button. -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.0.1 From 359f1dcde0a663428fa06ae3191ae496bab48a3c Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:57:45 +0200 Subject: [PATCH 3/5] Update packages/plugins/Pins/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/plugins/Pins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index 98ce40056..1df84598b 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -17,7 +17,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | | initial | initial? | Configuration options for setting an initial pin. | -| movable | 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | +| movable | boolean \| 'drag' \| 'click' \| 'none'? | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | | style | style? | Display style configuration. | | toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | | toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | From 3e4879040b69436fa133b5eac87624e95aa950ae Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:58:05 +0200 Subject: [PATCH 4/5] Update packages/clients/meldemichel/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/meldemichel/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/meldemichel/CHANGELOG.md b/packages/clients/meldemichel/CHANGELOG.md index bd509e024..89a97bfba 100644 --- a/packages/clients/meldemichel/CHANGELOG.md +++ b/packages/clients/meldemichel/CHANGELOG.md @@ -2,8 +2,7 @@ ## unpublished -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.1.2 From 6faa5d21dc14a64e66d3e51a5a07adaf59b31f90 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:58:15 +0200 Subject: [PATCH 5/5] Update packages/clients/dish/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/dish/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/dish/CHANGELOG.md b/packages/clients/dish/CHANGELOG.md index e01c4db81..477a7c6d9 100644 --- a/packages/clients/dish/CHANGELOG.md +++ b/packages/clients/dish/CHANGELOG.md @@ -3,8 +3,7 @@ ## unpublished - Feature: If a user is geolocated outside of the map's extent, the client will inform the user of why geolocation did not take effect via a textbox. -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.1.1