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

169 commits

Author SHA1 Message Date
Sean Cassiere
cabd42686e
docs(start): markdown to follow the website flow (#2173)
* docs(start): markdown to follow the website flow

* docs(start): fixup the content hierarchy for the getting started guide
2024-08-23 19:31:49 +12:00
Gerard Ketuma
b8c0420a75
docs(router): fix grammatical errors in the "Code-splitting" guide (#2171) 2024-08-23 16:55:49 +12:00
Sina Niyavarzi
8e0dd0d315
docs(start): fixed some grammatical errors in the Start "Overview" (#2170) 2024-08-23 11:22:10 +12:00
Tanner Linsley
bba02627c3 docs: partner images 2024-08-22 12:36:27 -06:00
Tanner Linsley
c068515595 docs: start typo 2024-08-22 12:31:28 -06:00
Tanner Linsley
4ce6c16050 docs: startners 2024-08-22 12:30:53 -06:00
Tanner Linsley
dd134b55e4 docs: add placeholders for pillar features and partners 2024-08-22 12:00:50 -06:00
Tanner Linsley
52155a28aa docs: init start docs 2024-08-22 11:15:20 -06: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
jun won
1f5168dc3f
docs: fix a typo in useBlocker example code block (#2136) 2024-08-15 14:43:35 +12:00
Sean Cassiere
75bae7ab8c
docs: correct the documentation on the expected behaviour of Router.onError (#2134) 2024-08-15 12:52:33 +12:00
Sean Cassiere
c66e1b55eb
fix(react-router): explicitly set the default notFoundMode and update the RouterOptions JSDoc comments (#2133)
* fix(react-router): set the default `notFoundMode` during instantiation

* docs: update `RouterOptions` with `notFoundMode` and `defaultViewTransition`
2024-08-15 12:30:06 +12: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
autofix-ci[bot]
a330681a20
ci: apply automated fixes 2024-08-07 17:04:40 +00:00
Tanner Linsley
46981ae7ce docs: update overview 2024-08-07 11:03:41 -06:00
autofix-ci[bot]
668b04d9e0
ci: apply automated fixes 2024-08-07 16:33:49 +00:00
Tanner Linsley
26f23496d4 docs: update overview 2024-08-07 10:28:53 -06:00
Sagar Dwivedi
fa1bd0d3bc
docs: add installation commands for all package managers (#2099)
* docs: add command to install using bun

* added support for all package manager

* added support for all package manager in quick-start.md
2024-08-07 20:30:11 +12:00
Sean Cassiere
2423d02ce2
docs: remove the invalid context and location arguments from being shown as "available" in the loaderDeps route method (#2091) 2024-08-06 20:18:17 +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
Manuel Schiller
f0794aeea7
docs: link to useRouterState 2024-07-30 20:35:03 +02:00
Manuel Schiller
70148fc2ef
fix formatting in useRouterHook.md 2024-07-30 20:34:42 +02:00
Manuel Schiller
6bbdc7cbee
docs: warn that router.state is not reactive in the useRouter doc 2024-07-30 20:32:50 +02:00
Manuel Schiller
60c346baf0
docs: fix useLoaderDepsHook doc 2024-07-30 20:29:59 +02:00
Manuel Schiller
f5e011cb8f
Update useLoaderDataHook.md 2024-07-30 20:22:57 +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
Tom Ballinger
02f934c643
docs: Warn against DOM-rendering elements in Wrap and InnerWrap (#2017)
* Warn against DOM-rendering elements in Wrap and InnerWrap

* update docs

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2024-07-25 20:20:15 +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
Manuel Schiller
bacd6b7f22
feat: allow useMatch to not throw if match was not found (#1738)
in this case, `matchRoute` will return undefined
2024-07-12 22:09:43 +02: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
Igor Adrov
08d3e61b4c
docs: Fix typo in migrate-from-react-router.md (#1914) 2024-07-07 20:20:05 +02: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