jazzy.yml

module: MapboxNavigation
author: Mapbox
title: "Navigation SDK for iOS"
author_url: https://docs.mapbox.com/ios/navigation/
github_url: https://github.com/mapbox/mapbox-navigation-ios
dash_url: https://docs.mapbox.com/ios/docsets/MapboxNavigation.xml
copyright: '© 2014–2021 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-navigation-ios/blob/main/LICENSE.md) for more details.'

head: |
  <link rel='shortcut icon' href='https://www.mapbox.com/img/favicon.ico' type='image/x-icon' />
skip_undocumented: Yes
hide_documentation_coverage: Yes

custom_categories:
  - name: Guides
    children:
      - Using Map Matching
      - Reduce Memory Usage
      - Styling the UI
  - name: Turn-by-turn UI
    children:
      - NavigationViewController
      - NavigationViewControllerDelegate
      - RouteVoiceController
      - SpeechSynthesizing
      - SpeechSynthesizingDelegate
      - MapboxSpeechSynthesizer
      - SystemSpeechSynthesizer
      - MultiplexedSpeechSynthesizer
      - SpeechError
      - SpeechFailureAction
      - NavigationOptions
      - NavigationView
  - name: Core Navigation Logic
    children:
      - NavigationService
      - NavigationServiceDelegate
      - MapboxNavigationService
      - Router
      - RouterDataSource
      - RouteController
      - RouterDelegate
      - RouteProgress
      - RouteLegProgress
      - RouteStep
      - RouteStepProgress
      - CongestionLevel
      - VisualInstruction
      - VisualInstructionDelegate
      - NavigationEventsManager
      - ActiveNavigationEventsManagerDataSource
      - PassiveNavigationEventsManagerDataSource
      - NavigationLocationManager
      - ReplayLocationManager
      - SimulatedLocationManager
      - NavigationRouteOptions
      - RouteOptions
      - NavigationMatchOptions
      - SimulationMode
      - PassiveLocationManager
      - HistoryRecording
  - name: Maps
    children:
      - NavigationMapView
      - NavigationMapViewDelegate
      - MapView
      - PassiveLocationProvider
      - NavigationLocationProvider
      - WaypointStyle
      - UserLocationStyle
  - name: Styling
    children:
      - Style
      - StyleManager
      - StyleManagerNotificationUserInfoKey
      - StyleManagerDelegate
      - DayStyle
      - NightStyle
  - name: Formatters
    children:
      - DistanceFormatter
  - name: UI Components
    children:
      - BottomBannerViewController
      - BottomBannerViewControllerDelegate
      - SpeedLimitView
      - UserPuckCourseView
      - UserHaloCourseView
      - CourseUpdatable
      - NavigationComponent
  - name: Guidance Instruction UI
    children:
      - TopBannerViewController
      - InstructionsCardViewController
      - InstructionsCardContainerView
      - InstructionsCardContainerViewDelegate
      - InstructionsBannerViewDelegate
      - ManeuverView
      - JunctionView
      - GenericRouteShield
  - name: CarPlay
    children:
      - CarPlayManager
      - CarPlayManagerDelegate
      - CarPlayNavigationViewController
      - CarPlayNavigationViewControllerDelegate
      - CarPlayActivity
      - CarPlayCompassView
      - CarPlayMapViewController
      - CarPlayMapViewControllerDelegate
      - CarPlaySearchController
      - CarPlaySearchControllerDelegate
      - CarPlayConnectionObserver
      - RecentItem
      - NavigationGeocodedPlacemark
  - name: Configuration
    children:
      - RouteControllerDeadReckoningTimeInterval
      - RouteControllerMediumAlertInterval
      - RouteControllerHighAlertInterval
      - RouteControllerManeuverZoneRadius
      - RouteSnappingMaxManipulatedCourseAngle
      - RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion
      - RouteControllerMaximumDistanceBeforeRecalculating
      - RouteControllerUserLocationSnappingDistance
      - MapOrnamentPosition
      - CongestionAttribute
      - CurrentLegAttribute
      - RouteLineWidthByZoomLevel
      - NavigationMapViewMinimumDistanceForOverheadZooming
      - NavigationViewMinimumVolumeForWarning
      - GradientCongestionFadingDistance
      - RouteControllerIncorrectCourseMultiplier
      - RouteControllerLinkedInstructionBufferMultiplier
      - RouteControllerMaximumSpeedForUsingCurrentStep
      - RouteControllerMinNumberOfInCorrectCourses
      - RouteControllerMinimumBacktrackingDistanceForRerouting
      - RouteControllerMinimumDistanceForContinueInstruction
      - RouteControllerMinimumDurationRemainingForProactiveRerouting
      - RouteControllerMinimumNumberLocationUpdatesBackwards
      - RouteControllerNumberOfSecondsForRerouteFeedback
      - RouteControllerProactiveReroutingInterval
      - RouteSnappingMinimumHorizontalAccuracy
      - RouteSnappingMinimumSpeed
      - NavigationSettings
  - name: User Feedback
    children:
      - FeedbackViewController
      - FeedbackViewControllerDelegate
      - FeedbackItem
      - ActiveNavigationFeedbackType
      - PassiveNavigationFeedbackType
      - PassiveNavigationIncorrectVisualSubtype
      - ConfusingAudioSubtype
      - RouteQualitySubtype
      - IllegalRouteSubtype
      - RoadClosureSubtype
      - FeedbackSource
      - EndOfRouteFeedback
  - name: Camera
    children:
      - NavigationCamera
      - NavigationCameraType
      - NavigationCameraState
      - CameraStateTransition
      - NavigationCameraStateTransition
      - ViewportDataSource
      - NavigationViewportDataSource
      - ViewportDataSourceType
      - ViewportDataSourceDelegate
  - name: Electronic Horizon
    children:
      - ElectronicHorizonOptions
      - RoadGraph
      - OpenLRIdentifier
      - OpenLROrientation
      - RoadName
      - RoadObject
      - DistancedRoadObject
      - RoadObjectMatcher
      - RoadObjectStore
      - RoadObjectMatcherDelegate
      - RoadObjectStoreDelegate
      - RoadObjectMatcherError