Skip to content

Commit f3a5947

Browse files
authored
docs(router): list preload as navigation cause value (#4825)
1 parent 87d4ccb commit f3a5947

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/router/framework/react/guide/data-loading.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,10 @@ export const Route = createFileRoute('/posts')({
7171
The `loader` function receives a single object with the following properties:
7272

7373
- `abortController` - The route's abortController. Its signal is cancelled when the route is unloaded or when the Route is no longer relevant and the current invocation of the `loader` function becomes outdated.
74-
- `cause` - The cause of the current route match, either `enter` or `stay`.
74+
- `cause` - The cause of the current route match. Can be either one of the following:
75+
- `enter` - When the route is matched and loaded after not being matched in the previous location.
76+
- `preload` - When the route is being preloaded.
77+
- `stay` - When the route is matched and loaded after being matched in the previous location.
7578
- `context` - The route's context object, which is a merged union of:
7679
- Parent route context
7780
- This route's context as provided by the `beforeLoad` option

0 commit comments

Comments
 (0)