react-navigation / react-navigation/react-navigation.github.io

Is deep linking documentation for ios wrong with regards to the scheme and identifier?

Open
#1,148 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
324
Forks
2k
PR merge metrics
No merged PRs in 30d

Description

initially posted here: https://github.com/react-navigation/react-navigation/discussions/10462
but got no response, and i feel like this is important.


under the docs for deep linking on ios: https://reactnavigation.org/docs/deep-linking/#setup-on-ios

there is a section for setting the scheme in the project.

here it says you can run a command to do it automatically:

npx uri-scheme add mychat --ios

this does indeed add mychat as a "URL Scheme" in Xcode. however, it does not add an "Identifier". that is left blank.

then underneath, there are instructions on how to do it manually instead of automatically.

here it shows that we need to add mychat for both "Identifier" and "URL Scheme". this is different than the previous method, now "Identifier" is no longer left blank.

i found the apple docs for deep linking: https://developer.apple.com/documentation/xcode/defining-a-custom-url-scheme-for-your-app

and here it says:

The identifier you supply with your scheme distinguishes your app from others that declare support for the same scheme. To ensure uniqueness, specify a reverse DNS string that incorporates your company’s domain and app name.

their example also shows that the "Identifier" is com.example.myphotoapp while the "URL Scheme" is myphotoapp.

so this makes me believe that the react-navigation documentation shouldt say we should set same string for both. it should show an example similar to the example from Apple.

now since every app already has a bundleId which is a reverse DNS string, that one should be used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the deep-linking documentation's “Setup on iOS” section and compare the npx uri-scheme command with the manual Xcode instructions. Check the Apple custom URL scheme guidance linked in the issue, including the distinction between Identifier and URL Scheme. Done means the documentation consistently explains the correct values and reflects the verified setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios, react-native
Domain
documentation, mobile
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.