Skip to content

Fix Marker position update comparison #1139

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix Marker position update comparison #1139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56d06e3
Fix Marker position update comparison
agentpietrucha Aug 3, 2024
cf6d173
Add return after updating marker position
agentpietrucha Aug 4, 2024
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
49 changes: 46 additions & 3 deletions packages/react-leaflet/src/Marker.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import {
extendContext,
} from '@react-leaflet/core'
import {
LatLng,
type LatLngExpression,
type LatLngLiteral,
type LatLngTuple,
Marker as LeafletMarker,
type MarkerOptions,
} from 'leaflet'
Expand All @@ -16,6 +19,47 @@ export interface MarkerProps extends MarkerOptions, EventedProps {
position: LatLngExpression
}

function arraysEqual(arr1: LatLngTuple, arr2: LatLngTuple) {
return arr1.every((value, index) => value === arr2[index])
}

function objectsEqual(obj1: LatLngLiteral, obj2: LatLngLiteral) {
return Object.keys(obj1).every(
(key) =>
obj1[key as keyof LatLngLiteral] === obj2[key as keyof LatLngLiteral],
)
}

function handlePositionUpdate(
marker: LeafletMarker,
props: MarkerProps,
prevProps: MarkerProps,
) {
if (
props.position instanceof LatLng &&
!props.position.equals(prevProps.position)
) {
return marker.setLatLng(props.position)
}

if (
Array.isArray(props.position) &&
!arraysEqual(props.position, prevProps.position as LatLngTuple)
) {
return marker.setLatLng(props.position)
}

// if position is not a LatLng or LatLngTuple, it must be the LatLngLiteral object
if (
!objectsEqual(
props.position as LatLngLiteral,
prevProps.position as LatLngLiteral,
)
) {
return marker.setLatLng(props.position)
}
}

export const Marker = createLayerComponent<LeafletMarker, MarkerProps>(
function createMarker({ position, ...options }, ctx) {
const marker = new LeafletMarker(position, options)
Expand All @@ -25,9 +69,8 @@ export const Marker = createLayerComponent<LeafletMarker, MarkerProps>(
)
},
function updateMarker(marker, props, prevProps) {
if (props.position !== prevProps.position) {
marker.setLatLng(props.position)
}
handlePositionUpdate(marker, props, prevProps)

if (props.icon != null && props.icon !== prevProps.icon) {
marker.setIcon(props.icon)
}
Expand Down