Skip to content

[pull] main from react-navigation:main #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 229 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
229 commits
Select commit Hold shift + click to select a range
88dc8c1
Handle diff code blocks
satya164 Mar 13, 2024
e322ee8
Fix diffs in upgrading guide
satya164 Mar 13, 2024
ee5a430
Complete existing TODOs in upgrade guide
satya164 Mar 13, 2024
841bfcc
Encode videos with H.264 codec
satya164 Mar 15, 2024
29f5745
Re-encode mov videos to mp4
satya164 Mar 15, 2024
de3124f
Update upgrade guide
satya164 Mar 15, 2024
5bddf22
Update docs with 7.x changes
satya164 Mar 16, 2024
dad6ce9
Fix the descriptions for navigation object
satya164 Mar 18, 2024
e30ac1c
Update animations section for stack
satya164 Mar 18, 2024
2ee1add
Tweak code block styling
satya164 Mar 23, 2024
99d5798
Tweak video styling
satya164 Mar 23, 2024
2c0fab7
Update tab view example and video
satya164 Mar 23, 2024
3e50b6a
Fix video padding
satya164 Mar 23, 2024
ee3679c
Add href to tab bar examples
satya164 Mar 25, 2024
5ff4f15
Document usePreventremove hook
satya164 Mar 25, 2024
9bcaa5d
Shorten headings in upgrade guide
satya164 Mar 25, 2024
15a66bf
Document automatic linking
satya164 Mar 25, 2024
8d369e7
Update configuring links for static config
satya164 Mar 25, 2024
e321de1
Update combining static and dynamic APIs
satya164 Mar 25, 2024
d90dfc6
Add blog post for static API
satya164 Mar 25, 2024
db761ed
Document new elements
satya164 Mar 25, 2024
556ef6e
Document tabBarPosition
satya164 Mar 26, 2024
df873a5
Fix typo in blog post
satya164 Mar 27, 2024
573f34d
Document preload action
satya164 Mar 27, 2024
9fe0d5a
Remove extraneous examples
satya164 Mar 28, 2024
8636893
Document useDrawerProgress
satya164 Mar 28, 2024
487d379
Document exported hooks for each navigator
satya164 Mar 28, 2024
84f8329
Update screen and group docs to adapt to static config
satya164 Mar 28, 2024
fadf41c
Add a page for navigator
satya164 Mar 28, 2024
14af773
Document layout and screenLayout props
satya164 Mar 28, 2024
1a94f4c
Document new API for react-native-tab-view
satya164 Mar 29, 2024
2b3a6ee
Avoid duplicate screen name warnings
satya164 Mar 31, 2024
e683d77
Fix typo
satya164 Apr 2, 2024
91b95cf
Add a note about TypeScript under fundamentals
satya164 Apr 9, 2024
4309c8e
Remove note about React Navigation 4
satya164 Apr 20, 2024
14d6b27
Tweak description for group
satya164 Jun 22, 2024
4ce5289
Mention Expo React Navigation devtools plugin
satya164 Jun 22, 2024
17c6783
Add a note about ErrorBoundary to state persistence docs
satya164 Jun 24, 2024
66ec947
Update SSR docs for static rendering
satya164 Jun 24, 2024
bc4ce11
Remove redux and MST docs as they are outdated and not anything speci…
satya164 Jun 24, 2024
db9b6d7
Update NavigationContainer docs
satya164 Jun 26, 2024
57c00dc
Document popToTopOnBlur
satya164 Jun 26, 2024
c9cec95
Document direction prop and useLocale
satya164 Jun 26, 2024
50598f5
Use elements button for examples
satya164 Jun 27, 2024
35a6db3
Add blog post for React Navigation 7 RC
satya164 Jun 27, 2024
3f66a2e
Update tab sidebar graphics
satya164 Jun 28, 2024
201f234
Fix typo on try it out section (#1347)
betomoedano Jun 29, 2024
23f6b68
Document tabBarVariant
satya164 Jul 3, 2024
992cbf3
Add a note about keeping native theme in sync
satya164 Jul 8, 2024
298d524
Fix removing shared screen docs for static API
satya164 Jul 11, 2024
e0c8b3b
Update to RC versions for Snack
satya164 Jul 11, 2024
08b505f
Tweak screen docs
satya164 Jul 11, 2024
77d217c
Update to RC versions for Snack
satya164 Jul 11, 2024
de04713
Update fixed RC versions for Snack
satya164 Jul 12, 2024
7f13def
Update instructions for importing gesture handler
satya164 Jul 14, 2024
2b97cde
Update drawer layout docs
satya164 Jul 24, 2024
e210771
Minor tweak
satya164 Jul 24, 2024
ba9c4d3
Update TS guide for custom navigators in v7
satya164 Jul 25, 2024
2ae17a2
Tweak headings for hello-react-navigation
satya164 Jul 28, 2024
434fa73
Add installation of elements to fundamentals
satya164 Jul 28, 2024
537c94a
Add highlights in navigating guide
satya164 Jul 28, 2024
39d98e4
Revamp web support docs
satya164 Jul 28, 2024
6e6901e
Fix typo
satya164 Jul 28, 2024
1e12308
Shorten what should be in params docs
satya164 Jul 28, 2024
8fb73d0
Fix some grammatical issues
satya164 Jul 29, 2024
5084392
Document lazy-loading screens for web
satya164 Jul 29, 2024
52b9187
Center content on larger screens
satya164 Dec 22, 2023
089468d
Shorten sidebar labels
satya164 Jul 30, 2024
21b2d49
Tweak shadows for images and videos
satya164 Jul 31, 2024
30afd1c
Fix alignment for side by side videos
satya164 Aug 1, 2024
bb66506
chore: Added sample animation videos - Native Stack (#1350)
stanleyoos Aug 1, 2024
d1393ff
chore: Native Stack doc's - animationTypeForReplace (#1351)
stanleyoos Aug 2, 2024
cd5fe4b
Add some links for next-steps
satya164 Aug 4, 2024
89cc4b8
chore: Native Stack doc's - headerBackButtonMenuEnabled (#1352)
stanleyoos Aug 5, 2024
90f12bb
Document headerBackButtonDisplayMode
satya164 Aug 5, 2024
a0a897d
chore(docs): Added screenshots for headerSearchBarOptions (#1355)
stanleyoos Aug 6, 2024
971d34f
docs: Native Stack - presentation (#1354)
stanleyoos Aug 6, 2024
19d103b
docs: Drawer v7. (#1356)
stanleyoos Aug 6, 2024
bb7ba79
Fetch package versions during build
satya164 Aug 6, 2024
a0cb421
Automatically detect React Navigation version for examples (#1358)
satya164 Aug 6, 2024
c5a44ea
Tweak tab and toc styling
satya164 Aug 6, 2024
4456de9
Update typescript config docs
satya164 Aug 7, 2024
6d31135
Tweak heading styles
satya164 Aug 7, 2024
377f5cf
Remove note about react-native link since the command is removed
satya164 Aug 7, 2024
ecc8b59
docs: Bottom Tabs v7 (#1357)
stanleyoos Aug 7, 2024
6aa24b6
Update stack-actions.js (#1239)
DomiR Aug 7, 2024
5ce5799
Redesign the navbar
satya164 Aug 7, 2024
5be51ce
Avoid full page reload on getting started link
satya164 Aug 8, 2024
9e2af9d
Remove redundant links from footer
satya164 Aug 8, 2024
ad68300
Use .footer to avoid targeting other usage of footer
satya164 Aug 8, 2024
b933c27
Tweak spacing in navbar
satya164 Aug 8, 2024
15fe98b
Center navbar logo in mobile view
satya164 Aug 8, 2024
b941405
docs: fixed android association documentation link in versioned_docs …
grnsmn Aug 8, 2024
034abb4
Typo Fixed. (#1295)
DawitMengistu Aug 8, 2024
0ebb14b
Fix screen-options.md typo (#1341)
crisanmm Aug 8, 2024
0f17df7
Update limitations.md (#1342)
CodeByRahulSaini Aug 8, 2024
77c3617
Update upgrading-from-6.x.md (minor typo) (#1343)
robwalkerco Aug 8, 2024
262034d
Fix Typo - handling-safe-area.md (#1274)
SadmanYasar Aug 8, 2024
d6e9452
Revert "Typo Fixed. (#1295)" (#1365)
stanleyoos Aug 8, 2024
a817790
Update stack-navigator.md (#1254)
kazuma0129 Aug 8, 2024
43c6bdf
docs: fix type in library name (#1344)
michalzuk Aug 8, 2024
7b313e5
Update 'verifying Android App Links' link (#1300)
henrikgs Aug 8, 2024
61251f6
docs: Native Stack - header options (#1353)
stanleyoos Aug 8, 2024
b72d18b
Fix navigation.replace documents (#1235)
bouzuya Aug 8, 2024
821c36f
Document new headerSearchBarOptions
satya164 Aug 8, 2024
51e56e1
Tweak sidebar separators
satya164 Aug 8, 2024
d34e098
Sync TOC with visible headings
satya164 Aug 9, 2024
3cd824e
Enable format on save for VSCode
satya164 Aug 9, 2024
107c0c1
Document navigateDeprecated
satya164 Aug 9, 2024
db2a8e8
Remove redundant tab and drawer navigation guides
satya164 Aug 9, 2024
ee9ab9e
Add ability specify tabs in codeblock metadata
satya164 Aug 9, 2024
5c18f45
Update custom tab bar example
satya164 Aug 9, 2024
6d92d6d
Move footer to homepage only
satya164 Aug 9, 2024
960db8e
Increase content width
satya164 Aug 9, 2024
41db2b0
docs: Fixed typo in v7 (#1364)
stanleyoos Aug 12, 2024
df3cb49
docs: Fixed swapped button titles (#1361)
stanleyoos Aug 12, 2024
cef7a66
Update custom navigator section in upgrade guide
satya164 Aug 15, 2024
1af2f52
docs: add links in Configuring TypeScript section (#1368)
stanleyoos Aug 28, 2024
b3e51d9
docs: Updated references to React documentation (#1362)
stanleyoos Aug 28, 2024
f1d9266
Tweak description for direction prop
satya164 Aug 28, 2024
c65db83
Cache version info for offline work
satya164 Aug 29, 2024
11192c4
Add an example for direction prop
satya164 Aug 29, 2024
50dd512
Respect user's preferred color scheme (#1375)
xoyseau Oct 10, 2024
069f1d3
Document that native-stack now supports preload
satya164 Oct 11, 2024
6bcecd1
Document updated Expo Go requirement
satya164 Oct 11, 2024
6c92221
Mention React Native Paper
satya164 Oct 22, 2024
7b71b70
Document logger devtool
satya164 Oct 27, 2024
7b0b03f
Mention screens 4 requirement in upgrade guide
satya164 Oct 27, 2024
5782814
Fix typo in `configuring-links.md` (#1377)
szymonrybczak Oct 30, 2024
d535cfa
Document sceneContainerStyle removal
satya164 Oct 31, 2024
ed54793
Update docs for tab view
satya164 Nov 2, 2024
b8c5da2
Add react-native-bottom-tabs to community libraries (#1376)
okwasniewski Nov 4, 2024
f7e52d9
mark 7.x as stable (#1380)
satya164 Nov 6, 2024
162aeeb
fix links in blog post
satya164 Nov 6, 2024
009f923
Document ESM changes in upgrade guide
satya164 Nov 7, 2024
ff7dfc5
Fix tab view changes in upgrade guide
satya164 Nov 7, 2024
836e512
fix typo
satya164 Nov 7, 2024
baef4a6
Docusaurus 3.6.1 (#1381)
slorber Nov 8, 2024
1c66c4b
Upgrade dependencies (#1382)
satya164 Nov 8, 2024
8b8b073
Temporarily downgrade rspack to workaround broken live reload
satya164 Nov 13, 2024
ae7c592
Note that route object contains pure functions
satya164 Nov 13, 2024
92e668e
Update troubleshooting guide
satya164 Nov 14, 2024
01b9a1a
Update native-stack docs
satya164 Nov 14, 2024
0a7bf61
Fix outdated info about navigate
satya164 Nov 14, 2024
48b5ea1
Replace removed `labelVisible` with `displayMode`. (#1384)
KirillTregubov Nov 15, 2024
601474f
Update drawerType from drawer-layout
satya164 Nov 18, 2024
a8749db
Document search bar ref
satya164 Nov 19, 2024
5a63b03
docs: Removed duplicate code from auth-flow example (#1369)
vijaygojiya Nov 22, 2024
46100a5
Move tip to correct position in auth flow
satya164 Nov 22, 2024
c5d548d
Upgrade react navigation in playground
satya164 Nov 22, 2024
5045ce8
Fix broken anchor links
satya164 Nov 22, 2024
5aa07dc
Fix incorrect docs for sceneStyle
satya164 Nov 22, 2024
0022113
Remove unsupported legacy implementation prop from examples
satya164 Nov 22, 2024
3fb07cd
Add ability to trigger deploy job manually
satya164 Nov 25, 2024
84334ca
Add note about TypeScript regarding ESM
satya164 Nov 25, 2024
c8feb2f
Document merge argument for navigate and popTo
satya164 Nov 26, 2024
f3d3432
Remove tabBarIconStyle from material-top-tab-navigator options (#1387)
imranbarbhuiya Nov 26, 2024
3504693
Fix typo. Closes #1379
satya164 Nov 26, 2024
7c681a9
Update TS guide
satya164 Nov 28, 2024
01c6965
Move labelStyle to options
satya164 Nov 28, 2024
2249bf8
Clarify headerBackground with headerStyle
satya164 Nov 28, 2024
30a479e
Document regular expressions in linking config
satya164 Dec 1, 2024
7520267
Document starter template
satya164 Dec 1, 2024
256ae25
Document path alias in linking
satya164 Dec 2, 2024
3ce61b8
Tweak the home page
satya164 Dec 4, 2024
a757d3a
Update starter template command
satya164 Dec 5, 2024
48a6b03
Add note about material bottom tabs
satya164 Dec 5, 2024
fdbf5d6
Document configureGestureHandler
satya164 Dec 7, 2024
db23292
Add warning about accessing route.params.screen
satya164 Dec 11, 2024
f1ab2bc
Fix popTo description
satya164 Mar 5, 2025
701c32b
Update docs for layout
satya164 Mar 5, 2025
b827231
Add blog post about Native Bottom Tabs (#1398)
okwasniewski Mar 9, 2025
191765f
Document formSheet props and limitiations (#1402)
kligarski Mar 9, 2025
2be4a98
Clarify formSheet flex limitations (#1416)
kligarski Mar 14, 2025
d966834
Fix typo in auth-flow.md (#1415)
mchisolm0 Mar 14, 2025
779730c
Fix syntax error in tabBarPosition example (#1414)
bkeepers Mar 14, 2025
549835a
Update custom-navigators.md : Add missing variable (#1412)
ahmed-khlifi Mar 14, 2025
1aaef1a
Fix description for headerMode
satya164 Mar 14, 2025
7fc4ebc
Update testing guide (#1404)
kligarski Mar 15, 2025
b3664ea
Correctly place autoVerify in VIEW intent-filter (#1400)
ncdai Mar 15, 2025
10b4e56
Update safe area docs
satya164 Mar 15, 2025
53a0b08
Update docs for getId
satya164 Mar 19, 2025
ae75bde
Document the pop option for navigate
satya164 Mar 19, 2025
c4a40e5
Add a warning about getId with native stack
satya164 Mar 19, 2025
b71a65b
Fix typo in title
satya164 Mar 21, 2025
13acc21
Tweak what should be in params
satya164 Mar 24, 2025
cff44bd
Document that state is now frozen
satya164 Mar 25, 2025
ee79889
Make not in beforeRemove section a wanrning
satya164 Mar 27, 2025
4214c6d
Update docs about headerBackButtonDisplayMode and headerBackTitle (#1…
maciekstosio Apr 1, 2025
7e1370b
Document useRoutePath hook
satya164 Apr 1, 2025
0d93eab
Document ready event on the ref
satya164 Apr 3, 2025
74ecfeb
Update TypeScript docs to include moduleResolution: bundler
satya164 Apr 6, 2025
d0714af
Use example instead of mychat
satya164 Apr 6, 2025
41b3d34
Fix wording
satya164 Apr 6, 2025
fa78c92
Update jest configuration for React Navigation
satya164 Apr 8, 2025
90bbf5c
docs: add deprecation message to some status/navigation bar related p…
kligarski Apr 9, 2025
4a09d1d
Fix `:::warning` syntax in server-rendering docs (#1423)
hehex9 Apr 17, 2025
66b5ec1
Update docs after changes to headerBackTitle (#1422)
maciekstosio Apr 17, 2025
c365013
Fix typo in import
satya164 Apr 21, 2025
277e90e
Improve authentication flow docs (#1419)
VimDiesel123 Apr 24, 2025
3c79864
Improve testing guide
satya164 Apr 24, 2025
44d9a5d
Tweak custom navigator docs
satya164 Apr 24, 2025
92ebfe5
Update links in getting started
satya164 Apr 24, 2025
5700111
Update upgrade guide for tab view
satya164 May 6, 2025
a5d501a
Add migration instructions for unmountOnBlur
satya164 May 6, 2025
60212e4
Truncate native bottom tabs post
satya164 May 6, 2025
3a79b33
Fix persistence example for static config
satya164 May 28, 2025
a1f1137
docs: add missing status bar docs (#1432)
kligarski May 30, 2025
136ce31
Document backBehavior: fullHistory
satya164 May 30, 2025
b466bfd
Document navigation.replaceParams and CommonActions.replaceParams
satya164 May 30, 2025
a72b2eb
chore(github): comment out notational pieces of PR template (#1431)
agilgur5 Jun 3, 2025
8f38c18
fix(contrib): remove duplicated links (#1430)
agilgur5 Jun 3, 2025
f56761a
fix(contrib): update links to Issue & PR templates (#1429)
agilgur5 Jun 3, 2025
1ab0349
Fix typescript docs for custom navigators
satya164 Jun 4, 2025
d80708a
Mention backBehavior: fullHistory on web docs
satya164 Jun 7, 2025
cfb683e
Document reserved param names
satya164 Jun 11, 2025
1ac14ce
Improve lifecycle docs
satya164 Jun 15, 2025
ea5bcae
Add links to summaries
satya164 Jun 15, 2025
585978d
Remove now-unnecessary gesture handler import
satya164 Jun 16, 2025
2aa5edb
Improve custom navigator docs
satya164 Jun 17, 2025
b5947fa
Update getting started guide
satya164 Jun 24, 2025
827c1f7
Improve docs for navigator-specific types
satya164 Jun 24, 2025
9df6dea
Improve docs for stale state
satya164 Jun 25, 2025
55ea79c
Update sponsors list
satya164 Jul 10, 2025
9da5746
Tweak styling for tabs with single codeblock
satya164 Jul 27, 2025
6360558
Add Swift AppDelegate setup instructions for deep linking (#1428)
kleviss Jul 27, 2025
17108e2
Add instructions for universal links on Expo
satya164 Jul 27, 2025
fbe71a7
Add a warning about component being rendered for listeners
satya164 Aug 3, 2025
8340865
Update autofix.ci
satya164 Aug 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Document useRoutePath hook
  • Loading branch information
satya164 committed Apr 1, 2025
commit 7e1370b44131b067eb1bc587df2b0251f308035d
4 changes: 2 additions & 2 deletions versioned_docs/version-7.x/use-link-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ title: useLinkBuilder
sidebar_label: useLinkBuilder
---

The `useLinkBuilder` hook returns helpers to build `href` or action based on the linking options. It returns an object with the following properties:
The `useLinkBuilder` hook returns helpers to build `href` or action based on the [`linking` configuration](configuring-links.md). It returns an object with the following properties:

- [`buildHref`](#buildhref)
- [`buildAction`](#buildaction)

## `buildHref`

The `buildHref` method lets us build a path to use for links for a screen in the current navigator's state. It returns a function that takes `name` and `params` for the screen to focus and returns path based on the [`linking` options](navigation-container.md#linking).
The `buildHref` method lets us build a path to use for links for a screen in the current navigator's state. It returns a function that takes `name` and `params` for the screen to focus and returns path based on the [`linking` configuration](configuring-links.md).

```js
import { useLinkBuilder } from '@react-navigation/native';
Expand Down
25 changes: 25 additions & 0 deletions versioned_docs/version-7.x/use-route-path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: use-route-path
title: useRoutePath
sidebar_label: useRoutePath
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The `useRoutePath` hook can be used to get the path of a route based on the [`linking` configuration](configuring-links.md). This can be useful if you need to generate a URL for a specific route in your app to share as a deep link.

## Example

```js
import { useRoutePath } from '@react-navigation/native';

function MyComponent() {
const path = useRoutePath();

// Construct a URL using the path and app's base URL
const url = new URL(path, 'https://example.com');

return <Text>Shareable URL: {url.href}</Text>;
}
```
1 change: 1 addition & 0 deletions versioned_sidebars/version-7.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
"use-focus-effect",
"use-is-focused",
"use-prevent-remove",
"use-route-path",
"use-link-to",
"use-link-props",
"use-link-builder",
Expand Down