Skip to content

Commit df06ae5

Browse files
committed
docs(api): add some extra reference links
1 parent e89ad30 commit df06ae5

File tree

4 files changed

+98
-80
lines changed

4 files changed

+98
-80
lines changed

packages/react-router/lib/components.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,11 @@ export interface MemoryRouterOpts {
144144
*/
145145
basename?: string;
146146
/**
147-
* Function to provide the initial context values for all client side
148-
* navigations/fetches
147+
* A function that returns an {@link unstable_RouterContextProvider} instance
148+
* which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
149+
* [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
150+
* This function is called to generate a fresh `context` instance on each
151+
* navigation or fetcher call.
149152
*/
150153
unstable_getContext?: RouterInit["unstable_getContext"];
151154
/**

packages/react-router/lib/dom/lib.tsx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,10 @@ export interface DOMRouterOpts {
139139
basename?: string;
140140
/**
141141
* A function that returns an {@link unstable_RouterContextProvider} instance
142-
* which is provided as the `context` argument to client
143-
* [`action`](../../start/data/route-object#action)s,
144-
* [`loader`](../../start/data/route-object#loader)s and
145-
* [`middleware`](../../how-to/middleware)s. This function is called to
146-
* generate a fresh `context` instance on each navigation or fetcher call.
142+
* which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
143+
* [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
144+
* This function is called to generate a fresh `context` instance on each
145+
* navigation or fetcher call.
147146
*/
148147
unstable_getContext?: RouterInit["unstable_getContext"];
149148
/**
@@ -175,15 +174,16 @@ export interface DOMRouterOpts {
175174
* [`clientLoader`](../../start/framework/route-module#clientLoader)), you may
176175
* want to include `loaderData` for only some routes that were loaded/rendered
177176
* on the server. This allows you to hydrate _some_ of the routes (such as the
178-
* app layout/shell) while showing a `HydrateFallback`
179-
* component and running the [`loader`](../../start/data/route-object#loader)s
180-
* for other routes during hydration.
177+
* app layout/shell) while showing a `HydrateFallback` component and running
178+
* the [`loader`](../../start/data/route-object#loader)s for other routes
179+
* during hydration.
181180
*
182181
* A route [`loader`](../../start/data/route-object#loader) will run during
183182
* hydration in two scenarios:
184183
*
185184
* 1. No hydration data is provided
186-
* In these cases the `HydrateFallback` component will render on initial hydration
185+
* In these cases the `HydrateFallback` component will render on initial
186+
* hydration
187187
* 2. The `loader.hydrate` property is set to `true`
188188
* This allows you to run the [`loader`](../../start/data/route-object#loader)
189189
* even if you did not render a fallback on initial hydration (i.e., to
@@ -245,8 +245,8 @@ export interface DOMRouterOpts {
245245
*
246246
* The `dataStrategy` function should return a key/value-object of
247247
* `routeId` -> {@link DataStrategyResult} and should include entries for any
248-
* routes where a handler was executed. A `DataStrategyResult` indicates
249-
* if the handler was successful or not based on the `DataStrategyResult.type`
248+
* routes where a handler was executed. A `DataStrategyResult` indicates if
249+
* the handler was successful or not based on the `DataStrategyResult.type`
250250
* field. If the returned `DataStrategyResult.result` is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
251251
* React Router will unwrap it for you (via [`res.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json)
252252
* or [`res.text`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text)).
@@ -440,11 +440,11 @@ export interface DOMRouterOpts {
440440
* user visited.
441441
*
442442
* `patchRoutesOnNavigation` will be called anytime React Router is unable to
443-
* match a `path`. The arguments include the `path`, any partial
444-
* `matches`, and a `patch` function you can call to patch
445-
* new routes into the tree at a specific location. This method is executed
446-
* during the `loading` portion of the navigation for `GET` requests and during
447-
* the `submitting` portion of the navigation for non-`GET` requests.
443+
* match a `path`. The arguments include the `path`, any partial `matches`,
444+
* and a `patch` function you can call to patch new routes into the tree at a
445+
* specific location. This method is executed during the `loading` portion of
446+
* the navigation for `GET` requests and during the `submitting` portion of
447+
* the navigation for non-`GET` requests.
448448
*
449449
* <details>
450450
* <summary><b>Example <code>patchRoutesOnNavigation</code> Use Cases</b></summary>
@@ -1966,7 +1966,7 @@ export type ScrollRestorationProps = ScriptsProps & {
19661966
* @mode data
19671967
* @param props Props
19681968
* @param {ScrollRestorationProps.getKey} props.getKey n/a
1969-
* @param {ScriptsProps.nonce} props.nonce n/a
1969+
* @param {ScrollRestorationProps.nonce} props.nonce n/a
19701970
* @param {ScrollRestorationProps.storageKey} props.storageKey n/a
19711971
* @returns A [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script)
19721972
* tag that restores scroll positions on navigation.

0 commit comments

Comments
 (0)