@inertiajs/svelte - npm Package Compare versions

Comparing version 2.3.16 to 2.3.17

resources/boost/guidelines/core.blade.php

+# Inertia + Svelte
+
+- IMPORTANT: Activate `inertia-svelte-development` when working with Inertia Svelte client-side patterns.

resources/boost/sk...rtia-svelte-development/SKILL.blade.php

+---
+name: inertia-svelte-development
+description: "Develops Inertia.js v2 Svelte client-side applications. Activates when creating Svelte pages, forms, or navigation; using Link, Form, or router; working with deferred props, prefetching, or polling; or when user mentions Svelte with Inertia, Svelte pages, Svelte forms, or Svelte navigation."
+license: MIT
+metadata:
+  author: laravel
+---
+@php
+/** @var \Laravel\Boost\Install\GuidelineAssist $assist */
+@endphp
+# Inertia Svelte Development
+
+## When to Apply
+
+Activate this skill when:
+
+- Creating or modifying Svelte page components for Inertia
+- Working with forms in Svelte (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 Svelte-specific features with the Inertia protocol
+
+## Documentation
+
+Use `search-docs` for detailed Inertia v2 Svelte patterns and documentation.
+
+## Basic Usage
+
+### Page Components Location
+
+Svelte page components should be placed in the `{{ $assist->inertia()->pagesDirectory() }}` directory.
+
+### Page Component Structure
+
+@boostsnippet("Basic Svelte Page Component", "svelte")
+<script>
+export let users
+</script>
+
+<div>
+    <h1>Users</h1>
+    <ul>
+        {#each users as user (user.id)}
+            <li>{user.name}</li>
+        {/each}
+    </ul>
+</div>
+@endboostsnippet
+
+## Client-Side Navigation
+
+### Basic Link Component
+
+Use `<Link>` for client-side navigation instead of traditional `<a>` tags:
+
+@boostsnippet("Inertia Svelte Navigation", "svelte")
+<script>
+import { Link } from '@inertiajs/svelte'
+</script>
+
+<Link href="/">Home</Link>
+<Link href="/users">Users</Link>
+<Link href={`/users/${user.id}`}>View User</Link>
+@endboostsnippet
+
+### Link With Method
+
+@boostsnippet("Link With POST Method", "svelte")
+<script>
+import { Link } from '@inertiajs/svelte'
+</script>
+
+<Link href="/logout" method="post">Logout</Link>
+@endboostsnippet
+
+### Prefetching
+
+Prefetch pages to improve perceived performance:
+
+@boostsnippet("Prefetch on Hover", "svelte")
+<script>
+import { Link } from '@inertiajs/svelte'
+</script>
+
+<Link href="/users" prefetch>Users</Link>
+@endboostsnippet
+
+### Programmatic Navigation
+
+@boostsnippet("Router Visit", "svelte")
+<script>
+import { router } from '@inertiajs/svelte'
+
+function handleClick() {
+    router.visit('/users')
+}
+
+// Or with options
+function createUser() {
+    router.visit('/users', {
+        method: 'post',
+        data: { name: 'John' },
+        onSuccess: () => console.log('Success!'),
+    })
+}
+</script>
+@endboostsnippet
+
+## Form Handling
+
+@if($assist->inertia()->hasFormComponent())
+### Form Component (Recommended)
+
+The recommended way to build forms is with the `<Form>` component:
+
+@boostsnippet("Form Component Example", "svelte")
+<script>
+import { Form } from '@inertiajs/svelte'
+</script>
+
+<Form action="/users" method="post" let:errors let:processing let:wasSuccessful>
+    <input type="text" name="name" />
+    {#if errors.name}
+        <div>{errors.name}</div>
+    {/if}
+
+    <input type="email" name="email" />
+    {#if errors.email}
+        <div>{errors.email}</div>
+    {/if}
+
+    <button type="submit" disabled={processing}>
+        {processing ? 'Creating...' : 'Create User'}
+    </button>
+
+    {#if wasSuccessful}
+        <div>User created!</div>
+    {/if}
+</Form>
+@endboostsnippet
+
+### Form Component With All Props
+
+@boostsnippet("Form Component Full Example", "svelte")
+<script>
+import { Form } from '@inertiajs/svelte'
+</script>
+
+<Form
+    action="/users"
+    method="post"
+    let:errors
+    let:hasErrors
+    let:processing
+    let:progress
+    let:wasSuccessful
+    let:recentlySuccessful
+    let:clearErrors
+    let:resetAndClearErrors
+    let:defaults
+    let:isDirty
+    let:reset
+    let:submit
+>
+    <input type="text" name="name" value={defaults.name} />
+    {#if errors.name}
+        <div>{errors.name}</div>
+    {/if}
+
+    <button type="submit" disabled={processing}>
+        {processing ? 'Saving...' : 'Save'}
+    </button>
+
+    {#if progress}
+        <progress value={progress.percentage} max="100">
+            {progress.percentage}%
+        </progress>
+    {/if}
+
+    {#if wasSuccessful}
+        <div>Saved!</div>
+    {/if}
+</Form>
+@endboostsnippet
+
+@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.
+
+@boostsnippet("Form With Reset Props", "svelte")
+<script>
+import { Form } from '@inertiajs/svelte'
+</script>
+
+<Form
+    action="/users"
+    method="post"
+    resetOnSuccess
+    setDefaultsOnSuccess
+    let:errors
+    let:processing
+    let:wasSuccessful
+>
+    <input type="text" name="name" />
+    {#if errors.name}
+        <div>{errors.name}</div>
+    {/if}
+
+    <button type="submit" disabled={processing}>
+        Submit
+    </button>
+</Form>
+@endboostsnippet
+@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` hook for more programmatic control. Use the `search-docs` tool with a query of `useForm helper` for guidance.
+
+@endif
+
+### `useForm` Hook
+
+@if($assist->inertia()->hasFormComponent() === false)
+For Inertia v2.0.x: Build forms using the `useForm` hook as the `<Form>` component is not available until v2.1.0+.
+@else
+For more programmatic control or to follow existing conventions, use the `useForm` hook:
+@endif
+
+@boostsnippet("useForm Example", "svelte")
+<script>
+import { useForm } from '@inertiajs/svelte'
+
+const form = useForm({
+    name: '',
+    email: '',
+    password: '',
+})
+
+function submit() {
+    $form.post('/users', {
+        onSuccess: () => $form.reset('password'),
+    })
+}
+</script>
+
+<form on:submit|preventDefault={submit}>
+    <input type="text" bind:value={$form.name} />
+    {#if $form.errors.name}
+        <div>{$form.errors.name}</div>
+    {/if}
+
+    <input type="email" bind:value={$form.email} />
+    {#if $form.errors.email}
+        <div>{$form.errors.email}</div>
+    {/if}
+
+    <input type="password" bind:value={$form.password} />
+    {#if $form.errors.password}
+        <div>{$form.errors.password}</div>
+    {/if}
+
+    <button type="submit" disabled={$form.processing}>
+        Create User
+    </button>
+</form>
+@endboostsnippet
+
+## Inertia v2 Features
+
+### Deferred Props
+
+Use deferred props to load data after initial page render:
+
+@boostsnippet("Deferred Props with Empty State", "svelte")
+<script>
+export let users
+</script>
+
+<div>
+    <h1>Users</h1>
+    {#if !users}
+        <div 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>
+    {:else}
+        <ul>
+            {#each users as user (user.id)}
+                <li>{user.name}</li>
+            {/each}
+        </ul>
+    {/if}
+</div>
+@endboostsnippet
+
+### Polling
+
+Automatically refresh data at intervals:
+
+@boostsnippet("Polling Example", "svelte")
+<script>
+import { router } from '@inertiajs/svelte'
+import { onMount, onDestroy } from 'svelte'
+
+export let stats
+
+let interval
+
+onMount(() => {
+    interval = setInterval(() => {
+        router.reload({ only: ['stats'] })
+    }, 5000) // Poll every 5 seconds
+})
+
+onDestroy(() => {
+    clearInterval(interval)
+})
+</script>
+
+<div>
+    <h1>Dashboard</h1>
+    <div>Active Users: {stats.activeUsers}</div>
+</div>
+@endboostsnippet
+
+### WhenVisible
+
+Lazy-load a prop when an element scrolls into view. Useful for deferring expensive data that sits below the fold:
+
+@boostsnippet("WhenVisible Example", "svelte")
+<script>
+import { WhenVisible } from '@inertiajs/svelte'
+
+export let stats
+</script>
+
+<div>
+    <h1>Dashboard</h1>
+
+    <!-- stats prop is loaded only when this section scrolls into view -->
+    <WhenVisible data="stats" buffer={200}>
+        <div>
+            <p>Total Users: {stats.total_users}</p>
+            <p>Revenue: {stats.revenue}</p>
+        </div>
+
+        <svelte:fragment slot="fallback">
+            <div class="animate-pulse">Loading stats...</div>
+        </svelte:fragment>
+    </WhenVisible>
+</div>
+@endboostsnippet
+
+## 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 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 `on:submit|preventDefault`)
+- Forgetting to check if `<Form>` component is available in your Inertia version

package.json

 {
   "name": "@inertiajs/svelte",
-  "version": "2.3.16",
+  "version": "2.3.17",
   "license": "MIT",
@@ -22,3 +22,4 @@ "description": "The Svelte adapter for Inertia.js",
     "!dist/**/*.test.*",
-    "!dist/**/*.spec.*"
+    "!dist/**/*.spec.*",
+    "resources"
   ],
@@ -40,10 +41,10 @@ "type": "module",
     "@sveltejs/adapter-auto": "^3.3.1",
-    "@sveltejs/kit": "^2.52.2",
+    "@sveltejs/kit": "^2.53.2",
     "@sveltejs/package": "^2.5.7",
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
     "axios": "^1.13.5",
-    "es-check": "^9.5.4",
+    "es-check": "^9.6.1",
     "publint": "^0.3.17",
     "svelte": "^4.2.20",
-    "svelte-check": "^4.3.6",
+    "svelte-check": "^4.4.4",
     "tslib": "^2.8.1",
@@ -60,3 +61,3 @@ "typescript": "^5.9.3",
     "lodash-es": "^4.17.23",
-    "@inertiajs/core": "2.3.16"
+    "@inertiajs/core": "2.3.17"
   },
@@ -63,0 +64,0 @@ "scripts": {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

88083

11.75%

Number of package files

41

5.13%

Dependency changes

• + Added

  @inertiajs/core@2.3.17
  (transitive)

• - Removed

  @inertiajs/core@2.3.16
  (transitive)

• Updated

  @inertiajs/core@2.3.17