Skip to content

feat(Map): Add allowPan option #285

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

Merged
sjockers merged 4 commits into from
Jan 16, 2026
Merged

feat(Map): Add allowPan option #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e972bba
Add 'allowPan' prop, consistent with zoom and rotation options
sjockers Jan 16, 2026
8a39141
Toggle cursors (grab/grabbing) based on dragPan setting
sjockers Jan 16, 2026
fa9ca1e
Add unit tests
sjockers Jan 16, 2026
aab035c
Remove logging
sjockers Jan 16, 2026
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
64 changes: 64 additions & 0 deletions components/src/maplibre/Map/Map.stories.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@

let mapContext: MapContext;
const onMoveStart = fn();

let mapOptions = $state({
allowZoom: true,
allowPan: true
});
</script>

<Story
Expand Down Expand Up @@ -132,6 +137,65 @@
</div>
</Story>

<Story
asChild
name="Toggle zoom and pan"
play={async ({ canvasElement, step }) => {
const canvas = within(canvasElement);
const containerEl = canvas.getByTestId('map-container');
const toggleZoomButton = canvas.getByTestId('toggle-zoom');
const togglePanButton = canvas.getByTestId('toggle-pan');

await step('toggle zoom off', async () => {
await userEvent.click(toggleZoomButton);
expect(mapContext.map?.scrollZoom.isEnabled()).toBe(false);
});

await step('toggle zoom on', async () => {
await userEvent.click(toggleZoomButton);
expect(mapContext.map?.scrollZoom.isEnabled()).toBe(true);
});

await step('toggle pan off', async () => {
await userEvent.click(togglePanButton);
expect(mapContext.map?.dragPan.isEnabled()).toBe(false);
});

await step('toggle pan on', async () => {
await userEvent.click(togglePanButton);
expect(mapContext.map?.dragPan.isEnabled()).toBe(true);
});
}}
>
<div class="container">
<DesignTokens theme="light">
<button
data-testid="toggle-zoom"
onclick={() => {
mapOptions.allowZoom = !mapOptions.allowZoom;
}}>Toggle Zoom</button
>
<button
data-testid="toggle-pan"
onclick={() => {
mapOptions.allowPan = !mapOptions.allowPan;
}}>Toggle Pan</button
>
<Map
style={SWRDataLabLight()}
initialLocation={{ lat: 50.88, lng: 10.43, zoom: 5 }}
showDebug
onmovestart={onMoveStart}
allowZoom={mapOptions.allowZoom}
allowPan={mapOptions.allowPan}
bind:mapContext
>
<AttributionControl />
</Map>
</DesignTokens>
</div>
</Story>

<Story asChild name="Globe Projection">
<div class="container">
<DesignTokens theme="dark">
Expand Down
21 changes: 15 additions & 6 deletions components/src/maplibre/Map/Map.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
initialBounds?: LngLatBoundsLike;
maxBounds?: LngLatBoundsLike;
initialLocation?: Location;
allowPan?: boolean;
allowRotation?: boolean;
allowZoom?: boolean;
minZoom?: number;
Expand Down Expand Up @@ -57,6 +58,7 @@
bearing = $bindable(0),
loading = $bindable(true),
projection = { type: 'mercator' },
allowPan = true,
allowRotation = false,
allowZoom = true,
showDebug = false,
Expand Down Expand Up @@ -157,7 +159,15 @@
}
});

const debugValues = $derived(Object.entries({ zoom, pitch, allowZoom, allowRotation }));
$effect(() => {
if (allowPan === false) {
mapContext.map?.dragPan.disable();
} else {
mapContext.map?.dragPan.enable();
}
});

const debugValues = $derived(Object.entries({ zoom, pitch, allowZoom, allowPan, allowRotation }));
const handleDebugValueClick = (e: MouseEvent) => {
if (e.target) {
const t = e.target as HTMLElement;
Expand Down Expand Up @@ -253,19 +263,18 @@
width: 100%;
}

.maplibregl-canvas-container.maplibregl-interactive {
.maplibregl-canvas-container.maplibregl-touch-drag-pan {
cursor: grab;
user-select: none;
}
.maplibregl-canvas-container.maplibregl-touch-drag-pan:active {
cursor: grabbing;
}

.maplibregl-canvas-container.maplibregl-interactive.maplibregl-track-pointer {
cursor: pointer;
}

.maplibregl-canvas-container.maplibregl-interactive:active {
cursor: grabbing;
}

.maplibregl-canvas-container.maplibregl-touch-zoom-rotate,
.maplibregl-canvas-container.maplibregl-touch-zoom-rotate .maplibregl-canvas {
touch-action: pan-x pan-y;
Expand Down