Skip to content
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
15 changes: 7 additions & 8 deletions src/runtime/components/Form.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<script lang="ts">
import type { DeepReadonly } from 'vue'
import type { AppConfig } from '@nuxt/schema'
import theme from '#build/ui/form'
import type { FormSchema, FormError, FormInputEvents, FormErrorEvent, FormSubmitEvent, FormEvent, Form, FormErrorWithId, InferInput, InferOutput, FormData } from '../types/form'
Expand Down Expand Up @@ -64,7 +63,7 @@ export interface FormSlots {
</script>

<script lang="ts" setup generic="S extends FormSchema, T extends boolean = true">
import { provide, inject, nextTick, ref, onUnmounted, onMounted, computed, useId, readonly } from 'vue'
import { provide, inject, nextTick, ref, onUnmounted, onMounted, computed, useId, readonly, reactive } from 'vue'
import { useEventBus } from '@vueuse/core'
import { useAppConfig } from '#imports'
import { formOptionsInjectionKey, formInputsInjectionKey, formBusInjectionKey, formLoadingInjectionKey } from '../composables/useFormField'
Expand Down Expand Up @@ -155,9 +154,9 @@ provide('form-errors', errors)
const inputs = ref<{ [P in keyof I]?: { id?: string, pattern?: RegExp } }>({})
provide(formInputsInjectionKey, inputs as any)

const dirtyFields = new Set<keyof I>()
const touchedFields = new Set<keyof I>()
const blurredFields = new Set<keyof I>()
const dirtyFields: Set<keyof I> = reactive(new Set<keyof I>())
const touchedFields: Set<keyof I> = reactive(new Set<keyof I>())
const blurredFields: Set<keyof I> = reactive(new Set<keyof I>())

function resolveErrorIds(errs: FormError[]): FormErrorWithId[] {
return errs.map(err => ({
Expand Down Expand Up @@ -302,9 +301,9 @@ defineExpose<Form<S>>({
loading,
dirty: computed(() => !!dirtyFields.size),

dirtyFields: readonly(dirtyFields) as DeepReadonly<Set<keyof I>>,
blurredFields: readonly(blurredFields) as DeepReadonly<Set<keyof I>>,
touchedFields: readonly(touchedFields) as DeepReadonly<Set<keyof I>>
dirtyFields: readonly(dirtyFields),
blurredFields: readonly(blurredFields),
touchedFields: readonly(touchedFields)
})
</script>

Expand Down
6 changes: 3 additions & 3 deletions src/runtime/types/form.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ export interface Form<S extends FormSchema> {
dirty: ComputedRef<boolean>
loading: Ref<boolean>

dirtyFields: DeepReadonly<Set<keyof FormData<S, false>>>
touchedFields: DeepReadonly<Set<keyof FormData<S, false>>>
blurredFields: DeepReadonly<Set<keyof FormData<S, false>>>
dirtyFields: ReadonlySet<DeepReadonly<keyof FormData<S, false>>>
touchedFields: ReadonlySet<DeepReadonly<keyof FormData<S, false>>>
blurredFields: ReadonlySet<DeepReadonly<keyof FormData<S, false>>>
}

export type FormSchema<I extends object = object, O extends object = I> =
Expand Down
63 changes: 62 additions & 1 deletion test/components/Form.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { reactive, ref, nextTick } from 'vue'
import { reactive, ref, nextTick, watch } from 'vue'
import { describe, it, expect, test, beforeEach, vi } from 'vitest'
import { mountSuspended } from '@nuxt/test-utils/runtime'
import * as z from 'zod'
Expand Down Expand Up @@ -304,6 +304,67 @@ describe('Form', () => {
expect(form.value.blurredFields.has('email')).toBe(true)
expect(form.value.blurredFields.has('password')).toBe(false)
})

test('reactivity: touchedFields works on focus', async () => {
const emailInput = wrapper.find('#emailInput')

const mockWatchCallback = vi.fn()
watch(() => form.value.touchedFields, mockWatchCallback, { deep: true })

emailInput.trigger('focus')
await flushPromises()
expect(mockWatchCallback).toHaveBeenCalledTimes(1)
expect(mockWatchCallback.mock.calls[0][0].has('email')).toBe(true)
expect(mockWatchCallback.mock.calls[0][0].has('password')).toBe(false)
})

test('reactivity: touchedFields works on change', async () => {
const emailInput = wrapper.find('#emailInput')

const mockWatchCallback = vi.fn()
watch(() => form.value.touchedFields, mockWatchCallback, { deep: true })

emailInput.trigger('change')
await flushPromises()
expect(mockWatchCallback).toHaveBeenCalledTimes(1)
expect(mockWatchCallback.mock.calls[0][0].has('email')).toBe(true)
expect(mockWatchCallback.mock.calls[0][0].has('password')).toBe(false)
})

test('reactivity: blurredFields works', async () => {
const emailInput = wrapper.find('#emailInput')

const mockWatchCallback = vi.fn()
watch(() => form.value.blurredFields, mockWatchCallback, { deep: true })

emailInput.trigger('blur')
await flushPromises()
expect(mockWatchCallback).toHaveBeenCalledTimes(1)
expect(mockWatchCallback.mock.calls[0][0].has('email')).toBe(true)
expect(mockWatchCallback.mock.calls[0][0].has('password')).toBe(false)
})

test('reactivity: dirtyFields works', async () => {
const emailInput = wrapper.find('#emailInput')
const mockWatchCallback = vi.fn()
watch(() => form.value.dirtyFields, mockWatchCallback, { deep: true })

emailInput.trigger('change')
await flushPromises()
expect(mockWatchCallback).toHaveBeenCalledTimes(1)
expect(mockWatchCallback.mock.calls[0][0].has('email')).toBe(true)
expect(mockWatchCallback.mock.calls[0][0].has('password')).toBe(false)
})

test('reactivity: dirty works', async () => {
const emailInput = wrapper.find('#emailInput')
expect(form.value.dirty).toBe(false)

emailInput.trigger('change')
await flushPromises()

expect(form.value.dirty).toBe(true)
})
})

describe('nested', async () => {
Expand Down