From c5e6e43625c03f088220d5b71c4083be7afc0229 Mon Sep 17 00:00:00 2001
From: "Amir H. Hashemi" <87268103+amirhhashemi@users.noreply.github.com>
Date: Fri, 2 Jan 2026 17:32:40 +0330
Subject: [PATCH] Update `usePreloadRoute` reference page
---
.../primitives/use-preload-route.mdx | 74 ++++++++++++++-----
1 file changed, 57 insertions(+), 17 deletions(-)
diff --git a/src/routes/solid-router/reference/primitives/use-preload-route.mdx b/src/routes/solid-router/reference/primitives/use-preload-route.mdx
index 202cd455f3..30192ede23 100644
--- a/src/routes/solid-router/reference/primitives/use-preload-route.mdx
+++ b/src/routes/solid-router/reference/primitives/use-preload-route.mdx
@@ -9,36 +9,76 @@ tags:
- optimization
- prefetch
- manual
-version: '1.0'
+version: "1.0"
description: >-
Manually preload routes with usePreloadRoute - optimize performance by
prefetching route data before navigation in your SolidJS app.
---
-`usePreloadRoute` returns a function that can be used to preload a route manually.
+The `usePreloadRoute` function is a utility for manually preloading a route.
+
+## Import
```ts
-const preload = usePreloadRoute();
+import { usePreloadRoute } from "@solidjs/router";
+```
+
+## Type
-preload(`/users/settings`, { preloadData: true });
+```ts
+const usePreloadRoute: () => (
+ url: string | URL,
+ options?: { preloadData?: boolean }
+) => void;
```
-## Usage
+## Parameters
+
+### `url`
+
+**Type:** `string | URL`
+**Required:** Yes
+
+The route path to preload.
+Accepts either a `string` path or a [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) object.
+
+### `options`
+
+- **Type:** `{ preloadData?: boolean }`
+- **Required:** No
-Routes are preloaded by default within Solid Router contexts.
-This helper is useful when you want to preload a route in response to some other event, such as a button click or a timer.
+A configuration object with the following properties:
-## Type Signature
+#### `preloadData`
-### Parameters
+- **Type:** `boolean`
+- **Default:** `false`
-| Parameter | Type | Required | Description |
-| --------- | -------- | -------- | ------------------------------------ |
-| `to` | `To` | Yes | The route path to preload |
-| `options` | `object` | No | Configuration options for preloading |
+When `true`, triggers the route's data loading in addition to preloading the route itself.
+
+## Return value
+
+None.
+
+## Examples
+
+### Basic usage
+
+```tsx
+import { usePreloadRoute } from "@solidjs/router";
+
+function SettingsButton() {
+ const preload = usePreloadRoute();
+
+ return (
+
+ );
+}
+```
-### Options
+## Related
-| Option | Type | Default | Description |
-| ------------- | --------- | ------- | ------------------------------------------------------------------- |
-| `preloadData` | `boolean` | `false` | Whether to preload the route's data in addition to the route itself |
+- [``](/solid-router/reference/components/a)
+- [`preload`](/solid-router/reference/preload-functions/preload)