mapbox / mapbox/mapbox-navigation-ios

[Known issue] Custom location puck disables map matching

Open
#4,428 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
918
Forks
326
Avg merge
1h 16m
Merged PRs (30d)
3

Description

In NavSDK 2.12.0 and older, usage of custom Puck2DConfiguration to replace the default navigation puck with a custom icon leads to map matching being disabled, which means the locations puck will no longer snap to the roads.

This is considered a known issue and there is a temporary workaround we propose:
Use UserLocationStyle.courseView with a custom subclass of UserCourseView instead of using .puck2d.
Here is a ready-to-use implementation: CustomCourseView.swift

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing custom Puck2DConfiguration with UserLocationStyle.courseView and the UserCourseView approach described in the issue. Review the provided CustomCourseView.swift implementation and reproduce the behavior in NavSDK 2.12.0 or older. Done means a custom navigation icon no longer disables map matching or road snapping.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
mobile
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.