Expo

Get Started
API Reference

Linking

This module allows your app to interact with other apps via deep links. It provides helper methods for constructing and parsing deep links into your app.
This module is an extension of the React Native Linking module, meaning that all methods in the RN module can be accessed via Linking, on top of the extra methods provided by Expo (detailed here). These methods only apply to the managed workflow, you cannot use them in a bare React Native app.
For information and examples on how to use this API and the react-native Linking API in your app, take a look at this guide.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-linking

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

API

import * as Linking from 'expo-linking';

Methods

Linking.makeUrl(path, options, scheme)

Helper method for constructing a deep link into your app, given an optional path and set of query parameters. Creates a URI scheme with three slashes (scheme:///) in standalone apps.

Arguments

  • path (string) -- Any path into your app.
  • queryParams (object) -- An object with a set of query parameters. These will be merged with any Expo-specific parameters that are needed (e.g. release channel) and then appended to the url as a query string.
  • scheme (string) -- Optional URI protocol to use in the URL <scheme>:///, when undefined the scheme will be chosen from the Expo config (app.config.js or app.json).

Returns

A URL string which points to your app with the given deep link information.

Linking.createURL(path, options)

This method is only available in expo-linking@2.0.1 and higher. Helper method for constructing a deep link into your app, given an optional path and set of query parameters. Creates a URI scheme with two slashes by default (scheme://).

Arguments

  • path (string) -- Any path into your app.
  • queryParams (object) -- An object with a set of query parameters. These will be merged with any Expo-specific parameters that are needed (e.g. release channel) and then appended to the url as a query string.
  • scheme (string) -- Optional URI protocol to use in the URL <scheme>://, when undefined the scheme will be chosen from the Expo config (app.config.js or app.json).

Returns

A URL string which points to your app with the given deep link information.

Linking.parse(url)

Helper method for parsing out deep link information from a URL.

Arguments

  • url (string) -- A URL that points to the currently running experience (e.g. an output of Linking.createURL()).

Returns

An object with the following keys:
  • path (string) -- The path into the app specified by the url.
  • queryParams (object) -- The set of query parameters specified by the query string of the url.

Linking.parseInitialURLAsync()

Helper method which wraps React Native's Linking.getInitialURL() in Linking.parse(). Parses the deep link information out of the URL used to open the experience initially.

Returns

A promise that resolves to an object with the following keys:
  • path (string) -- The path specified by the url used to open the app.
  • queryParams (object) -- The set of query parameters specified by the query string of the url used to open the app.

Hooks

Linking.useUrl()

Returns the initial URL followed by any subsequent changes to the URL.