Skip to content

docs(solid-router): kitchensink example #5840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
birkskyum merged 3 commits into from
Nov 12, 2025
Merged

docs(solid-router): kitchensink example #5840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbf70b6
docs(solid-router): kitchensink example
birkskyum Nov 12, 2025
c403c5a
add listing
birkskyum Nov 12, 2025
5cef952
ci: apply automated fixes
autofix-ci[bot] Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/router/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,10 @@
"label": "Basic + SSR Streaming (file-based)",
"to": "framework/solid/examples/basic-ssr-streaming-file-based"
},
{
"label": "Kitchen Sink (code-based)",
"to": "framework/solid/examples/kitchen-sink"
},
Comment on lines +637 to +640
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Add the matching docs page before merging.

This new nav item points to framework/solid/examples/kitchen-sink, but I don’t see an accompanying page in this PR. Without it, the menu link will 404 on the site. Please add the corresponding MDX page (or adjust the link if it already exists elsewhere) so the navigation remains functional.

🤖 Prompt for AI Agents 
In docs/router/config.json around lines 637 to 640, the new navigation entry
"framework/solid/examples/kitchen-sink" points to a page that isn't present in
this PR, causing a 404; add a corresponding MDX page at
docs/framework/solid/examples/kitchen-sink.mdx (or adjust the "to" path to an
existing page) containing the Kitchen Sink documentation and frontmatter so the
link resolves, then ensure the file is exported/registered by the docs build
(and update any index or sidebar if your system requires explicit inclusion).

{
"label": "Kitchen Sink (file-based)",
"to": "framework/solid/examples/kitchen-sink-file-based"
Expand Down
5 changes: 5 additions & 0 deletions examples/solid/kitchen-sink/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
.DS_Store
dist
dist-ssr
*.local
11 changes: 11 additions & 0 deletions examples/solid/kitchen-sink/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"files.watcherExclude": {
"**/routeTree.gen.ts": true
},
"search.exclude": {
"**/routeTree.gen.ts": true
},
"files.readonlyInclude": {
"**/routeTree.gen.ts": true
}
}
6 changes: 6 additions & 0 deletions examples/solid/kitchen-sink/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Example

To run this example:

- `npm install` or `yarn`
- `npm start` or `yarn start`
12 changes: 12 additions & 0 deletions examples/solid/kitchen-sink/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite App</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
27 changes: 27 additions & 0 deletions examples/solid/kitchen-sink/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name": "tanstack-router-solid-example-kitchen-sink",
"private": true,
"type": "module",
"scripts": {
"dev": "vite --port 3000",
"build": "vite build && tsc --noEmit",
"serve": "vite preview",
"start": "vite"
},
"dependencies": {
"@tailwindcss/postcss": "^4.1.15",
"@tanstack/solid-router": "^1.135.2",
"@tanstack/solid-router-devtools": "^1.135.2",
"immer": "^10.1.1",
"postcss": "^8.5.1",
"solid-js": "^1.9.10",
"redaxios": "^0.5.1",
"tailwindcss": "^4.1.15",
"zod": "^3.24.2"
Comment on lines +12 to +20
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion | 🟠 Major

Switch local TanStack deps to workspace:*.

Per the repo convention, internal packages should resolve through the workspace to pick up local changes. Please update both router packages accordingly.

As per coding guidelines
Apply this diff:

-    "@tanstack/solid-router": "^1.135.2",
-    "@tanstack/solid-router-devtools": "^1.135.2",
+    "@tanstack/solid-router": "workspace:*",
+    "@tanstack/solid-router-devtools": "workspace:*",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"@tailwindcss/postcss": "^4.1.15",
"@tanstack/solid-router": "^1.135.2",
"@tanstack/solid-router-devtools": "^1.135.2",
"immer": "^10.1.1",
"postcss": "^8.5.1",
"solid-js": "^1.9.10",
"redaxios": "^0.5.1",
"tailwindcss": "^4.1.15",
"zod": "^3.24.2"
"@tailwindcss/postcss": "^4.1.15",
"@tanstack/solid-router": "workspace:*",
"@tanstack/solid-router-devtools": "workspace:*",
"immer": "^10.1.1",
"postcss": "^8.5.1",
"solid-js": "^1.9.10",
"redaxios": "^0.5.1",
"tailwindcss": "^4.1.15",
"zod": "^3.24.2"
🤖 Prompt for AI Agents 
In examples/solid/kitchen-sink/package.json around lines 12 to 20 the two
TanStack packages are declared with fixed versions; update
"@tanstack/solid-router" and "@tanstack/solid-router-devtools" to use the
workspace protocol so they resolve to local packages by replacing their version
strings with "workspace:*" (leave all other dependencies unchanged).

},
"devDependencies": {
"vite-plugin-solid": "^2.11.10",
"typescript": "^5.7.2",
"vite": "^7.1.7"
}
}
5 changes: 5 additions & 0 deletions examples/solid/kitchen-sink/postcss.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export default {
plugins: {
'@tailwindcss/postcss': {},
},
}
8 changes: 8 additions & 0 deletions examples/solid/kitchen-sink/src/Expensive.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export default function Expensive() {
return (
<div class={`p-2`}>
I am an "expensive" component... which really just means that I was
code-split 😉
</div>
)
}
Loading
Loading