Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

POLAR-362 Update deprecated boolean of movable parameter to enum value #148

Merged
merged 6 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/clients/afm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +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: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release.

## 1.0.1

Expand Down
2 changes: 1 addition & 1 deletion packages/clients/afm/example/polar-example.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ const mapConfiguration = {
},
pins: {
toZoomLevel: 9,
movable: true,
movable: 'drag',
appearOnClick: {
show: true,
atZoomLevel: 3,
Expand Down
1 change: 1 addition & 0 deletions packages/clients/dish/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +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: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release.

## 1.1.1

Expand Down
2 changes: 1 addition & 1 deletion packages/clients/dish/src/mapConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export const mapConfiguration = {
},
pins: {
toZoomLevel: 7,
movable: true,
movable: 'drag',
style: {
fill: shBlue,
},
Expand Down
4 changes: 4 additions & 0 deletions packages/clients/meldemichel/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## unpublished

- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release.

## 1.1.2

- Chore: Fix bugs via dependency updates.
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/meldemichel/src/mapConfigurations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ const addressSearch: AddressSearchConfiguration = {

const commonPins: Partial<PinsConfiguration> = {
toZoomLevel: 7,
movable: true,
movable: 'drag',
style: {
fill: hamburgRed,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/snowbox/src/mapConfiguration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ export const mapConfiguration = {
pins: {
boundaryLayerId: hamburgBorder,
toZoomLevel: 9,
movable: true,
movable: 'drag',
appearOnClick: {
show: true,
atZoomLevel: 0,
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/Pins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | 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`. |
Expand Down
2 changes: 1 addition & 1 deletion pages/examples/address.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
pins: {
coordinateSource: 'plugin/addressSearch/chosenAddress',
toZoomLevel: 7,
movable: true,
movable: 'drag',
},
reverseGeocoder: {
url: 'https://geodienste.hamburg.de/HH_WPS',
Expand Down
Loading