Repository navigation
feat(MapView): add debugOptions prop - #4427
Merged
Merged
Conversation
Exposes the native map debug drawings (tile borders, collision boxes,
overdraw, camera and padding views, ...) as debugOptions={['tileBorders']}.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Added a
debugOptionsprop onMapViewthat turns on the native debug drawings of the Mapbox SDKs, e.g.debugOptions={['tileBorders', 'collision']}(similar to GL JSshowTileBoundaries/showCollisionBoxes).The names come from the public
MapView.debugOptionsAPIs of the SDK versions we ship (11.33.0). Shared:tileBorders,parseStatus,timestamps,collision,overdraw,stencilClip,depthBuffer,modelBounds,light,camera,padding. Android only:terrainWireframe,layers2DWireframe,layers3DWireframe; iOS ignores them with a warning. Unknown names log a warning and are ignored. Changes apply live, survivestyleURLchanges, and an empty array or removing the prop turns everything off. On Android the map view is relaid out after a change, otherwise thecameraandpaddingoverlay views stay at 0x0.Checklist
CONTRIBUTING.mdyarn generatein the root folder/exampleapp./example)Screenshot OR Video
Verified with the new Map > Debug Options example on an iOS 26.5 simulator and an Android emulator: no drawing without the prop, tile borders and collision boxes toggle live,
parseStatus/overdraw/camera/paddingdraw, options stay after switching to the Dark style, and the prop removal and[]both clear. Warnings seen in the logs: