Merge branch 'main' of github.com:solidjs/solid-app-router

Author: ryansolid

.changeset/big-badgers-learn.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/router": patch
+---
+
+Add JSdoc

.changeset/breezy-countries-judge.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/router": minor
+---
+
+Vite 6 compatibility

.github/ISSUE_TEMPLATE/config.yml

@@ -3,15 +3,21 @@ contact_links:
   - name: 🤔 Long question or idea
     url: https://github.com/solidjs/solid-router
     about: Ask long-form questions and discuss ideas.
+  - name: 📝 Official Documentation
+    url: https://docs.solidjs.com/solid-router
+    about: Check existing documentation on APIs and how to use Solid-Router.
   - name: 💬 Community Chat
     url: https://discord.com/invite/solidjs
-    about: Ask quick questions or simply chat on the EdgeDB Discord server.
-  - name: 💬 New Updates (Twitter)
-    url: https://twitter.com/solid_js
-    about: Link to our twitter account if you want to follow us and stay up to date with news
+    about: Ask quick questions or simply chat on the SolidJS Discord server.
+  - name: 💬 New Updates (X - formerly Twitter)
+    url: https://x.com/solid_js
+    about: Link to our X account if you want to follow us and stay up to date with news.
+  - name: 💬 New Updates BlueSky
+    url: https://bsky.app/profile/solidjs.com
+    about: Link to our BlueSky account if you want to follow us and stay up to date with news.
   - name: 💬 New Updates (Reddit)
     url: https://www.reddit.com/r/solidjs/
-    about: Link to our twitter account if you want to follow us and stay up to date with news
+    about: Link to our twitter account if you want to follow us and stay up to date with news.
   - name: 🍿 YouTube Channel
     url: https://www.youtube.com/c/RyanCarniato9
-    about: Are you a techlead or wanting to learn more about SolidJS? Watch Ryan Carniato (creator of solidJS) share detailed technical deep dives into topics like how SolidJS, Server Side Rendering (SSR), ReactJS, Svelte, MarkoJS & Partial Hydration works under the hood and so much more
+    about: Are you a techlead or wanting to learn more about SolidJS? Watch Ryan Carniato (creator of SolidJS) share detailed technical deep dives into topics like how SolidJS, Server Side Rendering (SSR), ReactJS, Svelte, MarkoJS & Partial Hydration works under the hood and so much more.

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm run test

README.md

@@ -818,7 +818,7 @@ if (unauthorized) {
 
 ### useLocation
 
-Retrieves reactive `location` object useful for getting things like `pathname`
+Retrieves reactive `location` object useful for getting things like `pathname`.
 
 ```js
 const location = useLocation();
@@ -880,7 +880,8 @@ return <div classList={{ active: Boolean(match()) }} />;
 For example if you stored breadcrumbs on your route definition you could retrieve them like so:
 ```js
 const matches = useCurrentMatches();
-const breadcrumbs = createMemo(() => matches().map(m => m.route.info.breadcrumb))
+
+const breadcrumbs = createMemo(() => matches().map(m => m.route.info.breadcrumb));
 ```
 
 ### usePreloadRoute
@@ -898,11 +899,11 @@ preload(`/users/settings`, { preloadData: true });
 `useBeforeLeave` takes a function that will be called prior to leaving a route. The function will be called with:
 
 - from (_Location_): current location (before change).
-- to (_string | number_}: path passed to `navigate`.
-- options (_NavigateOptions_}: options passed to `navigate`.
-- preventDefault (_void function_): call to block the route change.
-- defaultPrevented (_readonly boolean_): true if any previously called leave handlers called preventDefault().
-- retry (_void function_, _force?: boolean_ ): call to retry the same navigation, perhaps after confirming with the user. Pass `true` to skip running the leave handlers again (ie force navigate without confirming).
+- to (_string | number_): path passed to `navigate`.
+- options (_NavigateOptions_): options passed to `navigate`.
+- preventDefault (_function_): call to block the route change.
+- defaultPrevented (_readonly boolean_): `true` if any previously called leave handlers called `preventDefault`.
+- retry (_function_, _force?: boolean_ ): call to retry the same navigation, perhaps after confirming with the user. Pass `true` to skip running the leave handlers again (i.e. force navigate without confirming).
 
 Example usage:
 

package.json

@@ -37,23 +37,23 @@
     "pretty": "prettier --write \"{src,test}/**/*.{ts,tsx}\""
   },
   "devDependencies": {
-    "@babel/core": "^7.23.9",
-    "@babel/preset-typescript": "^7.23.3",
-    "@changesets/cli": "^2.27.1",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-typescript": "^7.26.0",
+    "@changesets/cli": "^2.27.10",
     "@rollup/plugin-babel": "6.0.4",
-    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-node-resolve": "15.3.0",
     "@rollup/plugin-terser": "0.4.4",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.14",
-    "babel-preset-solid": "^1.9.2",
-    "jsdom": "^24.0.0",
-    "prettier": "^2.7.0",
-    "rollup": "^4.9.6",
-    "solid-js": "^1.9.2",
-    "typescript": "^5.3.3",
-    "vite": "^5.4.8",
-    "vite-plugin-solid": "^2.9.1",
-    "vitest": "^2.1.2"
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.0",
+    "babel-preset-solid": "^1.9.3",
+    "jsdom": "^25.0.1",
+    "prettier": "^3.4.1",
+    "rollup": "^4.27.4",
+    "solid-js": "^1.9.3",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.0",
+    "vite-plugin-solid": "^2.11.0",
+    "vitest": "^2.1.6"
   },
   "peerDependencies": {
     "solid-js": "^1.8.6"