Document guidance cards, junction views#2627
Merged
Merged
Conversation
MaximAlien
approved these changes
Sep 14, 2020
1ec5
force-pushed
the
1ec5-cards-docs-2519
branch
from
d6e3389 to
041b620
Compare
Contributor
Author
|
Cherry-picked into the release-v1.0 branch as db74f46. |
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
2 participants
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.
Added class documentation comments for the minimum set of types necessary to consider the guidance cards feature from #2149 and #2296 to be publicly available. With these changes, we can finally add a blurb to the changelog announcing the introduction of this feature, even though it has been in the codebase for quite some time. This PR also adds some documentation about junction views for styling purposes.
Guidance cards, represented by the
InstructionsCardViewControllerclass, is an alternative presentation of maneuver instructions that is intended to be better visually integrated with the map than the traditional presentation of banners flush with the edges of the screen, represented by the defaultTopBannerViewControllerclass. To enable guidance cards, an application would pass an instance ofInstructionsCardViewControllerintoNavigationOptions(styles:navigationService:voiceController:topBanner:bottomBanner:)when creating the NavigationViewController. Using guidance cards in a custom turn-by-turn navigation UI requires some additional setup and delegate method implementations.Fixes most of #2519.
/cc @mapbox/navigation-ios @avi-c @d-prukop