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

71 commits

Author SHA1 Message Date
Sean Cassiere
13a0cc0631
docs: update the custom search param serialization guide (#1759)
* docs: update the custom search param serialization guide

* docs: move the image a bit further down

* docs: remove the image
2024-06-19 21:32:57 +12:00
Sean Cassiere
92c6c2b1ff
docs: add documentation on the experimental.enableCodeSplitting feature (#1761)
* docs: add the content to the guide

* docs: add a link to the guide
2024-06-17 21:39:55 +12:00
SeanCassiere
e908be4076
docs: moving the actual file-based routing specific stuff not related to code-splitting to the right file 2024-06-17 20:58:28 +12:00
Eliav2
a64513860b
docs: typo in the navigation blocking guide (#1754) 2024-06-15 10:43:31 +12:00
Daniel Guldberg Aaes
30ae443f14
docs: fix some mistakes in the example of the SSR guide (#1748)
The current docs has a conflicts with a local declaration of 'createRouter'. and the import for the routeTree.gen is missing a ./
2024-06-14 22:07:29 +12:00
Manuel Schiller
be3a410e46
docs: replace Meta with Static Data 2024-06-11 22:04:10 +02:00
Golamrabbi Azad
6979e62d03
docs: spelling mistake in the filename of the _authenticated layout route in the authenticated routes guide (#1723) 2024-06-08 19:30:09 +12:00
Dima Hinev
871ba64a91
docs: spelling mistakes on the route-masking guide (#1717)
removed the the from page
2024-06-08 12:54:35 +12:00
Leonardo Montini
85f5e7be1b
docs: mention how to disable the plugin in tests (#1682)
* docs: mention how to disable the plugin in tests

* docs: improve phrasing
2024-05-30 20:07:30 +02:00
Tanner Linsley
0be110012c fix: no more weird streaming APIs, just use suspense + streaming 2024-05-26 22:56:02 -06: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
Elia Maino
1ea92a3d79
docs: Update useBlocker function signature (#1639)
* docs: Update `useBlocker` function signature

* docs: update `message` to `blockerFn`
2024-05-21 21:28:00 +02:00
Dominik Dorfmeister
099aa926ef
refactor: JsDoc for RouterOptions (#1631) 2024-05-18 23:43:29 +02:00
Sean Cassiere
9f0d4c76b5
docs: documented the the usage of hooks and context in the "Router Context" guide (#1609) 2024-05-17 21:35:19 +12:00
Manuel Schiller
c38c02cc07 chore: fix doc formatting 2024-05-16 23:56:47 +02:00
simon-lund
f2ddae666f
docs: fix syntax error in example with loader and useSuspenseQuery (#1602)
This will fix the example with useSuspenseQuery for the Router loader. You cannot just write `const posts = useSuspenseQuery(...)` but have to resolve the data property as so `const  {data: {posts}} = useSuspenseQuery(...)`
2024-05-16 15:27:36 +02:00
Christopher Horobin
0898f2e12e
perf: new addChildren signature and generate more (#1564)
Be sure to re-run generator after upgrading

* perf: get lazy? do less?, generate more

* feat: add support for objects for children at runtime

- add type tests for objects with children
- add runtime support for objects with children
- add runtime tests for objects with children

* perf: apply similar optimisations for merging for code based

* perf: improve performance of LinkProps when passed to `Link`

* exmaples: add to large based file examples search, params and context

* docs: add TS performance recommendations to docs

* fix: remove route groups from id

* examples: update linkprops examples

* docs: update docs based on comments

* chore: remove export of `LinkComponentProps`

* chore: clean up PR

---------

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
2024-05-13 16:54:41 +02:00
Sean Cassiere
97d96befe3
docs: broken hyperlink on the "route-matching" guide (#1582) 2024-05-10 21:55:59 +12:00
David Birks
a89cb76fa0
docs: add missing comma to from an example in the router-context guide (#1579) 2024-05-10 19:49:24 +12:00
Tanner Linsley
e1f38f921f fix: rename react-router-server to start 😜 2024-05-08 16:51:45 -06:00
Manuel Schiller
64ae7c3998
docs: improve routeFileIgnorePattern description 2024-05-06 17:49:41 +02:00
Sean Cassiere
5035865f87
docs: add a callout in the file-based routing options about not conflicting with the naming conventions (#1519)
* docs: callouts in the file-based routing conventions

* docs: make the callouts related their properties/options

* docs: emojis!

* docs: add a callout in the "file-naming conventions" section

* docs: use a single callout in the "options" sections

* docs: better callout in the 'file-naming conventioned' section

* docs: missing words

* docs: that should be it

* docs: be a bit more obvious about the `-`
2024-04-25 22:04:27 +12:00
Sean Cassiere
00fb7a5a71
docs(examples): update the authenticated-routes example to use layout routes (#1505)
* docs: rename the authenticated-routes example

* docs: update the authenticated-routes example to use layouts

* docs: trim up the authenticated routes example

* docs: default navigation to `/dashboard`

* docs: add auth persistence
2024-04-22 14:35:22 +12:00
Sean Cassiere
94ffb85bc4
feat(router-generator): prepend and append header and footer content to the generated route-tree file as defined by the user (#1502)
* feat(router-generator): append and prepend lines to the generated route-tree

* test(router-generator): making sure it works!

* refactor(router-generator): rename the prepend and append properties

* docs: docs on the new prepend and append functionality

* refactor(router-generator): update configuration property names

* test(router-generator): update the tests with the new configuration property names

* docs: update file-based routing guide with the new property names

* refactor(router-generator): move to the defaults

* test(router-generator): updated test output

* docs: show what the defaults are on the docs
2024-04-21 14:02:14 +12:00
Tanner Linsley
7b173f5088 fix: always use React transitions around navigations, experimental view transitions API 2024-04-18 16:33:04 -06:00
Hugo Costa
23fbecb62a
fix: broken example link (#1485) 2024-04-18 13:56:16 -06:00
Albert Chang
3aa01dc32e
docs: fix incorrect naming of index.route.tsx to route.tsx on the code-splitting guide (#1465) 2024-04-13 22:45:18 +12:00
Raphael Cunha
de62f894f1
Update routing-concepts.md (#1452)
Add outlet import from @tankstack/react-router
2024-04-09 15:38:37 -06:00
Dave Keen
43d08080c1
docs: fix a typo in the static-route-data guide (#1426) 2024-04-05 23:05:23 +13:00
Tanner Linsley
4ef78725af
docs: prep for migration of tanstack.com to TSR (#1419) 2024-04-02 16:46:22 -06:00
Kevin Herklotz
40af8ec334
docs: broken link to "using search params in loaders" in data-loading.md from search-params.md (#1416) 2024-04-03 06:12:40 +13:00
Leonardo Montini
e84815cdc0
docs: improve links to not found pages (#1396) 2024-03-31 00:56:55 +13:00
Dominik Dorfmeister
9f9b847ea7
feat: add reset prop to errorComponent (#1358)
* feat: add reset prop to errorComponent

* fix: types of defaultErrorComponent

* fix: put match into pending state when being invalidated if it was in error state

* docs: reset

* docs: error handling

* docs: integrate error handling into example

* chore: prettier on md files

* chore: fix wrong auto import

* fix: reset error boundaries from react-query in an effect

so that navigating away from a route will also re-trigger the query

* docs: error handling with TanStack Query

* chore: fix eslint

* fix: not all error components have a `preload`

* fix: merge conflict
2024-03-29 23:21:04 +01: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
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
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
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