@void/svelte 0.24.0 → 0.26.0

package/README.md

@@ -1,9 +1,17 @@
 # @void/svelte
 
-Svelte 5 adapter for Void Pages mode.
+Build server-rendered Void pages with Svelte 5, server loaders, and typed forms.
 
 ## Setup
 
+Install alongside `void`:
+
+```sh
+npm install @void/svelte
+```
+
+Add the adapter to your Vite config. It includes the framework's Vite plugin:
+
 ```ts
 import { defineConfig } from 'vite';
 import { voidPlugin } from 'void';
@@ -14,111 +22,6 @@ export default defineConfig({
 });
 ```
 
-## Plugin
-
-`voidSvelte(options?)` returns:
-
-- `@sveltejs/vite-plugin-svelte`
-- the Svelte pages plugin
-- the Svelte islands plugin
-
-Options:
-
-- `svelte?` — forwarded to the Svelte Vite plugin
-- `viewTransitions?` — enable View Transitions for SPA navigation
-- `prefetch?` — link prefetch behavior
-
-## Runtime
-
-Main runtime APIs live at `@void/svelte`:
-
-- `Link`
-- `useRouter()`
-- `useParams()`
-- `useNavigation()`
-- `useShared()`
-- `Form` and `useForm()`
-- `useIslandForm()`
-- `action()`
-
-### Link
-
-`Link` renders an `<a>` for GET navigation and a `<button>` for mutation methods:
-
-```svelte
-<Link href="/users" data={{ page: 2, tag: ["active", "new"] }}>Filtered users</Link>
-<Link href="/users" replace>Users</Link>
-<Link href="/logout" reloadDocument>Sign out</Link>
-```
-
-GET `data` is merged into the rendered `href` query string. Primitive values are serialized with `String(value)`, arrays become repeated keys, `null` and `undefined` are omitted, and nested objects throw.
-
-`prefetch` and `reloadDocument` are GET-only and throw for mutation links. `onNavigate` can cancel client-side navigation by calling `event.preventDefault()`.
-
-### Forms
-
-`useForm()` tracks form state for Pages actions. Use `pending` for in-flight
-state, `errors` for field validation, and `error` for non-validation call-site
-failures. The submit helpers return promises so boundary-class failures can
-propagate through Svelte async error handling or explicit `catch` handlers.
-
-```svelte
-<script lang="ts">
-  import { useForm } from '@void/svelte';
-
-  const form = useForm('/users', { name: '', email: '' });
-</script>
-
-<form
-  onsubmit={(event) => {
-    event.preventDefault();
-    return form.post();
-  }}
->
-  <input bind:value={form.data.name} name="name" />
-  {#if form.errors.name}<p>{form.errors.name}</p>{/if}
-  {#if form.error}<p>{form.error.message}</p>{/if}
-  <button disabled={form.pending}>Save</button>
-</form>
-```
-
-Use `action()` for the awaitable imperative escape hatch. It returns
-`{ ok: true, pageData }` or `{ ok: false, error }` for call-site action errors,
-while boundary-class failures are thrown. `action()` uses `POST` by default and
-accepts `{ method: "PUT" | "PATCH" | "DELETE" }`.
-
-## Pages
-
-Pages are `.svelte` files in `pages/` with companion `.server.ts` files:
-
-```svelte
-<script>
-  let { title } = $props();
-</script>
-
-<h1>{title}</h1>
-```
-
-```ts
-import { defineHandler } from 'void';
-
-export const loader = defineHandler(() => ({ title: 'Home' }));
-```
-
-Export `ssr = false` from a page's `.server.ts` file to skip server-rendered
-component HTML for that route while still running its loader on the first
-request.
-
-## Form
-
-Use `Form` with `useForm()` to display action and validation errors automatically. It preserves controlled input after a failed submission and announces errors accessibly. Structured usage-limit responses display the application's message and an optional retry time. Submissions are blocked while pending and before that deadline; inputs remain editable and requests are never retried automatically.
-
-`method` selects `post` (the default), `put`, `patch`, or `delete`. Use `renderError` to customize action-error presentation (a snippet in Svelte). Native forms remain available when you manage error presentation yourself.
-
-## Tests
-
-- `test/integration/svelte-pages-client.test.ts`
-
-Cross-package SSR/protocol coverage for Svelte pages mode also lives in `packages/void/test/integration/*`.
+Follow [Pages Routing](https://void.cloud/guide/pages-routing/overview) to add pages, then use [loaders](https://void.cloud/guide/pages-routing/loaders), [forms](https://void.cloud/guide/pages-routing/actions-and-forms), and [layouts](https://void.cloud/guide/pages-routing/layouts).
 
-The [shared client](../../test/pages-client-contract.ts) and [island](../../test/pages-island-contract.ts) contracts run against this adapter in both dev and preview. Shared form equality is tested directly in [Void](../void/test/unit/form-value-equality.test.ts); tests do not copy the hook implementation.
+See the [adapter API reference](https://void.cloud/reference/api/pages) for plugin options and runtime helpers, and [TESTING.md](../../TESTING.md) for repository verification.

package/dist/plugin.mjs

@@ -490,7 +490,7 @@ export async function renderPage(pageObj, assetTags) {
 }
 function generateClientEntry(scan, pagesDir, viewTransitions, prefetch, staticPageData) {
 	return `
-import { hydrate, mount } from "svelte";
+import { hydrate, mount, tick } from "svelte";
 import { writable } from "svelte/store";
 import App from "@void/svelte/App.svelte";
 import { setActionRouter } from "@void/svelte";
@@ -510,7 +510,7 @@ let routeParams = {};
 const routeStore = writable(routeUrl);
 const navigationStore = writable(idleNavigationState());
 
-const { router, initialPageData, initialComponent, initialLayouts, start } =
+const { router, initialPageData, initialComponent, initialLayouts, start, commitInitialRender } =
   await createVoidRouter({
     adapter: {
       createDeferred: () => ({ value: null, loading: true, error: null }),
@@ -589,9 +589,11 @@ if (appEl.getAttribute("data-void-ssr") === "false") {
   hydrate(App, appOptions);
 }
 
-appEl.setAttribute("data-hydrated", "true");
 export { reactiveRouter as router };
 start();
+await tick();
+commitInitialRender();
+appEl.setAttribute("data-hydrated", "true");
 `;
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@void/svelte",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voidzero-dev/void.git",
@@ -32,17 +32,17 @@
     "@sveltejs/vite-plugin-svelte": "^7.3.1"
   },
   "devDependencies": {
-    "@types/node": "^26.6.3",
+    "@types/node": "^26.6.4",
     "pathslash": "^0.1.0",
     "svelte": "^5.57.1",
     "vite": "npm:@voidzero-dev/vite-plus-core@1.0.0",
     "vite-plus": "1.0.0",
-    "void": "0.24.0"
+    "void": "0.26.0"
   },
   "peerDependencies": {
     "svelte": "^5.0.0",
     "vite": "^8.0.0",
-    "void": "0.24.0"
+    "void": "0.26.0"
   },
   "scripts": {
     "build": "vp pack",