0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
Commit graph

17 commits

Author SHA1 Message Date
Roberto De Lucia
70df20a53c
feat(react-router): add support for ViewTransition types (#2862)
Co-authored-by: Roberto De Lucia <roberto.delucia@sinnefo.eu>
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-11-28 09:43:35 +13:00
Manuel Schiller
8d56157b07
feat(react-router): add stripSearchParams middleware (#2579) 2024-10-18 22:33:18 +02:00
Christopher Horobin
f48dd37b35
feat: add linkOptions for re-usable props (#2486)
* feat: add `linkOptions` for re-usable props

* chore: change examples

* docs: add docs for `linkOptions`

* tests: add type tests for `linkOptions`

* chore: fix spelling

* chore: update docs and make `const`
2024-10-07 23:22:47 +02:00
Sean Cassiere
03b05999c5
docs: cleanup the Reference API page having the hooks being suffixed with (.md) (#2038) 2024-07-27 14:39:58 +12:00
Sean Cassiere
b5eabe19f5
docs: native markdown relative hyperlinks (#1998)
* docs: reference docs

* docs: guides

* docs: top-level

* docs: missed the route-trees

* docs: fixing routing-concepts
2024-07-20 18:23:45 +12:00
Leonardo Montini
28aa8fb04e
feat(react-router): improve the blocker functionality for use with custom UI (#1649)
* feat: return async resolver from useBlocker hook

* feat: pass async resolvers to children on Block component

* fix: types and always reset promise

* docs: update example with custom UI

* refactor: namings

* docs: toggle between custom ui and default

* feat: expose status and refactor hook props

* feat: support current API

* feat: custom blocker should take precendence over the manual promise blocker

* test: unit test on condition to avoid breaking changes with the new API

* docs: deprecate old syntax and update the docs

* docs: create useBlocker API reference

* fix: deprecated interface
2024-05-25 13:49:08 +02:00
Sean Cassiere
ab02f3ebd3
docs: moving reference content out of the class files (#1633)
* RouterType

* RouteApiType

* RouteType

* ParsedLocation linking

* linking RouterType, RouteType, and RouteApiType

* reduce SearchParamOptionsType and PathParamOptionsType into ToOptionsType

* useLinkProps

* forgot to remove that

* more
2024-05-19 14:52:44 +12:00
Sean Cassiere
62bf384972
docs: clearing up the internal types from the references (#1627)
* remove AnyParamsType

* remove AnyRedirectType

* AnyRouteMatchType

* AwaitOptionsType

* FileRoutesByPath

* FullSearchSchemaType

* ParseRouteType

* ParseRouteChildrenType

* RegisteredRouterType

* RouteByIdType

* RouteIdsType

* RouteByPath

* RoutePathsType

* RouterErrorSerializerType

* link RouterEventsType

* RouterTransformerType

* RoutesByIdType

* RoutesByPathType

* SearchSchemaInputType

* link to ToOptionsType

* DeferredPromiseStateType
2024-05-19 01:37:49 +12:00
Sal Hasan
2a19b03d6b
feat(react-router): add a useLocation hook to get the current ParsedLocation (#1577) 2024-05-11 14:33:15 +02:00
Tanner Linsley
4ef78725af
docs: prep for migration of tanstack.com to TSR (#1419) 2024-04-02 16:46:22 -06:00
Sean Cassiere
9d099dd755
docs: add reference pages for createLazyFileRoute and createLazyRoute (#1379)
* docs: add createLazyFileRoute

* docs: broken link to the FileRouteClass

* docs: remove the word literal

* docs: update the source of its configuration options

* docs: add createLazyRoute
2024-03-27 21:38:59 +13:00
Sean Cassiere
58a15deb49
docs: add more missing reference pages (#1352)
* docs: add useNavigate to the RouteApiClass

* docs: add the useLoaderDeps hook

* docs: update RouteApi description

* docs: update getRouteApi description

* docs: add the useRouterState hook

* docs: add the useRouter hook

* docs: missing `hook` from title

* docs: add the useRouteContext hook

* docs: add the useSearch hook
2024-03-22 09:01:20 -06:00
Sean Cassiere
e4bc7d7e0a
docs: normalizing the hierarchy content in the reference pages (#1232)
* createFileRoute

* createRootRoute

* createRouteFunction

* createRouteFunction and RouteClass

* defer, awaitComponent, useAwaitedHook

* getRouteApiFunction and RouteApiClass

* isNotFoundFunction

* isRedirectFunction

* lazyRouteComponentFunction

* createRootRouteWithContext

* createRootRouteFunction

* new notFound conventions

* NotFoundRouteClass

* redirectFunction

* RedirectType

* catchBoundaryComponent

* catchNotFoundComponent

* DefaultGlobalNotFound

* useLinkPropsHook

* ActiveLinkOptions

* errorComponentComponent

* linkComponent

* LinkOptionsType

* LinkPropsType

* navigateComponent

* NavigateOptionsType

* outletComponent

* ToOptionsType

* FileRouteClass

* add the word type

* rootRouteWithContextFunction

* matchRouteComponent

* MatchRouteOptionsType

* useChildMatchesHook

* useLinkPropsHook

* UseLinkPropsOptionsType

* useLoaderDataHook

* useMatchesHook

* useMatchHook

* useMatchRouteHook

* UseMatchRouteOptionsType

* useNavigateHook

* useParamsHook

* useParentMatchesHook

* AllParamsType, RegisteredRouterType, RegisterType

* alphabetical sorting

* add link to the RouteMatchType

* useLoaderDataHook

* AnyRouteMatchType

* bulk for types

* consistency in page linking

* remove backticks from heading items that do not wrap inline-code-blocks
2024-03-08 11:37:02 +01:00
Sean Cassiere
b2004cbbdc
docs: fixing some inconsistencies in the guides (#1229)
* fix: `routeTree` into the `createRouter` instance

* fix: switch to `Block/useBlocker` since react-router uses `useBlocker` instead of `Prompt/usePrompt`

* fix: rename RouteApi to getRouteApi and include useLoaderDeps

* feat: indicate `.lazy` suffix and mark deprecation suffixes being phased out

* fix: createRootRouteWithContext - `routeTree` into the `createRouter` instance

* fix: rootRouteWithContext - `routeTree` into the `createRouter` instance

* feat: `Function` keyword is redundant since its already nested under `Functions`

* feat: alphabetical sorting of functions

* feat: move `rootRouteWithContext` to the deprecated list

* feat: use backticks

* feat: alphabetical sorting of hooks
2024-02-27 11:55:10 -07:00
Tanner Linsley
81d8dcdd62 docs: useChildMatches docs 2024-01-29 09:48:48 -07:00
gilbert
dcfd9d7246
feat: new not found APIs (#1048)
* feat: add `notFound`, boundary, and support for routes

* feat: add global not found

* refactor: clean up throw global not found route

* feat: reset not founds on page navigation

* fix: fix duplicate throw global not found

* feat: rework global not found handling and add not-found-ssr example

* feat: update not found ssr example

* fix: fix type in not-found.tsx

* feat: add way to statically render a global not found page

* feat: remove flicker from notFound with SSR

* feat: remove <GlobalNotFound> server api

* feat: add file-based routing and codesplitting for not found component

* feat: add option to trigger not found on specific route

* docs: write docs for `notFound` and `NotFoundError`

* docs: document Route.notFound(opts)

* feat: add deprecation warnings to notFoundRoute

* fix: clean up a few things that went awry during rebase

* fix: fix react-router-server build

* feat: add not-found apis to basic-file-based example

* feat: update basic-ssr-streaming-file-based example to use new not-found apis

* chore: clean up a few things

* docs: write guides for new not found api

* docs: add api documentation for `not-found.tsx`

* feat: add notFoundComponent to lazy loading

* docs: deprecate NotFoundRoute and link to new apis

* fix: remove `.notFoundComponent` suffix in file based routing

* feat: make `route` option of typesafe and compatible with `getRouteApi`
2024-01-27 09:12:54 -07:00
Lachlan Collins
77955ab586
docs: Re-organise for new docs layout (#1081) 2024-01-26 09:43:15 +11:00
Renamed from docs/api/router.md (Browse further)