Skip to content

Commit 41f410a

Browse files
docs: improve Form component's discovery description (#14626)
* docs: improve Form component's discovery description * Add cross-links --------- Co-authored-by: Matt Brophy <[email protected]>
1 parent 860be25 commit 41f410a

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,16 +1038,16 @@ HistoryRouter.displayName = "unstable_HistoryRouter";
10381038
export interface LinkProps
10391039
extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "href"> {
10401040
/**
1041-
* Defines the link discovery behavior
1041+
* Defines the link [lazy route discovery](../../explanation/lazy-route-discovery) behavior.
1042+
*
1043+
* - **render** — default, discover the route when the link renders
1044+
* - **none** — don't eagerly discover, only discover if the link is clicked
10421045
*
10431046
* ```tsx
10441047
* <Link /> // default ("render")
10451048
* <Link discover="render" />
10461049
* <Link discover="none" />
10471050
* ```
1048-
*
1049-
* - **render** — default, discover the route when the link renders
1050-
* - **none** — don't eagerly discover, only discover if the link is clicked
10511051
*/
10521052
discover?: DiscoverBehavior;
10531053

@@ -1717,16 +1717,16 @@ export interface FetcherFormProps extends SharedFormProps {}
17171717
*/
17181718
export interface FormProps extends SharedFormProps {
17191719
/**
1720-
* Defines the link discovery behavior. See {@link DiscoverBehavior}.
1720+
* Defines the form [lazy route discovery](../../explanation/lazy-route-discovery) behavior.
1721+
*
1722+
* - **render** — default, discover the route when the form renders
1723+
* - **none** — don't eagerly discover, only discover if the form is submitted
17211724
*
17221725
* ```tsx
1723-
* <Link /> // default ("render")
1724-
* <Link discover="render" />
1725-
* <Link discover="none" />
1726+
* <Form /> // default ("render")
1727+
* <Form discover="render" />
1728+
* <Form discover="none" />
17261729
* ```
1727-
*
1728-
* - **render** — default, discover the route when the link renders
1729-
* - **none** — don't eagerly discover, only discover if the link is clicked
17301730
*/
17311731
discover?: DiscoverBehavior;
17321732

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ export function useFrameworkContext(): FrameworkContextObject {
7676
// Public API
7777

7878
/**
79-
* Defines the discovery behavior of the link:
79+
* Defines the [lazy route discovery](../../explanation/lazy-route-discovery)
80+
* behavior of the link/form:
8081
*
8182
* - "render" - default, discover the route when the link renders
8283
* - "none" - don't eagerly discover, only discover if the link is clicked

0 commit comments

Comments
 (0)