Skip to content

Commit

Permalink
Document path alias in linking
Browse files Browse the repository at this point in the history
  • Loading branch information
satya164 committed Dec 3, 2024
1 parent 7520267 commit 256ae25
Showing 1 changed file with 58 additions and 1 deletion.
59 changes: 58 additions & 1 deletion versioned_docs/version-7.x/configuring-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -1248,7 +1248,7 @@ Depending on your requirements, you can use this functionality to parse and stri
## Matching regular expressions
If you need more complex matching logic, you can use regular expressions to match the path. For example, if you want to use the pattern `@username` to match a user's profile, you can use a regular expression to match the path.
If you need more complex matching logic, you can use regular expressions to match the path. For example, if you want to use the pattern `@username` to match a user's profile, you can use a regular expression to match the path. This allows you to have the same path pattern for multiple screens, but fine-tune the matching logic to be more specific for a particular screen.
Regular expressions can be specified between parentheses `(` and `)` in the after a param name. For example:
Expand All @@ -1258,6 +1258,12 @@ Regular expressions can be specified between parentheses `(` and `)` in the afte
```js
const RootStack = createStackNavigator({
screens: {
Feed: {
screen: FeedScreen,
linking: {
path: ':sort(latest|popular)',
},
},
Profile: {
screen: ProfileScreen,
linking: {
Expand All @@ -1274,6 +1280,7 @@ const RootStack = createStackNavigator({
```js
const config = {
screens: {
Feed: ':sort(latest|popular)',
Profile: ':username(@[A-Za-z0-9_]+)',
},
};
Expand All @@ -1292,6 +1299,56 @@ Regular expressions are an advanced feature. They cannot be validated to warn yo
:::
## Alias for paths
If you want to have multiple paths for the same screen, you can use the `alias` property to specify an array of paths. This can be useful to keep backward compatibility with old URLs while transitioning to a new URL structure.
For example, if you want to match both `/users/:id` and `/:id` to the `Profile` screen, you can do this:
<Tabs groupId="config" queryString="config">
<TabItem value="static" label="Static" default>
```js
const RootStack = createStackNavigator({
screens: {
Profile: {
screen: ProfileScreen,
linking: {
path: ':id',
alias: ['users/:id'],
},
},
},
});
```
</TabItem>
<TabItem value="dynamic" label="Dynamic">
```js
const config = {
screens: {
Profile: {
path: ':id',
alias: ['users/:id'],
},
},
};
```
</TabItem>
</Tabs>
In this case, when the URL is `/users/jane` or `/jane`, it'll match the `Profile` screen. The `path` is the primary pattern that will be used to generate the URL, e.g. when navigating to the `Profile` screen in the app on the Web. The patterns in `alias` will be ignored when generating URLs. The `alias` patterns are not used for matching any child screens in nested navigators.
On the web, if a screen containing an alias contains a nested navigator, the URL matching the alias will only be used to match the screen, and will be updated to the URL of the focused child screen once the app renders.
Each item in the `alias` array can be a string matching the syntax of the `path` property, or an object with the following properties:
- `path` (required) - The path pattern to match.
- `exact` - Whether to match the path exactly. Defaults to `false`. See [Matching exact paths](#matching-exact-paths) for more details.
- `parse` - Function to parse path segments into param values. See [Passing params](#passing-params) for more details.
## Advanced cases
For some advanced cases, specifying the mapping may not be sufficient. To handle such cases, you can specify a custom function to parse the URL into a state object ([`getStateFromPath`](navigation-container.md#linkinggetstatefrompath)), and a custom function to serialize the state object into an URL ([`getPathFromState`](navigation-container.md#linkinggetpathfromstate)).
Expand Down

0 comments on commit 256ae25

Please sign in to comment.