Docs: Add API docs (#460)

* Add API docs

* Update config

docs/api/react/Link.md

@@ -0,0 +1,11 @@
+---
+id: Link
+title: Link
+---
+
+```tsx
+
+
+```
+
+**Options**

docs/api/react/MatchRoute.md

@@ -0,0 +1,10 @@
+---
+id: MatchRoute
+title: MatchRoute
+---
+
+```tsx
+
+```
+
+**Options**

docs/api/react/Outlet.md

@@ -0,0 +1,11 @@
+---
+id: Outlet
+title: Outlet
+---
+
+```tsx
+import { Outlet } from '@tanstack/react-router'
+
+```
+
+**Options**

docs/api/react/Prompt.md

@@ -0,0 +1,10 @@
+---
+id: Prompt
+title: Prompt
+---
+
+```tsx
+
+```
+
+**Options**

docs/api/react/Route.md

@@ -0,0 +1,10 @@
+---
+id: Route
+title: Route
+---
+
+```tsx
+
+```
+
+**Options**

docs/api/react/RouterProvider.md

@@ -0,0 +1,63 @@
+---
+id: RouterProvider
+title: RouterProvider
+---
+
+Use the `RouterProvider` component to connect and provide a `createReactRouter` to your application:
+
+```tsx
+import { RouterProvider, createReactRouter } from '@tanstack/react-router'
+
+const router = new createReactRouter()
+
+function App() {
+  return <RouterProvider router={router}>...</RouterProvider>
+}
+```
+
+**Options**
+- `router: Router`
+  - **Required**
+  - the `createReactRouter` instance to provide
+- `history?: BrowserHistory | MemoryHistory | HashHistory`
+  - **Optional**
+- `stringifySearch?: SearchSerializer`
+  - **Optional**
+- `parseSearch?: SearchParser`
+  - **Optional**
+- `filterRoutes?: FilterRoutesFn`
+  - **Optional**
+- `defaultPreload?: false | 'intent'`
+  - **Optional**
+- `defaultPreloadMaxAge?: number`
+  - **Optional**
+- `defaultPreloadGcMaxAge?: number`
+  - **Optional**
+- `defaultPreloadDelay?: number`
+  - **Optional**
+- `defaultComponent?: GetFrameworkGeneric<'Component'>`
+  - **Optional**
+- `defaultErrorComponent?: GetFrameworkGeneric<'ErrorComponent'>`
+  - **Optional**
+- `defaultPendingComponent?: GetFrameworkGeneric<'Component'>`
+  - **Optional**
+- `defaultLoaderMaxAge?: number`
+  - **Optional**
+- `defaultLoaderGcMaxAge?: number`
+  - **Optional**
+- `caseSensitive?: boolean`
+  - **Optional**
+- `routeConfig?: TRouteConfig`
+  - **Optional**
+- `basepath?: string`
+  - **Optional**
+- `useServerData?: boolean`
+  - **Optional**
+- `createRouter?: (router: Router<any, any, any>) => void`
+  - **Optional**
+- `createRoute?: (opts: { route: AnyRoute, router: Router<any, any, any> }) => void`
+  - **Optional**
+- `context?: TRouterContext`
+  - **Optional**
+- `loadComponent?: (component: GetFrameworkGeneric<'Component'>) => Promise<GetFrameworkGeneric<'Component'>`
+  - **Optional**

docs/api/react/createReactRouter.md

@@ -0,0 +1,19 @@
+---
+id: createReactRouter
+title: createReactRouter
+---
+
+```tsx
+import { createReactRouter } from '@tanstack/react-router'
+
+const router = createReactRouter({
+
+})
+```
+
+**Options**
+- `options: RouterOptions<TRouteConfig, TRouterContext>`
+  - **Required**
+
+**Returns**
+- `router: Router<TRouteConfig, TAllRouteInfo, TRouterContext>`

docs/api/react/createRouteConfig.md

@@ -0,0 +1,17 @@
+---
+id: createRouteConfig
+title: createRouteConfig
+---
+
+```tsx
+import { createRouteConfig } from '@tanstack/react-router'
+
+const router = createRouteConfig()
+```
+
+**Options**
+- `options: RouterOptions<TRouteConfig, TRouterContext>`
+    - **Required**
+
+**Returns**
+- `router: Router<TRouteConfig, TAllRouteInfo, TRouterContext>`

docs/api/react/lazy.md

@@ -0,0 +1,20 @@
+---
+id: lazy
+title: lazy
+---
+
+```tsx
+import { lazy } from '@tanstack/react-router'
+
+export const expensiveRoute = rootRoute.createRoute({
+  path: 'expensive',
+  component: lazy(() => import('./Expensive')),
+})
+```
+
+**Options**
+- `importer: () => Promise<{ default: SyncRouteComponent }>`
+  - **Required**
+
+**Returns**
+- `element: RouteComponent`

docs/api/react/useAction.md

@@ -0,0 +1,17 @@
+---
+id: useAction
+title: useAction
+---
+
+```tsx
+const action = useAction({
+    from
+})
+```
+
+**Options**
+- `from: TFrom`
+  - **Required**
+
+**Returns**
+- `action: Action<TFromRoute['actionPayload'], TFromRoute['actionResponse']>`

docs/api/react/useLinkProps.md

@@ -0,0 +1,13 @@
+---
+id: useLinkProps
+title: useLinkProps
+---
+
+```tsx
+const linkProps = useLinkProps(options)
+```
+
+**Options**
+
+**Returns**
+- `linkProps: React.AnchorHTMLAttributes<HTMLAnchorElement>`

docs/api/react/useLoaderData.md

@@ -0,0 +1,23 @@
+---
+id: useLoaderData
+title: useLoaderData
+---
+
+```tsx
+const data = useLoaderData({
+  from,
+  strict,
+  select
+})
+```
+
+**Options**
+- `from: TFrom`
+  - **Required**
+- `strict?: TStrict`
+  - **Optional**
+- `select?: (loaderData: TLoaderData) => TSelected`
+  - **Optional**
+
+**Returns**
+- `data: TStrict extends true ? TSelected : TSelected | undefined`

docs/api/react/useMatch.md

@@ -0,0 +1,20 @@
+---
+id: useMatch
+title: useMatch
+---
+
+```tsx
+const match = useMatch({
+  from,
+  strict
+})
+```
+
+**Options**
+- `from: TFrom`
+  - **Required**
+- `strict?: TStrict`
+  - **Optional**
+
+**Returns**
+- `match: TStrict extends true ? TRouteMatch : TRouteMatch | undefined`

docs/api/react/useMatchRoute.md

@@ -0,0 +1,12 @@
+---
+id: useMatchRoute
+title: useMatchRoute
+---
+
+```tsx
+const matchRoute = useMatchRoute()
+```
+
+**Options**
+
+**Returns**

docs/api/react/useNavigate.md

@@ -0,0 +1,16 @@
+---
+id: useNavigate
+title: useNavigate
+---
+
+```tsx
+const navigate = useNavigate({
+    from
+})
+```
+
+**Options**
+- `from?: TDefaultFrom`
+  - **Optional**
+
+**Returns**

docs/api/react/useParams.md

@@ -0,0 +1,20 @@
+---
+id: useParams
+title: useParams
+---
+
+```tsx
+const params = useParams({
+  from,
+  select
+})
+```
+
+**Options**
+- `from: TFrom`
+  - **Required**
+- `select?: (search: TDefaultSelected) => TSelected`
+  - **Optional**
+
+**Returns**
+- `params: TSelected`

docs/api/react/usePrompt.md

@@ -0,0 +1,14 @@
+---
+id: usePrompt
+title: usePrompt
+---
+
+```tsx
+usePrompt(message, when)
+```
+
+**Options**
+- `message: string`
+  - **Required**
+- `when: boolean | any`
+  - **Required**

docs/api/react/useRoute.md

@@ -0,0 +1,15 @@
+---
+id: useRoute
+title: useRoute
+---
+
+```tsx
+const route = useRoute(routeId)
+```
+
+**Options**
+- `routeId: TId`
+  - **Required**
+
+**Returns**
+- `route: Route<RegisteredAllRouteInfo, RegisteredAllRouteInfo['routeInfoById'][TId]>`

docs/api/react/useRouter.md

@@ -0,0 +1,11 @@
+---
+id: useRouter
+title: useRouter
+---
+
+```tsx
+const router = useRouter()
+```
+
+**Returns**
+- `router: RegisteredRouter`

docs/api/react/useRouterStore.md

@@ -0,0 +1,18 @@
+---
+id: useRouterStore
+title: useRouterStore
+---
+
+```tsx
+const routerStore = useRouterStore({
+    selector
+})
+```
+
+**Options**
+- `selector?: (state: Router['store']) => T`
+  - **Optional**
+
+**Returns**
+- `routerStore?`
+  - **Optional**

docs/api/react/useSearch.md

@@ -0,0 +1,23 @@
+---
+id: useSearch
+title: useSearch
+---
+
+```tsx
+const search = useSearch({
+    from,
+    strict,
+    select
+})
+```
+
+**Options**
+- `from: TFrom`
+  - **Required**
+- `strict?: TStrict`
+  - **Optional**
+- `select?: (search: TSearch) => TSelected`
+  - **Optional**
+
+**Returns**
+- `search: TSelected | undefined`