@inertiajs/vue3 2.3.15 → 2.3.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inertiajs/vue3",
-  "version": "2.3.15",
+  "version": "2.3.17",
   "license": "MIT",
   "description": "The Vue 3 adapter for Inertia.js",
   "contributors": [
@@ -17,7 +17,8 @@
   },
   "files": [
     "dist",
-    "types"
+    "types",
+    "resources"
   ],
   "type": "module",
   "main": "dist/index.js",
@@ -43,11 +44,11 @@
   },
   "devDependencies": {
     "axios": "^1.13.5",
-    "es-check": "^9.5.4",
+    "es-check": "^9.6.1",
     "esbuild": "^0.27.3",
     "esbuild-node-externals": "^1.20.1",
     "typescript": "^5.9.3",
-    "vue": "^3.5.28"
+    "vue": "^3.5.29"
   },
   "peerDependencies": {
     "vue": "^3.0.0"
@@ -56,7 +57,7 @@
     "@types/lodash-es": "^4.17.12",
     "laravel-precognition": "^1.0.2",
     "lodash-es": "^4.17.23",
-    "@inertiajs/core": "2.3.15"
+    "@inertiajs/core": "2.3.17"
   },
   "scripts": {
     "build": "pnpm clean && ./build.js && tsc",

package/resources/boost/guidelines/core.blade.php

@@ -0,0 +1,4 @@
+# Inertia + Vue
+
+Vue components must have a single root element.
+- IMPORTANT: Activate `inertia-vue-development` when working with Inertia Vue client-side patterns.

package/resources/boost/skills/inertia-vue-development/SKILL.blade.php

@@ -0,0 +1,411 @@
+---
+name: inertia-vue-development
+description: "Develops Inertia.js v2 Vue client-side applications. Activates when creating Vue pages, forms, or navigation; using <Link>, <Form>, useForm, or router; working with deferred props, prefetching, or polling; or when user mentions Vue with Inertia, Vue pages, Vue forms, or Vue navigation."
+license: MIT
+metadata:
+  author: laravel
+---
+@php
+/** @var \Laravel\Boost\Install\GuidelineAssist $assist */
+@endphp
+# Inertia Vue Development
+
+## When to Apply
+
+Activate this skill when:
+
+- Creating or modifying Vue page components for Inertia
+- Working with forms in Vue (using `<Form>` or `useForm`)
+- Implementing client-side navigation with `<Link>` or `router`
+- Using v2 features: deferred props, prefetching, WhenVisible, InfiniteScroll, once props, flash data, or polling
+- Building Vue-specific features with the Inertia protocol
+
+## Documentation
+
+Use `search-docs` for detailed Inertia v2 Vue patterns and documentation.
+
+## Basic Usage
+
+### Page Components Location
+
+Vue page components should be placed in the `{{ $assist->inertia()->pagesDirectory() }}` directory.
+
+### Page Component Structure
+
+@verbatim
+@boostsnippet("Basic Vue Page Component", "vue")
+<script setup>
+defineProps({
+    users: Array
+})
+</script>
+
+<template>
+    <div>
+        <h1>Users</h1>
+        <ul>
+            <li v-for="user in users" :key="user.id">
+                {{ user.name }}
+            </li>
+        </ul>
+    </div>
+</template>
+@endboostsnippet
+@endverbatim
+
+## Client-Side Navigation
+
+### Basic Link Component
+
+Use `<Link>` for client-side navigation instead of traditional `<a>` tags:
+
+@boostsnippet("Inertia Vue Navigation", "vue")
+<script setup>
+import { Link } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <div>
+        <Link href="/">Home</Link>
+        <Link href="/users">Users</Link>
+        <Link :href="`/users/${user.id}`">View User</Link>
+    </div>
+</template>
+@endboostsnippet
+
+### Link with Method
+
+@boostsnippet("Link with POST Method", "vue")
+<script setup>
+import { Link } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <Link href="/logout" method="post" as="button">
+        Logout
+    </Link>
+</template>
+@endboostsnippet
+
+### Prefetching
+
+Prefetch pages to improve perceived performance:
+
+@boostsnippet("Prefetch on Hover", "vue")
+<script setup>
+import { Link } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <Link href="/users" prefetch>
+        Users
+    </Link>
+</template>
+@endboostsnippet
+
+### Programmatic Navigation
+
+@boostsnippet("Router Visit", "vue")
+<script setup>
+import { router } from '@inertiajs/vue3'
+
+function handleClick() {
+    router.visit('/users')
+}
+
+// Or with options
+function createUser() {
+    router.visit('/users', {
+        method: 'post',
+        data: { name: 'John' },
+        onSuccess: () => console.log('Done'),
+    })
+}
+</script>
+
+<template>
+    <Link href="/users">Users</Link>
+    <Link href="/logout" method="post" as="button">Logout</Link>
+</template>
+@endboostsnippet
+
+## Form Handling
+
+@if($assist->inertia()->hasFormComponent())
+### Form Component (Recommended)
+
+The recommended way to build forms is with the `<Form>` component:
+
+@verbatim
+@boostsnippet("Form Component Example", "vue")
+<script setup>
+import { Form } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <Form action="/users" method="post" #default="{ errors, processing, wasSuccessful }">
+        <input type="text" name="name" />
+        <div v-if="errors.name">{{ errors.name }}</div>
+
+        <input type="email" name="email" />
+        <div v-if="errors.email">{{ errors.email }}</div>
+
+        <button type="submit" :disabled="processing">
+            {{ processing ? 'Creating...' : 'Create User' }}
+        </button>
+
+        <div v-if="wasSuccessful">User created!</div>
+    </Form>
+</template>
+@endboostsnippet
+@endverbatim
+
+### Form Component With All Props
+
+@verbatim
+@boostsnippet("Form Component Full Example", "vue")
+<script setup>
+import { Form } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <Form
+        action="/users"
+        method="post"
+        #default="{
+            errors,
+            hasErrors,
+            processing,
+            progress,
+            wasSuccessful,
+            recentlySuccessful,
+            setError,
+            clearErrors,
+            resetAndClearErrors,
+            defaults,
+            isDirty,
+            reset,
+            submit
+        }"
+    >
+        <input type="text" name="name" :value="defaults.name" />
+        <div v-if="errors.name">{{ errors.name }}</div>
+
+        <button type="submit" :disabled="processing">
+            {{ processing ? 'Saving...' : 'Save' }}
+        </button>
+
+        <progress v-if="progress" :value="progress.percentage" max="100">
+            {{ progress.percentage }}%
+        </progress>
+
+        <div v-if="wasSuccessful">Saved!</div>
+    </Form>
+</template>
+@endboostsnippet
+@endverbatim
+
+@if($assist->inertia()->hasFormComponentResets())
+### Form Component Reset Props
+
+The `<Form>` component supports automatic resetting:
+
+- `resetOnError` - Reset form data when the request fails
+- `resetOnSuccess` - Reset form data when the request succeeds
+- `setDefaultsOnSuccess` - Update default values on success
+
+Use the `search-docs` tool with a query of `form component resetting` for detailed guidance.
+
+@verbatim
+@boostsnippet("Form with Reset Props", "vue")
+<script setup>
+import { Form } from '@inertiajs/vue3'
+</script>
+
+<template>
+    <Form
+        action="/users"
+        method="post"
+        reset-on-success
+        set-defaults-on-success
+        #default="{ errors, processing, wasSuccessful }"
+    >
+        <input type="text" name="name" />
+        <div v-if="errors.name">{{ errors.name }}</div>
+
+        <button type="submit" :disabled="processing">
+            Submit
+        </button>
+    </Form>
+</template>
+@endboostsnippet
+@endverbatim
+@else
+Note: This version of Inertia does not support `resetOnError`, `resetOnSuccess`, or `setDefaultsOnSuccess` on the `<Form>` component. Using these props will cause errors. Upgrade to Inertia v2.2.0+ to use these features.
+@endif
+
+Forms can also be built using the `useForm` composable for more programmatic control. Use the `search-docs` tool with a query of `useForm helper` for guidance.
+
+@endif
+
+### `useForm` Composable
+
+@if($assist->inertia()->hasFormComponent() === false)
+For Inertia v2.0.x: Build forms using the `useForm` composable as the `<Form>` component is not available until v2.1.0+.
+@else
+For more programmatic control or to follow existing conventions, use the `useForm` composable:
+@endif
+
+@verbatim
+@boostsnippet("useForm Composable Example", "vue")
+<script setup>
+import { useForm } from '@inertiajs/vue3'
+
+const form = useForm({
+    name: '',
+    email: '',
+    password: '',
+})
+
+function submit() {
+    form.post('/users', {
+        onSuccess: () => form.reset('password'),
+    })
+}
+</script>
+
+<template>
+    <form @submit.prevent="submit">
+        <input type="text" v-model="form.name" />
+        <div v-if="form.errors.name">{{ form.errors.name }}</div>
+
+        <input type="email" v-model="form.email" />
+        <div v-if="form.errors.email">{{ form.errors.email }}</div>
+
+        <input type="password" v-model="form.password" />
+        <div v-if="form.errors.password">{{ form.errors.password }}</div>
+
+        <button type="submit" :disabled="form.processing">
+            Create User
+        </button>
+    </form>
+</template>
+@endboostsnippet
+@endverbatim
+
+## Inertia v2 Features
+
+### Deferred Props
+
+Use deferred props to load data after initial page render:
+
+@verbatim
+@boostsnippet("Deferred Props with Empty State", "vue")
+<script setup>
+defineProps({
+    users: Array
+})
+</script>
+
+<template>
+    <div>
+        <h1>Users</h1>
+        <div v-if="!users" class="animate-pulse">
+            <div class="h-4 bg-gray-200 rounded w-3/4 mb-2"></div>
+            <div class="h-4 bg-gray-200 rounded w-1/2"></div>
+        </div>
+        <ul v-else>
+            <li v-for="user in users" :key="user.id">
+                {{ user.name }}
+            </li>
+        </ul>
+    </div>
+</template>
+@endboostsnippet
+@endverbatim
+
+### Polling
+
+Automatically refresh data at intervals:
+
+@verbatim
+@boostsnippet("Polling Example", "vue")
+<script setup>
+import { router } from '@inertiajs/vue3'
+import { onMounted, onUnmounted } from 'vue'
+
+defineProps({
+    stats: Object
+})
+
+let interval
+
+onMounted(() => {
+    interval = setInterval(() => {
+        router.reload({ only: ['stats'] })
+    }, 5000) // Poll every 5 seconds
+})
+
+onUnmounted(() => {
+    clearInterval(interval)
+})
+</script>
+
+<template>
+    <div>
+        <h1>Dashboard</h1>
+        <div>Active Users: {{ stats.activeUsers }}</div>
+    </div>
+</template>
+@endboostsnippet
+@endverbatim
+
+### WhenVisible
+
+Lazy-load a prop when an element scrolls into view. Useful for deferring expensive data that sits below the fold:
+
+@verbatim
+@boostsnippet("WhenVisible Example", "vue")
+<script setup>
+import { WhenVisible } from '@inertiajs/vue3'
+
+defineProps({
+    stats: Object
+})
+</script>
+
+<template>
+    <div>
+        <h1>Dashboard</h1>
+
+        <!-- stats prop is loaded only when this section scrolls into view -->
+        <WhenVisible data="stats" :buffer="200">
+            <template #fallback>
+                <div class="animate-pulse">Loading stats...</div>
+            </template>
+
+            <template #default="{ fetching }">
+                <div>
+                    <p>Total Users: {{ stats.total_users }}</p>
+                    <p>Revenue: {{ stats.revenue }}</p>
+                    <span v-if="fetching">Refreshing...</span>
+                </div>
+            </template>
+        </WhenVisible>
+    </div>
+</template>
+@endboostsnippet
+@endverbatim
+
+## Server-Side Patterns
+
+Server-side patterns (Inertia::render, props, middleware) are covered in inertia-laravel guidelines.
+
+## Common Pitfalls
+
+- Using traditional `<a>` links instead of Inertia's `<Link>` component (breaks SPA behavior)
+- Forgetting that Vue components must have a single root element
+- Forgetting to add loading states (skeleton screens) when using deferred props
+- Not handling the `undefined` state of deferred props before data loads
+- Using `<form>` without preventing default submission (use `<Form>` component or `@submit.prevent`)
+- Forgetting to check if `<Form>` component is available in your Inertia version