@void/vue 0.24.0 → 0.26.0

package/README.md

@@ -1,9 +1,17 @@
 # @void/vue
 
-Vue adapter for Void Pages mode.
+Build server-rendered Void pages with Vue, server loaders, and typed forms.
 
 ## Setup
 
+Install alongside `void`:
+
+```sh
+npm install @void/vue
+```
+
+Add the adapter to your Vite config. It includes the framework's Vite plugin:
+
 ```ts
 import { defineConfig } from 'vite';
 import { voidPlugin } from 'void';
@@ -14,118 +22,6 @@ export default defineConfig({
 });
 ```
 
-## Plugin
-
-`voidVue(options?)` returns:
-
-- `@vitejs/plugin-vue`
-- the Vue pages plugin
-- the Vue islands plugin
-
-Options:
-
-- `vue?` — forwarded to `@vitejs/plugin-vue`
-- `viewTransitions?` — enable View Transitions for SPA navigation
-
-## Runtime
-
-Main runtime APIs live at `@void/vue`:
-
-- `Link`
-- `useRouter()`
-- `useParams()`
-- `useNavigation()`
-- `useShared()`
-- `Form` and `useForm()`
-- `useIslandForm()`
-- `action()`
-
-Deferred helpers are exported from `@void/vue/deferred`.
-
-### Link
-
-`Link` renders an `<a>` for GET navigation and a `<button>` for mutation methods:
-
-```vue
-<Link href="/users" :data="{ page: 2, tag: ['active', 'new'] }">Filtered users</Link>
-<Link href="/users" replace>Users</Link>
-<Link href="/logout" reload-document>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 Vue async error handling or explicit `catch` handlers.
-
-GET navigation creates a fresh page instance, so forms receive the destination
-record's URL and defaults. Layouts remain mounted. Mutations and
-`router.refresh()` preserve page state by default; use `preserveState` to override
-this behavior when navigating within the same record.
-
-```vue
-<script setup lang="ts">
-import { useForm } from '@void/vue';
-
-const form = useForm('/users', { name: '', email: '' });
-</script>
-
-<template>
-  <form @submit.prevent="form.post()">
-    <input v-model="form.data.name" name="name" />
-    <p v-if="form.errors.name">{{ form.errors.name }}</p>
-    <p v-if="form.error">{{ form.error.message }}</p>
-    <button :disabled="form.pending">Save</button>
-  </form>
-</template>
-```
-
-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 `.vue` files in `pages/` with companion `.server.ts` files:
-
-```vue
-<script setup lang="ts">
-defineProps<{ title: string }>();
-</script>
-
-<template>
-  <h1>{{ title }}</h1>
-</template>
-```
-
-```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
-
-Shared prefetch-cache tests live in `packages/void/test/unit/prefetch.test.ts`.
-
-- `test/integration/vue-pages-client.test.ts`
-
-Cross-package SSR/protocol coverage for Vue 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

@@ -571,7 +571,7 @@ function replaceRecord(target, source) {
   Object.assign(target, source || {});
 }
 
-const { router, initialPageData, initialComponent, initialLayouts, start } =
+const { router, initialPageData, initialComponent, initialLayouts, start, commitInitialRender } =
   await createVoidRouter({
     adapter: {
       createDeferred: () => createDeferred(),
@@ -644,6 +644,7 @@ app.mount(appEl);
 appEl.setAttribute("data-hydrated", "true");
 export { reactiveRouter as router };
 start();
+commitInitialRender();
 `;
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@void/vue",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voidzero-dev/void.git",
@@ -31,16 +31,16 @@
     "@vitejs/plugin-vue": "^6.0.9"
   },
   "devDependencies": {
-    "@types/node": "^26.6.3",
+    "@types/node": "^26.6.4",
     "pathslash": "^0.1.0",
     "vite": "npm:@voidzero-dev/vite-plus-core@1.0.0",
     "vite-plus": "1.0.0",
-    "void": "0.24.0",
+    "void": "0.26.0",
     "vue": "^3.5.43"
   },
   "peerDependencies": {
     "vite": "^8.0.0",
-    "void": "0.24.0",
+    "void": "0.26.0",
     "vue": "^3.5.0"
   },
   "scripts": {