Protocol Launcher

Google Maps ​

Google Maps is a web mapping service developed by Google. It provides maps, search, street view, and directions. Protocol Launcher allows you to generate deep links to open Google Maps, display maps, search places, get directions, and open supported Google Maps desktop URLs.

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 ​

This module only wraps parameters documented by Google. The official page mentions comgooglemaps-x-callback://, but does not document x-callback actions or payload parameters, so this module does not expose x-callback helpers.

Open Google Maps ​

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

const url = open()
Open Google Maps

Display Map ​

On-Demand
ts
import { displayMap } from 'protocol-launcher/google-maps'

const url = displayMap({
  center: '40.765819,-73.975866',
  zoom: 14,
  views: 'traffic',
})
Display Map with Traffic

Display Street View ​

On-Demand
ts
import { displayMap } from 'protocol-launcher/google-maps'

const url = displayMap({
  center: '46.414382,10.013988',
  mapmode: 'streetview',
})
Display Street View

Clear Views ​

On-Demand
ts
import { displayMap } from 'protocol-launcher/google-maps'

const url = displayMap({
  views: '',
})
Clear Views
On-Demand
ts
import { search } from 'protocol-launcher/google-maps'

const url = search({
  q: 'Pizza',
  center: '37.759748,-122.427135',
})
Search Pizza

Search with Views ​

On-Demand
ts
import { search } from 'protocol-launcher/google-maps'

const url = search({
  q: 'Steamers Lane Santa Cruz, CA',
  center: '37.782652,-122.410126',
  views: ['satellite', 'traffic'],
  zoom: 15,
})
Search with Views

Display Directions ​

On-Demand
ts
import { directions } from 'protocol-launcher/google-maps'

const url = directions({
  saddr: 'Google Inc, 8th Avenue, New York, NY',
  daddr: 'John F. Kennedy International Airport, Van Wyck Expressway, Jamaica, New York',
  directionsmode: 'transit',
})
Display Transit Directions

Directions from Current Location ​

On-Demand
ts
import { directions } from 'protocol-launcher/google-maps'

const url = directions({
  saddr: '',
  daddr: 'John F. Kennedy International Airport',
  directionsmode: 'driving',
})
Directions from Current Location

Walking Directions ​

On-Demand
ts
import { directions } from 'protocol-launcher/google-maps'

const url = directions({
  saddr: '2025 Garcia Ave, Mountain View, CA, USA',
  daddr: 'Google, 1600 Amphitheatre Parkway, Mountain View, CA, United States',
  center: '37.423725,-122.0877',
  directionsmode: 'walking',
  zoom: 17,
})
Display Walking Directions

Open Desktop URL ​

openUrl accepts only the Google Maps desktop URL formats covered by Google's official URL scheme regular expression: maps.google.{TLD}/, google.{TLD}/maps/ or www.google.{TLD}/maps/, and goo.gl/maps/, with an optional http:// or https:// prefix.

On-Demand
ts
import { openUrl } from 'protocol-launcher/google-maps'

const url = openUrl({
  url: 'https://www.google.com/maps/preview/@42.585444,13.007813,6z',
})
Open Google Maps Desktop URL

Official Documentation ​