expo-phone-number-hint

Provides a frictionless way to show a user's (SIM-based) phone numbers as a hint, powered by Google's Phone Number Hint API.

Installation

npx expo install expo-phone-number-hint

Usage

import {
  isAvailableAsync,
  showPhoneNumberHintAsync,
} from "expo-phone-number-hint";

const isAvailable = await isAvailableAsync();
if (isAvailable) {
  const phoneNumber = await showPhoneNumberHintAsync();

  if (phoneNumber) {
    // user selected a number
    console.log(phoneNumber); // "+919876543210"
  } else {
    // user dismissed the picker
  }
}

API

isAvailableAsync()

function isAvailableAsync(): Promise<boolean>

Check whether the Phone Number Hint API can be used on this device. Never throws.

showPhoneNumberHintAsync()

function showPhoneNumberHintAsync(): Promise<string | null>

Show the system phone number picker.

Returns the selected phone number in E.164 format (e.g. "+14155551234"), or null if the user dismissed the picker.

Throws an error with a code property on failure. See Handling errors below.

Handling errors

All known codes are exported as PhoneNumberHintErrorCodes.

| Code | Meaning | |------|---------| | ERR_PLAY_SERVICES_UNAVAILABLE | Google Play Services is unavailable | | ERR_NO_HINT_AVAILABLE | No phone number hints available | | ERR_NO_ACTIVITY | No foreground activity | | ERR_LAUNCH_FAILED | Failed to launch the picker | | ERR_EXTRACTION_FAILED | Failed to extract phone number from result | | ERR_ALREADY_IN_PROGRESS | Another request is already showing the picker | | ERR_MODULE_DESTROYED | Module destroyed before result was delivered | | ERR_UNAVAILABLE | Called on a platform where the picker is not available (iOS or web) |

Play Services Auth version

Defaults to com.google.android.gms:play-services-auth:21.5.1. To override, set playServicesAuthVersion in your root android/build.gradle:

ext {
  playServicesAuthVersion = "21.4.0"
}