Skip to content

Waze

Waze is a navigation app and live map service. Protocol Launcher allows you to generate Waze Deep Links to open Waze, search for a place or address, show a map location, navigate to coordinates, and navigate to the Home or Work favorite.

Usage

There are two ways to use this library:

  • On-Demand import from subpaths enables tree-shaking and keeps bundles small.
  • Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

Notes

Waze documents https://waze.com/ul as the base URL for Deep Links. The waze:// URL scheme should only be used when the Waze app is known to be installed; otherwise, Waze says tapping the link does nothing. These helpers default to HTTPS for Deep Links, and accept protocol: 'waze' only where Waze documents using the native scheme in place of the base URL.

utmSource maps to Waze's documented utm_source parameter.

Open Waze

On-Demand
ts
import { open } from 'protocol-launcher/waze'

const url = open()
On-Demand
ts
import { search } from 'protocol-launcher/waze'

const url = search({
  q: '66 Acacia Avenue',
})
On-Demand
ts
import { navigateToLocation } from 'protocol-launcher/waze'

const url = navigateToLocation({
  ll: '40.75889500,-73.98513100',
  zoom: 17,
})
On-Demand
ts
import { navigateToFavorite } from 'protocol-launcher/waze'

const url = navigateToFavorite({
  favorite: 'work',
})

Show on Map

On-Demand
ts
import { showOnMap } from 'protocol-launcher/waze'

const url = showOnMap({
  z: 8,
})

Show Location on Map

On-Demand
ts
import { showOnMap } from 'protocol-launcher/waze'

const url = showOnMap({
  ll: '45.6906304,-120.810983',
  z: 10,
})

Search and Navigate

On-Demand
ts
import { searchAndNavigate } from 'protocol-launcher/waze'

const url = searchAndNavigate({
  q: '66 Acacia Avenue',
  ll: '45.6906304,-120.810983',
})

Official Documentation