---
title: "Form"
description: "A form component with built-in validation and submission handling."
canonical_url: "https://vinicunca.dev/pohon/components/form"
---
# Form

> A form component with built-in validation and submission handling.

## Usage

Use the Form component to validate form data using any validation library supporting [Standard Schema](https://github.com/standard-schema/standard-schema) such as [Valibot](https://github.com/fabian-hiller/valibot), [Zod](https://github.com/colinhacks/zod), [Regle](https://github.com/victorgarciaesgi/regle), [Yup](https://github.com/jquense/yup), [Joi](https://github.com/hapijs/joi) or [Superstruct](https://github.com/ianstormtaylor/superstruct) or your own validation logic.

It works with the [FormField](https://vinicunca.dev/pohon/components/form-field) component to display error messages around form elements automatically.

### Schema validation

It requires two props:

- `state` - a reactive object holding the form's state.
- `schema` - any [Standard Schema](https://github.com/standard-schema/standard-schema) or [Superstruct](https://github.com/ianstormtaylor/superstruct).

> [!WARNING]
> 
> **No validation library is included** by default, ensure you **install the one you need**.

```vue [FormExampleValibot.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as v from 'valibot';

const schema = v.object({
  email: v.pipe(v.string(), v.email('Invalid email')),
  password: v.pipe(v.string(), v.minLength(8, 'Must be at least 8 characters')),
});

type Schema = v.InferOutput<typeof schema>;

const state = reactive({
  email: '',
  password: '',
});

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

```vue [FormExampleZod.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as z from 'zod';

const schema = z.object({
  email: z.email('Invalid email'),
  password: z.string('Password is required').min(8, 'Must be at least 8 characters'),
});

type Schema = z.output<typeof schema>;

const state = reactive<Partial<Schema>>({
  email: undefined,
  password: undefined,
});

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

```vue [FormExampleRegle.vue]
<script setup lang="ts">
import type { InferInput } from '@regle/core';
import type { FormSubmitEvent } from 'pohon-ui';
import { useRegle } from '@regle/core';
import { email, minLength, required, withMessage } from '@regle/rules';

const { r$ } = useRegle({ email: '', password: '' }, {
  email: { required, email: withMessage(email, 'Invalid email') },
  password: { required, minLength: withMessage(minLength(8), 'Must be at least 8 characters') },
});

type Schema = InferInput<typeof r$>;

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="r$"
    :state="r$.$value"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="r$.$value.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="r$.$value.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

```vue [FormExampleYup.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import type { InferType } from 'yup';
import { object, string } from 'yup';

const schema = object({
  email: string().email('Invalid email').required('Required'),
  password: string()
    .min(8, 'Must be at least 8 characters')
    .required('Required'),
});

type Schema = InferType<typeof schema>;

const state = reactive({
  email: undefined,
  password: undefined,
});

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

```vue [FormExampleJoi.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import Joi from 'joi';

const schema = Joi.object({
  email: Joi.string().required(),
  password: Joi.string()
    .min(8)
    .required(),
});

const state = reactive({
  email: undefined,
  password: undefined,
});

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<typeof state>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

```vue [FormExampleSuperstruct.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import type { Infer } from 'superstruct';
import { nonempty, object, refine, string } from 'superstruct';

const schema = object({
  email: nonempty(string()),
  password: refine(string(), 'Password', (value) => {
    if (value.length >= 8) {
      return true;
    }
    return 'Must be at least 8 characters';
  }),
});

const state = reactive({
  email: '',
  password: '',
});

type Schema = Infer<typeof schema>;

async function onSubmit(event: FormSubmitEvent<Schema>) {
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

### Custom validation

Use the `validate` prop to apply your own validation logic.

The validation function must return a list of errors with the following attributes:

- `message` - the error message to display.
- `name` - the `name` of the `FormField` to send the error to.

> [!TIP]
> 
> It can be used alongside the `schema` prop to handle complex use cases.

```vue [FormExampleBasic.vue]
<script setup lang="ts">
import type { FormError, FormSubmitEvent } from 'pohon-ui';

const state = reactive({
  email: undefined,
  password: undefined,
});

type Schema = typeof state;

function validate(state: Partial<Schema>): Array<FormError> {
  const errors = [];
  if (!state.email) {
    errors.push({ name: 'email', message: 'Required' });
  }
  if (!state.password) {
    errors.push({ name: 'password', message: 'Required' });
  }
  return errors;
}

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :validate="validate"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

### Error reporting

Errors are matched to the corresponding [FormField](https://vinicunca.dev/pohon/components/form-field) using its `name` prop. An error on the `email` field is shown by `<FormField name="email">`.

Nested fields are matched using dot notation. A schema like `{ user: z.object({ email: z.string() }) }` will be applied to `<FormField name="user.email">`.

> [!WARNING]
> 
> Errors on array items include the index in their name (e.g. `tags.0`, `tags.1`) and won't match `<FormField name="tags">` by `name` alone. Use the `error-pattern` prop with a regular expression like `/^tags\..+/` to capture them. This is especially useful for components like [InputTags](https://vinicunca.dev/pohon/components/input-tags).

```vue [FormExampleErrorPattern.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as z from 'zod';

const schema = z.object({
  email: z.email('Invalid email'),
  tags: z.array(z.string().regex(/^[a-z-]+$/, 'Lowercase letters and dashes only')).min(1, 'Please add at least one tag'),
});

type Schema = z.output<typeof schema>;

const state = reactive<Partial<Schema>>({
  email: undefined,
  tags: [],
});

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :schema="schema"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Tags"
      name="tags"
      :error-pattern="/^tags\..+/"
    >
      <PInputTags v-model="state.tags" />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

### Input events

The Form component automatically triggers validation when an input emits an `input`, `change`, or `blur` event.

- Validation on `input` occurs **as you type**.
- Validation on `change` occurs when you **commit to a value**.
- Validation on `blur` happens when an input **loses focus**.

You can control when validation happens this using the `validate-on` prop.

> [!TIP]
> 
> The form always validates on submit.

```vue [FormExampleElements.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as z from 'zod';

const schema = z.object({
  input: z.string({ message: 'Please enter your email' }).min(10, 'Must be at least 10 characters'),
  inputNumber: z.number({ message: 'Please enter a number' }).min(10, 'Must be at least 10'),
  inputMenu: z.any().refine((option) => option?.value === 'option-2', {
    message: 'Please select Option 2',
  }),
  inputMenuMultiple: z.any().refine((values) => !!values?.find((option: any) => option.value === 'option-2'), {
    message: 'Option 2 must be included',
  }),
  textarea: z.string({ message: 'Please enter a message' }).min(10, 'Must be at least 10 characters'),
  select: z.string({ message: 'Please select an option' }).refine((value) => value === 'option-2', {
    message: 'Please select Option 2',
  }),
  selectMultiple: z.array(z.string(), { message: 'Please select at least one option' }).refine((values) => values.includes('option-2'), {
    message: 'Option 2 must be included',
  }),
  selectMenu: z.any().refine((option) => option?.value === 'option-2', {
    message: 'Please select Option 2',
  }),
  selectMenuMultiple: z.any().refine((values) => !!values?.find((option: any) => option.value === 'option-2'), {
    message: 'Option 2 must be included',
  }),
  switch: z.boolean().refine((value) => value === true, {
    message: 'Must be enabled',
  }),
  checkbox: z.boolean().refine((value) => value === true, {
    message: 'Must be checked',
  }),
  radioGroup: z.string({ message: 'Please select an option' }).refine((value) => value === 'option-2', {
    message: 'Please select Option 2',
  }),
  checkboxGroup: z.any().refine((values) => !!values?.find((option: any) => option === 'option-2'), {
    message: 'Option 2 must be included',
  }),
  listbox: z.any().refine((option) => option?.value === 'option-2', {
    message: 'Please select Option 2',
  }),
  listboxMultiple: z.any().refine((values) => !!values?.find((option: any) => option.value === 'option-2'), {
    message: 'Option 2 must be included',
  }),
  inputTags: z.array(z.string(), { message: 'Please add at least one tag' }).min(1, 'Please add at least one tag'),
  inputDate: z.any().refine((value) => !!value, {
    message: 'Please select a date',
  }),
  inputTime: z.any().refine((value) => !!value, {
    message: 'Please select a time',
  }),
  slider: z.number().min(1, 'Must be greater than 0').max(20, 'Must be less than 20'),
  rating: z.number().min(1, 'Please select a rating'),
  pin: z.string().regex(/^\d$/, 'Must be a digit').array().length(5, 'All 5 digits are required'),
  file: z.file({ message: 'Please upload a file' }).min(1, 'File is required').max(1024 * 1024, 'File must be less than 1MB').mime('image/png', 'Only PNG images are allowed'),
});

type Schema = z.input<typeof schema>;

const state = reactive<Partial<Schema>>({
  switch: false,
  checkbox: false,
  slider: 0,
  rating: 0,
  pin: [],
});

const form = useTemplateRef('form');

const items = [
  { label: 'Option 1', value: 'option-1' },
  { label: 'Option 2', value: 'option-2' },
  { label: 'Option 3', value: 'option-3' },
];

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    ref="form"
    :state="state"
    :schema="schema"
    class="w-full"
    @submit="onSubmit"
  >
    <div class="gap-4 grid md:grid-cols-3 sm:grid-cols-2">
      <PFormField
        label="Input"
        name="input"
      >
        <PInput
          v-model="state.input"
          placeholder="you@example.com"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="inputNumber"
        label="InputNumber"
      >
        <PInputNumber
          v-model="state.inputNumber"
          placeholder="Enter a number"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="pin"
        label="PinInput"
        :error-pattern="/(pin)\..*/"
      >
        <PPinInput
          v-model="state.pin"
          placeholder="○"
        />
      </PFormField>

      <PFormField
        name="inputDate"
        label="InputDate"
      >
        <PInputDate
          v-model="state.inputDate"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="inputTime"
        label="InputTime"
      >
        <PInputTime
          v-model="state.inputTime"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="inputTags"
        label="InputTags"
      >
        <PInputTags
          v-model="state.inputTags"
          placeholder="Add a tag..."
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="inputMenu"
        label="InputMenu"
      >
        <PInputMenu
          v-model="state.inputMenu"
          :items="items"
          placeholder="Search an option..."
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="inputMenuMultiple"
        label="InputMenu (Multiple)"
      >
        <PInputMenu
          v-model="state.inputMenuMultiple"
          multiple
          :items="items"
          placeholder="Search options..."
          class="w-full"
        />
      </PFormField>

      <PFormField
        label="Textarea"
        name="textarea"
      >
        <PTextarea
          v-model="state.textarea"
          placeholder="Write your message..."
          class="w-full"
          :rows="1"
        />
      </PFormField>

      <PFormField
        name="select"
        label="Select"
      >
        <PSelect
          v-model="state.select"
          :items="items"
          placeholder="Choose an option"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="selectMultiple"
        label="Select (Multiple)"
      >
        <PSelect
          v-model="state.selectMultiple"
          multiple
          :items="items"
          placeholder="Choose options"
          class="w-full"
        />
      </PFormField>

      <div class="hidden md:block" />

      <PFormField
        name="selectMenu"
        label="SelectMenu"
      >
        <PSelectMenu
          v-model="state.selectMenu"
          :items="items"
          placeholder="Search an option..."
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="selectMenuMultiple"
        label="SelectMenu (Multiple)"
      >
        <PSelectMenu
          v-model="state.selectMenuMultiple"
          multiple
          :items="items"
          placeholder="Search options..."
          class="w-full"
        />
      </PFormField>

      <div class="hidden md:block" />

      <PFormField
        name="listbox"
        label="Listbox"
      >
        <PListbox
          v-model="state.listbox"
          :items="items"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="listboxMultiple"
        label="Listbox (Multiple)"
      >
        <PListbox
          v-model="state.listboxMultiple"
          :items="items"
          multiple
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="file"
        label="FileUpload"
      >
        <PFileUpload
          v-model="state.file"
          label="Drop your image here"
          description="PNG (max. 1MB)"
          class="w-full"
        />
      </PFormField>

      <PFormField
        name="checkbox"
        label="Checkbox"
      >
        <PCheckbox
          v-model="state.checkbox"
          label="Check me"
        />
      </PFormField>

      <PFormField
        name="switch"
        label="Switch"
      >
        <PSwitch
          v-model="state.switch"
          label="Switch me"
        />
      </PFormField>

      <PFormField
        name="slider"
        label="Slider"
      >
        <PSlider
          v-model="state.slider"
          class="mt-2.5"
        />
      </PFormField>

      <PFormField
        name="rating"
        label="InputRating"
      >
        <PInputRating v-model="state.rating" />
      </PFormField>

      <PFormField name="checkboxGroup">
        <PCheckboxGroup
          v-model="state.checkboxGroup"
          legend="CheckboxGroup"
          :items="items"
        />
      </PFormField>

      <PFormField name="radioGroup">
        <PRadioGroup
          v-model="state.radioGroup"
          legend="RadioGroup"
          :items="items"
        />
      </PFormField>
    </div>

    <div class="mt-8 flex gap-2">
      <PButton type="submit">
        Submit
      </PButton>

      <PButton
        variant="outline"
        @click="form?.clear()"
      >
        Clear
      </PButton>
    </div>
  </PForm>
</template>
```

> [!TIP]
> 
> You can use the `useFormField` composable to implement this inside your own components.

### Error event

You can listen to the `@error` event to handle errors. This event is triggered when the form is submitted and contains an array of `FormError` objects with the following fields:

- `id` - the input's `id`.
- `name` - the `name` of the `FormField`
- `message` - the error message to display.

Here's an example that focuses the first input element with an error after the form is submitted:

```vue [FormExampleOnError.vue]
<script setup lang="ts">
import type { FormError, FormErrorEvent, FormSubmitEvent } from 'pohon-ui';

const state = reactive({
  email: undefined,
  password: undefined,
});

type Schema = typeof state;

function validate(state: Partial<Schema>): Array<FormError> {
  const errors = [];
  if (!state.email) {
    errors.push({ name: 'email', message: 'Required' });
  }
  if (!state.password) {
    errors.push({ name: 'password', message: 'Required' });
  }
  return errors;
}

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}

async function onError(event: FormErrorEvent) {
  if (event?.errors?.[0]?.id) {
    const element = document.getElementById(event.errors[0].id);
    element?.focus();
    element?.scrollIntoView({ behavior: 'smooth', block: 'center' });
  }
}
</script>

<template>
  <PForm
    :validate="validate"
    :state="state"
    class="space-y-4"
    @submit="onSubmit"
    @error="onError"
  >
    <PFormField
      label="Email"
      name="email"
    >
      <PInput v-model="state.email" />
    </PFormField>

    <PFormField
      label="Password"
      name="password"
    >
      <PInput
        v-model="state.password"
        type="password"
      />
    </PFormField>

    <PButton type="submit">
      Submit
    </PButton>
  </PForm>
</template>
```

### HTML5 validation

When calling `form.submit()` programmatically, the Form component automatically triggers native HTML5 validation before submission.

> [!NOTE]
> 
> This is particularly useful when the submit button is outside the form element, such as in a modal footer.

```vue [FormExampleHtml5Validation.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';

const state = reactive({
  email: undefined,
  age: undefined,
});

type Schema = typeof state;

const form = useTemplateRef('form');

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <div class="space-y-4">
    <PForm
      ref="form"
      :state="state"
      class="space-y-4"
      @submit="onSubmit"
    >
      <PFormField
        label="Email"
        name="email"
      >
        <PInput
          v-model="state.email"
          type="email"
          required
        />
      </PFormField>

      <PFormField
        label="Age"
        name="age"
      >
        <PInput
          v-model="state.age"
          type="number"
          min="18"
          max="100"
          required
        />
      </PFormField>
    </PForm>

    <PButton @click="form?.submit()">
      Submit
    </PButton>
  </div>
</template>
```

### Nesting forms

Use the `nested` prop to nest multiple Form components and link their validation functions. In this case, validating the parent form will automatically validate all the other forms inside it.

Nested forms directly inherit their parent's state, so you don't need to define a separate state for them. You can use the `name` prop to target a nested attribute within the parent's state.

It can be used to dynamically add fields based on user's input:

```vue [FormExampleNested.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as z from 'zod';

const schema = z.object({
  name: z.string().min(2),
  news: z.boolean().default(false),
});

type Schema = z.output<typeof schema>;

const nestedSchema = z.object({
  email: z.email(),
});

type NestedSchema = z.output<typeof nestedSchema>;

const state = reactive<Partial<Schema & NestedSchema>>({ });

const toast = useToast();
async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    ref="form"
    :state="state"
    :schema="schema"
    class="flex flex-col gap-4 w-60"
    @submit="onSubmit"
  >
    <PFormField
      label="Name"
      name="name"
    >
      <PInput
        v-model="state.name"
        placeholder="John Lennon"
      />
    </PFormField>

    <div>
      <PCheckbox
        v-model="state.news"
        name="news"
        label="Register to our newsletter"
        @update:model-value="state.email = undefined"
      />
    </div>

    <PForm
      v-if="state.news"
      :schema="nestedSchema"
      nested
    >
      <PFormField
        label="Email"
        name="email"
      >
        <PInput
          v-model="state.email"
          placeholder="john@lennon.com"
        />
      </PFormField>
    </PForm>

    <div>
      <PButton type="submit">
        Submit
      </PButton>
    </div>
  </PForm>
</template>
```

Or to validate list inputs:

```vue [FormExampleNestedList.vue]
<script setup lang="ts">
import type { FormSubmitEvent } from 'pohon-ui';
import * as z from 'zod';

const schema = z.object({
  customer: z.string().min(2),
});

type Schema = z.output<typeof schema>;

const itemSchema = z.object({
  description: z.string().min(1),
  price: z.number().min(0),
});

type ItemSchema = z.output<typeof itemSchema>;

const state = reactive<Partial<Schema & { items: Array<Partial<ItemSchema>> }>>({ });

function addItem() {
  if (!state.items) {
    state.items = [];
  }
  state.items.push({});
}

function removeItem() {
  if (state.items) {
    state.items.pop();
  }
}

const toast = useToast();

async function onSubmit(event: FormSubmitEvent<Schema>) {
  toast.add({ title: 'Success', description: 'The form has been submitted.', color: 'success' });
  console.log(event.data);
}
</script>

<template>
  <PForm
    :state="state"
    :schema="schema"
    class="flex flex-col gap-4 w-60"
    @submit="onSubmit"
  >
    <PFormField
      label="Customer"
      name="customer"
    >
      <PInput
        v-model="state.customer"
        placeholder="Wonka Industries"
      />
    </PFormField>

    <PForm
      v-for="item, count in state.items"
      :key="count"
      :name="`items.${count}`"
      :schema="itemSchema"
      class="flex gap-2"
      nested
    >
      <PFormField
        :label="!count ? 'Description' : undefined"
        name="description"
      >
        <PInput v-model="item.description" />
      </PFormField>
      <PFormField
        :label="!count ? 'Price' : undefined"
        name="price"
        class="w-20"
      >
        <PInput
          v-model="item.price"
          type="number"
        />
      </PFormField>
    </PForm>

    <div class="flex gap-2">
      <PButton
        color="neutral"
        variant="subtle"
        size="sm"
        @click="addItem()"
      >
        Add Item
      </PButton>

      <PButton
        color="neutral"
        variant="ghost"
        size="sm"
        @click="removeItem()"
      >
        Remove Item
      </PButton>
    </div>
    <div>
      <PButton type="submit">
        Submit
      </PButton>
    </div>
  </PForm>
</template>
```

## API

### Props

```ts
/**
 * Props for the Form component
 */
interface FormProps {
}
```

> [!NOTE]
> See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attributes
> 
> This component also supports all native `<form>` HTML attributes.

### Slots

```ts
/**
 * Slots for the Form component
 */
interface FormSlots {
}
```

### Emits

No events available for this component.

### Expose

You can access the typed component instance using [`useTemplateRef`](https://vuejs.org/api/composition-api-helpers.html#usetemplateref).

```vue
<script setup lang="ts">
const form = useTemplateRef('form');
</script>

<template>
  <PForm ref="form" />
</template>
```

This will give you access to the following:

| Name | Type |
| --- | --- |
| `submit()` | `Promise<void>` <br> Triggers form submission with HTML5 validation. |
| `validate(opts: { name?: keyof T \| (keyof T)[], silent?: boolean, nested?: boolean, transform?: boolean })` | `Promise<T>` <br> Triggers form validation. Will raise any errors unless `opts.silent` is set to true. |
| `clear(path?: keyof T \| RegExp)` | `void` <br> Clears form errors associated with a specific path. If no path is provided, clears all form errors. |
| `getErrors(path?: keyof T \| RegExp)` | `FormErrorWithId[]` <br> Retrieves form errors associated with a specific path. If no path is provided, returns all form errors. |
| `setErrors(errors: FormError[], name?: keyof T \| RegExp)` | `void` <br> Sets form errors for a given path. If no path is provided, overrides all errors. |
| `errors` | `Ref<FormErrorWithId[]>` <br> A reference to the array containing validation errors. Use this to access or manipulate the error information. |
| `disabled` | `Ref<boolean>` |
| `dirty` | `Ref<boolean>` `true` if at least one form field has been updated by the user. |
| `dirtyFields` | `ReadonlySet<DeepReadonly<keyof T>>` Tracks fields that have been modified by the user. |
| `touchedFields` | `ReadonlySet<DeepReadonly<keyof T>>` Tracks fields that the user interacted with. |
| `blurredFields` | `ReadonlySet<DeepReadonly<keyof T>>` Tracks fields blurred by the user. |

## Theme

```ts [app.config.ts]
export default defineAppConfig({
  ui: {
    form: {
      base: ''
    }
  }
})
```

## Changelog

See commit history for [component](https://github.com/vinicunca/pohon/commits/main/src/runtime/components/Form.vue) and [theme](https://github.com/vinicunca/pohon/commits/main/src/theme/form.ts).

---

- [GitHub](https://github.com/vinicunca/pohon/blob/main/src/runtime/components/Form.vue)


## Sitemap

See the full [sitemap](https://vinicunca.dev/sitemap.md) for all pages.