Skip to content

feat(FormField): display multiple errors #4335

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: v3
Choose a base branch
from
Open

feat(FormField): display multiple errors #4335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5829aeb
feat(FormField): display multiple errors
romhml Jun 14, 2025
af25f65
test: update vue snapshots
romhml Jun 14, 2025
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
4 changes: 3 additions & 1 deletion playground/app/pages/components/form-field.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ const sizes = Object.keys(theme.variants.size) as Array<keyof typeof theme.varia

const feedbacks = [
{ description: 'This is a description' },
{ error: true },
{ error: 'This is an error' },
{ errors: ['This is an error', 'This is another error', 'This one is not visible'], maxErrors: 2 },
{ hint: 'This is a hint' },
{ help: 'Help! I need somebody!' },
{ required: true }
Expand All @@ -14,7 +16,7 @@ const feedbacks = [

<template>
<div class="flex flex-col items-center gap-4">
<div class="flex flex-col gap-4 ms-[-38px]">
<div class="flex flex-col gap-4 ms-[-92px]">
<div v-for="(feedback, count) in feedbacks" :key="count" class="flex items-center">
<UFormField v-bind="feedback" label="Email" name="email">
<UInput placeholder="[email protected]" />
Expand Down
48 changes: 43 additions & 5 deletions src/runtime/components/FormField.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@ export interface FormFieldProps {
description?: string
help?: string
error?: string | boolean

/**
* An array of errors for this field.
* Note that only one error is displayed by default. You can use `maxErrors` to control the number of displayed errors.
* @defaultValue `1`
*/
errors?: string[]

/**
* The maximum number of errors to display. If `false` or negative, display all available errors.
* @defaultValue `1`
*/
maxErrors?: number | false

hint?: string
/**
* @defaultValue 'md'
Expand All @@ -42,7 +56,7 @@ export interface FormFieldSlots {
description(props: { description?: string }): any
help(props: { help?: string }): any
error(props: { error?: string | boolean }): any
default(props: { error?: string | boolean }): any
default(props: { error?: string | boolean, errors?: string[] }): any
}
</script>

Expand All @@ -54,7 +68,7 @@ import { formFieldInjectionKey, inputIdInjectionKey } from '../composables/useFo
import { tv } from '../utils/tv'
import type { FormError, FormFieldInjectedOptions } from '../types/form'

const props = defineProps<FormFieldProps>()
const props = withDefaults(defineProps<FormFieldProps>(), { maxErrors: 1 })
const slots = defineSlots<FormFieldSlots>()

const appConfig = useAppConfig() as FormField['AppConfig']
Expand All @@ -66,7 +80,24 @@ const ui = computed(() => tv({ extend: tv(theme), ...(appConfig.ui?.formField ||

const formErrors = inject<Ref<FormError[]> | null>('form-errors', null)

const error = computed(() => props.error || formErrors?.value?.find(error => error.name && (error.name === props.name || (props.errorPattern && error.name.match(props.errorPattern))))?.message)
const errors = computed(() =>
(props.error && typeof props.error === 'string' ? [props.error] : props.errors)
|| formErrors?.value?.flatMap((error) => {
if (!error.name) return []
if (error.name === props.name || (props.errorPattern && error.name.match(props.errorPattern))) {
return [error.message]
}
return []
}))

const error = computed(() => errors.value?.[0] ?? props.error)

const displayedErrors = computed(() =>
props.maxErrors === false
|| (!!props.maxErrors && props.maxErrors < 0)
? errors.value
: errors.value?.slice(0, props.maxErrors)
)

const id = ref(useId())
// Copies id's initial value to bind aria-attributes such as aria-describedby.
Expand Down Expand Up @@ -113,9 +144,16 @@ provide(formFieldInjectionKey, computed(() => ({
</div>

<div :class="[(label || !!slots.label || description || !!slots.description) && ui.container({ class: props.ui?.container })]">
<slot :error="error" />
<slot :error="error" :errors="errors" />

<div v-if="(typeof error === 'string' && error) || !!slots.error" :id="`${ariaId}-error`" :class="ui.error({ class: props.ui?.error })">
<template v-if="(typeof error === 'string' && error)">
<div v-for="err in displayedErrors" :id="`${ariaId}-error`" :key="err" :class="ui.error({ class: props.ui?.error })">
<slot name="error" :error="err">
{{ err }}
</slot>
</div>
</template>
<div v-else-if="!!slots.error" :id="`${ariaId}-error`" :class="ui.error({ class: props.ui?.error })">
<slot name="error" :error="error">
{{ error }}
</slot>
Expand Down
4 changes: 4 additions & 0 deletions test/components/FormField.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ describe('FormField', () => {
['with required', { props: { label: 'Username', required: true } }],
['with help', { props: { help: 'Username must be unique' } }],
['with error', { props: { error: 'Username is already taken' } }],
['with multiple errors', { props: { errors: ['Username is already taken', 'This should not be visible'] } }],
['with maxErrors', { props: { maxErrors: 2, errors: ['Username is already taken', 'This should be visible'] } }],
['with maxErrors negative', { props: { maxErrors: -1, errors: ['Username is already taken', 'This should be visible', 'This should be visible'] } }],
['with maxErrors false', { props: { maxErrors: false, errors: ['Username is already taken', 'This should be visible', 'This should be visible'] } }],
['with hint', { props: { hint: 'Use letters, numbers, and special characters' } }],
...sizes.map((size: string) => [`with size ${size}`, { props: { label: 'Username', description: 'Enter your username', size } }]),
['with as', { props: { as: 'section' } }],
Expand Down
53 changes: 53 additions & 0 deletions test/components/__snapshots__/FormField-vue.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,59 @@ exports[`FormField > renders with label slot correctly 1`] = `
</div>"
`;

exports[`FormField > renders with maxErrors correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with maxErrors false correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with maxErrors negative correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with multiple errors correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
</div>
</div>"
`;

exports[`FormField > renders with required correctly 1`] = `
"<div class="text-sm">
<div class="">
Expand Down
53 changes: 53 additions & 0 deletions test/components/__snapshots__/FormField.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,59 @@ exports[`FormField > renders with label slot correctly 1`] = `
</div>"
`;

exports[`FormField > renders with maxErrors correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with maxErrors false correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with maxErrors negative correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
<div id="v-0-0-error" class="mt-2 text-error">This should be visible</div>
</div>
</div>"
`;

exports[`FormField > renders with multiple errors correctly 1`] = `
"<div class="text-sm">
<div class="">
<!--v-if-->
<!--v-if-->
</div>
<div class="">
<div id="v-0-0-error" class="mt-2 text-error">Username is already taken</div>
</div>
</div>"
`;

exports[`FormField > renders with required correctly 1`] = `
"<div class="text-sm">
<div class="">
Expand Down