Skip to content

Make isDirty reactive to defaults #2236

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.

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
merged 4 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
},
"dependencies": {
"@inertiajs/core": "2.0.5",
"lodash.isequal": "^4.5.0"
"lodash.isequal": "^4.5.0",
"lodash.clonedeep": "^4.5.0"
}
}
2 changes: 2 additions & 0 deletions packages/react/src/useForm.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { FormDataConvertible, Method, Progress, router, VisitOptions } from '@inertiajs/core'
import cloneDeep from 'lodash.clonedeep'
import isEqual from 'lodash.isequal'
import { useCallback, useEffect, useRef, useState } from 'react'
import useRemember from './useRemember'
Expand Down Expand Up @@ -111,6 +112,7 @@ export default function useForm<TForm extends FormDataType>(
setHasErrors(false)
setWasSuccessful(true)
setRecentlySuccessful(true)
setDefaults(cloneDeep(data))
recentlySuccessfulTimeoutId.current = setTimeout(() => {
if (isMounted.current) {
setRecentlySuccessful(false)
Expand Down
29 changes: 29 additions & 0 deletions packages/react/test-app/Pages/FormHelper/Dirty.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { useForm } from '@inertiajs/react'

export default (props) => {
const form = useForm({ name: 'foo' })

const submit = () => {
form.post('')
}

return (
<div>
<div>Form is {form.isDirty ? 'dirty' : 'clean'}</div>
<label>
Full Name
<input
type="text"
id="name"
name="name"
onChange={(e) => form.setData('name', e.target.value)}
value={form.data.name}
/>
</label>

<button onClick={submit} className="submit">
Submit form
</button>
</div>
)
}
1 change: 1 addition & 0 deletions packages/svelte/src/useForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ export default function useForm<TForm extends FormDataType>(
this.clearErrors()
this.setStore('wasSuccessful', true)
this.setStore('recentlySuccessful', true)
this.defaults(cloneDeep(this.data()))
recentlySuccessfulTimeoutId = setTimeout(() => this.setStore('recentlySuccessful', false), 2000)

if (options.onSuccess) {
Expand Down
21 changes: 21 additions & 0 deletions packages/svelte/test-app/Pages/FormHelper/Dirty.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<script>
import { useForm } from '@inertiajs/svelte'

const form = useForm({
name: 'foo',
})

const submit = () => {
$form.post('')
}
</script>

<div>
<div>Form is {#if $form.isDirty}dirty{:else}clean{/if}</div>
<label>
Full Name
<input type="text" id="name" name="name" bind:value={$form.name} />
</label>

<button on:click={submit} class="submit">Submit form</button>
</div>
20 changes: 20 additions & 0 deletions packages/vue3/test-app/Pages/FormHelper/Dirty.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<script setup>
import { useForm } from '@inertiajs/vue3'
const form = useForm({ name: 'foo' })

const submit = () => {
form.post('')
}
</script>

<template>
<div>
<div>Form is <span v-if="form.isDirty">dirty</span><span v-else>clean</span></div>
<label>
Full Name
<input type="text" id="name" name="name" v-model="form.name" />
</label>

<button @click="submit" class="submit">Submit form</button>
</div>
</template>
9 changes: 9 additions & 0 deletions tests/app/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,15 @@ app.post('/form-helper/data', (req, res) =>
}),
)

app.get('/form-helper/dirty', (req, res) =>
inertia.render(req, res, {
component: 'FormHelper/Dirty',
props: {},
}),
)

app.post('/form-helper/dirty', (req, res) => res.redirect(303, '/form-helper/dirty'))

app.post('/form-helper/errors', (req, res) =>
inertia.render(req, res, {
component: 'FormHelper/Errors',
Expand Down
16 changes: 16 additions & 0 deletions tests/form-helper.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,22 @@ test.describe('Form Helper', () => {
})
})

test.describe('Dirty', () => {
test.beforeEach(async ({ page }) => {
pageLoads.watch(page)
page.goto('/form-helper/dirty')
})

test('can check if the form is dirty', async ({ page }) => {
await expect(page.getByText('Form is clean')).toBeVisible()
await page.fill('#name', 'Joe')
await expect(page.locator('#name')).toHaveValue('Joe')
await expect(page.getByText('Form is dirty')).toBeVisible()
await page.getByRole('button', { name: 'Submit form' }).click()
await expect(page.getByText('Form is clean')).toBeVisible()
})
})

test.describe('Data', () => {
test.beforeEach(async ({ page }) => {
pageLoads.watch(page)
Expand Down
Loading