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

1,257 commits

Author SHA1 Message Date
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
c15f399e79
feat(router-generator): add option to format with semicolons in the generated route-tree (#1376)
* feat(router-generator): expose config to accept `semicolons` prop to prettier format with semicolons

* docs(router-generator): document the new `semicolons` configuration property
2024-03-27 05:54:07 +01:00
Valeriy Kobzar
9181cad9d7
docs: fix incorrect naming of parameters on the guide for not-found-errors (#1377)
Fixed a bug in the parameter name for the notFound function. Instead of 'route', it should use 'routeId'.
2024-03-27 17:16:05 +13:00
Dominik Dorfmeister
4972e945c5
ci: execute type checks against multiple TS versions (#1367)
* fix: peerDependencies

* docs: requirements

* ci: run type tests against multiple TS versions

* chore: newline

* chore: fix prettier

* fix: wrappers must return a JSX Element

* fix: have Explorer return JSX.Element

* fix: another one
2024-03-26 10:12:00 +01:00
Sean Cassiere
7d8b9e0b9c
docs: fixing the syntactically broken links within the documentation (#1369)
* docs: broken link linking to the SSR guide

* docs: broken link linking to the `RouterOptionsType#transformer-property`

* docs: fix broken link linking to code-splitting

* docs: fix broken link linking to the `RouterOptionsType`

* docs: fix broken link linking to external-data-loading
2024-03-26 10:44:17 +13:00
Sean Cassiere
cf5d136aa4
docs: include "layout" next to pathless routes and move "routing concepts" to its own page (#1362)
* docs: include layout as part of the pathless routes section

* docs: add links to the individual sections below

* docs: links for the route nesting stuff

* docs: move the routing concepts section to separate page
2024-03-26 09:45:55 +13:00
Leonardo Montini
59bb2604f2
docs: remove __404 mentions (#1341) 2024-03-25 16:34:49 +01:00
Sean Cassiere
876b887589
docs: remove references to @tanstack/loaders (#1357)
* docs: remove tanstack loaders in the navigation doc

* docs: remove tanstack loaders in the external-data-loading doc
2024-03-23 17:28:41 +01:00
Manuel Schiller
9687ebd90a
fix: loosen strict check in useMatch to allow accessing parent matches (#1356) 2024-03-22 23:52:27 +01: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
GoldFrosch
03f82c6bb2
feat: add routeFileIgnorePattern option to generator (#1310) 2024-03-15 12:17:07 +01:00
Rui Saraiva
89bacc3341
docs: fix TanStack & TypeScript typos (#1291)
* docs: fix TanStack & TypeScript typos

* docs: fix TanStack & TypeScript typos

---------

Co-authored-by: Rui Saraiva <ruisaraiva@mbp-14.lan>
2024-03-12 22:41:15 +01:00
Efstratios Bektasiadis
74f570832e
docs: fixed broken authenticated routes example url (#1298) 2024-03-12 21:17:58 +01:00
Doug Richar
7b2b155d43
docs: fix router.invalidate() example in Data Mutations guide (#1299) 2024-03-12 21:16:40 +01:00
Lachlan Collins
7995d0a123
docs: Update docs/config.json (#1294)
* docs: Update docs/config.json

* Update schema
2024-03-12 20:42:45 +11:00
Sekamatte Soul Solomon
2094ca89c8
docs: Update decisions-on-dx.md (#1288)
Fix: Grammatical errors in docs
2024-03-11 17:38:54 +01:00
Nils Hartmann
734970aacc
docs: fix useMatchHook (#1282)
- options argument is not optional
- clarify opts.from/opts.strict dependency
2024-03-09 16:21:58 +01:00
Manuel Schiller
409b06dbb7 chore: fix doc formatting 2024-03-09 11:57:34 +01: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
Seedy
4e78898280
docs: Update scroll-restoration.md (#1270) 2024-03-07 21:13:07 +01:00
Alejandra
2600d771f2
docs: Update authenticated-routes.md (#1267) 2024-03-06 21:27:13 +01:00
Alejandra
4422ed294c
focs: fix typos in route-trees.md (#1266)
* fix: minor typo in `route-trees.md`

* Update route-trees.md

* Update route-trees.md

* Update route-trees.md
2024-03-05 21:36:30 +01:00
Norbert Elter
1a95d98250
feat: optionally allow to disable logging in generator (#1256)
* feat: disableLogging

* feat: logging util
2024-03-04 21:34:03 +01:00
Tanner Linsley
3b559fc931
fix: ssr improvements (#1248)
* fix: ssr improvements

* fix: remove log

* fix: remove log

* fix: remove comments

* docs: root abstraction

* fix: remove commented code

* fix: remove old TLoaderData fix attempt

* fix: remove commented code

* fix: imports

* docs: format

* fix: deprecate and handle not found "global" option
2024-03-04 11:23:41 -07:00
Yiheng
1a37474f84
docs: Update file-based-routing.md (#1257)
* Update file-based-routing.md

* Update file-based-routing.md
2024-03-04 11:20:59 +01:00
Abdullah_Aleiti
aa3da31925
docs: Fix route-trees.md to use appropriate article. (#1254) 2024-03-03 19:54:13 +01:00
Pawel Fajfer
73fc10b195
docs: make loader function async in deferred-data-loading guide (#1258) 2024-03-03 19:50:11 +01:00
Manuel Schiller
419cb45975
fix: correct typing for route groups (#1245)
since we need to handle the path replacements in typescript as well, we cannot let the user configure the route group pattern
2024-03-01 14:58:31 -07:00
Manuel Schiller
7731a3926b
feat: add route grouping for file based routing (#1241) 2024-03-01 11:04:21 -07:00
Tomasz Wysocki
69072fd545
docs: fix links in Decisions on DX page (#1236) 2024-02-29 18:47:53 -07:00
Sean Cassiere
135b76453d
docs: fix queryKey to be compliant with the current tanstack-query v5 syntax (#1228)
* docs: fix `queryKey` to match the tanstack-query v5 syntax

* docs: actually call the `fetchPosts` fn
2024-02-29 18:47:24 -07:00
Makisuo
6b2d7ff28f
docs: fix context loader example (#1235) 2024-02-29 17:33:55 +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
Boda
07bb8d2b16
docs: Update code-splitting.md (#1210) 2024-02-27 19:32:27 +01:00
Sean Cassiere
bf26037663
docs: new doc page on the dx design decisions (#1225)
* chore: initial set up to display the new docs page

* docs: introduction to the dx doc

* docs: how its done to the dx doc

* docs: rework the intro for the dx doc

* docs: some gramatical fixes

* docs: checkpoint

* docs: two big parts are done

* docs: some cleanup

* docs: the spacing stuff

* docs: more cleanup

* docs: ...

* docs: code-based routing section

* docs: file-based routing section

* docs: rename doc to "Decisions on DX"

* docs: add a TLDR since people are people and wont read all of this
2024-02-26 04:20:46 -07:00
Nikola Hristov
0fab06123b
fix: replace JSX.Element with React.ReactNode for children-like props (#1221) 2024-02-25 21:52:00 +01:00
Joseph Harkins
240121ad22
docs: Fix navigation.md typo (#1200) 2024-02-23 23:20:59 +01:00
Rustam Musin
188b2da35a
docs: Fix formatting in Data Loading guide (#1214) 2024-02-23 23:13:10 +01:00
Tanner Linsley
8c6de040c1 fix: better error, not found and redirect propagation 2024-02-16 15:37:48 -07:00
Aryan Nagbanshi
1a4a0a980a
docs: fix typo in quick-start.md (#1188)
spelling mistake on line no 216, should be "your" but it typed "you"
2024-02-15 23:14:05 +01:00
lunacrafts
e703b8d6df
docs: Remove .md suffix from guide links (#1189) 2024-02-15 23:13:43 +01:00
Uros Mrak
d2e0365b20
docs: Add missing .tsx (#1180) 2024-02-14 17:49:12 +01:00
Sean Cassiere
c827951c7a
docs: prefer the usage of the getRouteApi function over direct Route config consumption (#1143)
* docs: path-params

* docs: search params

* docs: type-safety

* docs: useParams reference

* docs: code-based routing

* docs: data mutations

* docs: route-trees

* docs: search-params

* docs: deferred-data-loading

* docs: revert unneccessary changes and leave in a stub to add the "tips"

* docs: forgot to include in the last commit

* docs: add the "🧠 Quick tip" items about the `getRouteApi` function
2024-02-12 23:59:55 -07:00
Ilia
21ce1351e5
docs: remove duplicate word (#1167) 2024-02-11 11:01:52 +01:00
Victor Afanassieff
46eff8b9a0
feat: Add configuration option to generator which enables files extensions in imports to support moduleResolution "bundler"(#1160)
* feat: add file extensions to generated file

* chore: less code repeat

* feat: handle all rootpath extensions

* docs: add doc for addExtensions option
2024-02-09 22:12:09 +01:00
Brayan Paucar
6d980b8c9c
Update quick-start.md (#1148)
Missing instruction when devs want to work with file-based configuration
2024-02-04 13:50:38 -07:00
Nathan Isaac
e7d78aa6fc
docs: add suspense note for lazy devtools (#1139) 2024-02-03 17:38:02 +01:00
Egor Fedorov
31a0398b4f
docs: fix Route variable in path-params example (#1103) 2024-01-30 19:14:30 +01:00
Tanner Linsley
81d8dcdd62 docs: useChildMatches docs 2024-01-29 09:48:48 -07:00
Sean Cassiere
47e63aa036
docs: include the not found errors guide in the documentation config (#1097) 2024-01-28 15:59:45 -07:00