mapbox/mapbox-gl-js

Disable compass interactivity for `interactive: false` maps

Open

#8,618 opened on Aug 10, 2019

View on GitHub
 (10 comments) (0 reactions) (0 assignees)JavaScript (10,532 stars) (2,203 forks)batch import
good first issue

Description

mapbox-gl-js version: v1.2.1

browser: Chrome/Firefox, likely any

Steps to Trigger Behavior

https://docs.mapbox.com/mapbox-gl-js/example/animate-camera-around-point/ with interactive: false and

map.addControl(new mapboxgl.NavigationControl({
  visualizePitch: true,
  showZoom: false
}));

Link to Demonstration

https://jsbin.com/yatuvegeti/1/edit?html,output

Expected Behavior

It's not possible for the user to interrupt/alter the animation. Also the compass tooltip Reset bearing to north should not be displayed.

Actual Behavior

It's possible to rotate / tilt the map dragging the compass icon and the tooltip is displayed.

One could argue that this is not a bug, because the compass is a navigation control. In this case it would be appreciated if this issue would be considered as feature request. It would be useful to be able to use the compass for indicating bearing/pitch while animating the camera and the user is not able to interrupt/alter the animation.

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptmapbox gl js basicsNavigationControl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the NavigationControl implementation, likely in src/ui/control/navigation control.js. Look for how the compass icon handles drag events and tooltip display. The issue is that when map.interactive is false, the compass should ignore user interactions. Check how the control currently responds to the interactive flag, and add a check to disable dragging and tooltip when interactive is false. See the example at https://jsbin.com/yatuvegeti/1/edit?html,output for reproducing.