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

103 commits

Author SHA1 Message Date
Gerard Ketuma
b8c0420a75
docs(router): fix grammatical errors in the "Code-splitting" guide (#2171) 2024-08-23 16:55:49 +12:00
Sean Cassiere
8cf525d99c
refactor(router-generator,router-plugin,start): mark experimental.enableCodeSplitting functionality as stable with the name autoCodeSplitting (#2163)
* feat(router-generator): add the `autoCodeSplitting` option to the expected config

* refactor(router-plugin): accept the new `autoCodeSplitting` flag + throw an error if the older `experimental.enableCodeSplitting` flag is still being used

* refactor(start): update the vinxi configuration to use the new `autoCodeSplitting` flag instead of the `experimental.enableCodeSplitting` flag

* docs: update the "file-based-routing" guide with the correct flag

* docs: update the content in the "code-splitting" guide for better readability and communicate the necessary steps needed for using the feature

* docs: update the title on the "file-based-routing" guide

* examples: remove the older `experimental.enableCodeSplitting` flags from the trpc examples
2024-08-22 08:50:48 +12:00
Pankaj chauhan
22f0985080
doc: update the accumulated router context guide to for checking breadcrumbs (#2160)
* doc(accumulated-route-context): useRouterState to listen reactive state change

* Apply suggestions from code review

Don't use `routeContext`, use `context` instead.

* ci: apply automated fixes

* docs: cleanup the breadcrumbs filer

---------

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-08-21 13:05:31 +12:00
Christopher Horobin
42f703d05b
feat(react-router): add context option to route (#2104)
* feat(react-router): add types for routeContext

* perf(react-router): optimise new types for `routeContext`

* chore(react-router): add type tests for routeContext and beforeLoad

* checkpoint

* ci: apply automated fixes

* updates docs

* fix: tests

* fix: context

* chore: fix the lockfile

* ci: apply automated fixes

* style(react-router): fixup the eslint errors

* fix: hydration mismatch during SSR, refactor matchRoutes to take location

* fix: serialize beforeLoadContext during SSR

* examples: add start-basic-auth

* fix: history export parseHref

* feat: routeOptions.preload to allow disabling route-level preloading

* fix: full support for href redirects

* feat: useServerFn hook to allow handling server side effects like redirects outside of router lifecycles

* fix: server redirect and notFound now default to 200 status code for runtime to handle

* fix: update pnpm

* ci: apply automated fixes

* examples: fix start-basic-auth

* tests: fix playwright

* tests: fix playwright

* tests: fix playwright

* sean's changes to the route context branch (#2141)

* chore: type the objects used for `routeContext` and `beforeLoad`

* refactor: move the defaultTransformer from start to react-router

* test: add tests to the defaultTransformer

* test(react-router): add runtime unit tests for the `context` function

* examples: init start-clerk-basic

* fix: lockfile

* ci: apply automated fixes

* test: remove failing test for WIP clerk example

* tests: fix more clerk wip tests

* fix: lockfile

* tests: more clerk fixes

* tests: skip WIP clerk example

---------

Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-08-20 13:39:17 -06:00
The Blue Dragon
e5fd079b3a
docs: Removed the redundant "default" (#2146) 2024-08-18 18:44:07 +02:00
Christopher Horobin
3a8dcf7c46
feat(react-router): support input types for search validation schemas (#2000)
* feat: add support for search schema adapters
2024-08-14 21:20:23 +02:00
Honza Hrubý
d5d151c847
feat(router-generate): add option to skip generating route manifest (#2100)
* feat(router-generate): add option to skip generating route manifest

* rename option

* document

* refactor: one last rename

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-08-08 11:58:29 +12:00
Sean Cassiere
84605c035c
feat(react-router): support for preload='viewport' (#2062)
* feat(react-router): expand the types to allow the preload setting of "viewport"

* feat(react-router): add the `useIntersectionObserver` and `useForwardedRef` hooks

* feat(react-router): add the configuration to use `preload='viewport'`

* chore(react-router): cleanup `console.log`

* chore(react-router): types I can be happy with

* refactor(react-router): make the `useIntersectionObserver` hook testing compatible

* test(react-router): testing for preload='viewport'

* test(react-router): move the `IntersectionObserver` mock into the utils

* docs: update the preloading guide

* docs: api reference

* chore: apply suggestions from code review
2024-08-01 10:48:06 +12:00
Rijk van Wel
cd21b290af
docs: missing comma in the Start Vinxi scripts (#2067)
* docs: fixed missing comma in Start Vinxi scripts

Also opted to change the `// ...` into a normal comment to avoid confusion.

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-08-01 10:43:10 +12:00
Loyale
12c10d523a
docs: fix a grammar error in the "code-splitting" guide (#2064) 2024-07-31 23:10:40 +12:00
Manuel Schiller
08bbb333c2 docs: fix typos 2024-07-30 22:20:26 +02:00
Tom Ballinger
789c4660ef
docs: add more installation details to getting started with TanStack Start guide (#2016)
* Add details to getting started with Start.

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-07-24 18:22:15 +12:00
Baqir Khan
2c5452e8fa
docs: typos in the "data loading" and "deferred data loading" guides (#2015)
* Fix minor typo in data loading docs

* Fix typo in deferred data loading
2024-07-24 13:22:20 +12:00
dli9431
7087c4bb01
docs: typo in an import statement within the code-splitting guide (#2005)
typo on import
2024-07-22 19:51:48 +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
Sean Cassiere
7c0133b74e
docs: remove component as a supported throw area for the notFound utility (#1997) 2024-07-20 17:15:28 +12:00
Tanner Linsley
3003d986c6
fix(router): fixed a lot of context related issues (#1907) 2024-07-16 19:34:14 +02:00
Sean Cassiere
b1d86cc709
docs: add verbiage on the "router-context" guide about invalidating the router context for external state changes (#1954) 2024-07-13 23:30:29 +12:00
Casey Johnson
0b5bff5942
docs: update the list of parameters available in the loader in the "data loading" guide (#1945)
* fix: loader parameters in data loading documentation

* Update docs/framework/react/guide/data-loading.md

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-07-12 09:48:30 +12:00
Sean Cassiere
9880bb8bb1
docs: use gfm alerts in the documentation (#1924)
* docs: gfm alerts on the deprecated apis

* docs: gfm alerts in the api reference

* docs: gfm alerts in framework/react

* docs: gfm alerts in framework/react/guide

* docs: more gfm alerts in the api reference

* docs: update to the decisions on dx doc
2024-07-10 11:46:21 +12:00
Sean Cassiere
37b74fa143
docs: add links to the github examples on the file-based routing guide for each supported bundler (#1903)
* docs: grammatical errors

* docs: add links to the quickstart examples
2024-07-06 11:29:05 +12:00
Corbin Crutchley
780b778137
docs: add quickstart guide for TanStack Start (#1857)
* docs: add quickstart guide for TanStack Start

* docs: add initial documentation for createServerFn (#1858)

* docs: add initial documentation for createServerFn

* chore: fix broken code sample

* docs(start): more explanation on the mental model of server functions (#1859)

* grammatical error in what are server functions?

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

* docs: address feedback for Start Guide

* chore: fix PNPM file

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-07-05 19:32:29 +02:00
Honza Hrubý
bcc316eb1a
fix(router-plugin): add webpack support and resolve rspack code-splitting blockers (#1864)
* basic webpack example

* setup webpack plugin

* use webpack plugin

* add missing webpack config

* disable code split

* fix docs

* add watcher

* code split config

* documentation

* lazy load chokidar

* chore(router-plugin): set the webpack peerDeps

* feat(router-plugin): get code-splitting working for webpack

* refactor(router-plugin): better detection of the build mode

* chore(router-plugin): remove this console.log

* fix(router-plugin): remove the blockers for codesplitting with rspack

* chore(router-plugin): remove the unstable flags for webpack and rspack

* docs(router-plugin): remove the unsupported warnings for `experimental.enableCodeSplitting` for webpack and rspack

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-07-03 19:42:45 +12:00
Sean Cassiere
9040999892
style: prettier on the docs (#1872) 2024-07-02 12:16:28 +12:00
friendlywavingrobot
994453b436
docs: remove the unnecessary encode and decode URIComponent calls in the zipson example of the "custom search param serialization" guide (#1870) 2024-07-02 12:07:27 +12:00
Tanner Linsley
23614fa79a fix: add react-router-with-query experimental package 2024-07-01 00:15:41 -06:00
Sean Cassiere
2d28367b84
docs: add a diagram on the "custom search param serialization" guide on the need for idempotency (#1860)
* docs: add the image

* docs: update the page with the diagram
2024-06-29 23:30:30 +12:00
Christopher Horobin
1d733f6cc6
feat(react-router): params.parse and params.stringify instead of parseParams and stringifyParams (#1826) 2024-06-28 18:34:49 +02:00
Tanner Linsley
fd692cf77d
feat: New Serialization Paradigm (#1824)
* checkpoint

* fix: config

* checkpoint

* testing fixes (#1679)

* examples: init trellaux

* feat: Better serialization/streaming, RSC proof of concept

* fixup server-handler

* fix: update deps and lock

* fix: remove rscFrom

* fix: remove useLoaderDataTransform

* fix: min react version

* chore: lockfile

* style: prettier fail

* chore: swap expect-error for ignore

* chore(react-router): try coercing the types

* chore: put this back in

* fix: some tests

* remove conditions

* fix tests

* update lockfile

* fix: refactor dehydrated data

* Update docs

* fix: remove unused deferred logic

* fix port

* nevermind

* fix: remove rebase garbage

* disable playwright for a hot minute

* oops, actually disable it now

* fix: prettier formatting

* fix: do not ignore app.config files

---------

Co-authored-by: Nikhil Saraf <nsaraf98@gmail.com>
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-06-28 09:45:01 -06:00
Christopher Horobin
f970023cd6
docs: add TS performance guidance with prefetching (#1781)
* docs: add TS performance guidance with prefetching

* chore: make suggestions
2024-06-22 10:38:42 +12:00
Sean Cassiere
a9874aad26
fix(router-plugin): add the rspack/rsbuild handler for file-based routing (#1794)
* feat: setup the starter for an rspack integration

* refactor(router-plugin): compose the plugins toghether

* feat(router-plugin): initial export for rspack

* docs(examples): add the quickstart-file-based pages in

* feat(router-plugin): generator should generate the route-tree on startup

* feat(examples): use the route-tree

* feat(router-plugin): router-generator working

* feat(router-plugin): rspack support only for the generator

* refactor(router-plugin): make the rspack exports a bit cleaner

* chore(router-plugin): jsdocs for the vite plugin

* docs(router-plugin): update with references and mentions to rspack/rsbuild

* style(router-plugin): eslint import ordering 😭
2024-06-21 11:51:08 +12:00
Sean Cassiere
ee48ae2aa1
docs: update the documentation on the @tanstack/router-plugin package (#1793)
* docs: update the file-based routing guide

* docs: update the quick-start guide

* docs: update the migrate from react-location guide

* docs: more updates to the migration from react-location guide

* docs: update the code-splitting guide

* docs: update the routing concepts guide

* docs: broken link on the code-splitting guide
2024-06-20 11:24:28 +12:00
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