Skip to content

what3words

what3words is a location app for finding and sharing precise locations with 3 word addresses. Protocol Launcher allows you to generate mobile links to open the what3words app at the user's current location or navigate to a 3 word address.

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.

URL Methods

The official what3words mobile linking documentation lists two supported w3w://show URI forms: ?currentlocation and ?threewords=[word.word.word]. This module exposes only those documented forms.

Show Current Location

Generate the documented URL that opens the what3words app at the user's current location.

On-Demand
ts
import { showCurrentLocation } from 'protocol-launcher/what3words'

const url = showCurrentLocation()

Show Three Words

Generate the documented URL that navigates to a 3 word address in the what3words app. Pass the address in word.word.word form.

On-Demand
ts
import { showThreeWords } from 'protocol-launcher/what3words'

const url = showThreeWords({
  threeWords: 'daring.lion.race',
})

Generated URLs

ts
showCurrentLocation()
// => 'w3w://show?currentlocation'

showThreeWords({ threeWords: 'daring.lion.race' })
// => 'w3w://show?threewords=daring.lion.race'

Official Documentation