---
title: "Types"
description: "Every public type exported by notform, with its shape and where it is used."
canonical_url: "https://notformdocs.vercel.app/docs/reference/types"
---

> Index of every page on this site: [llms.txt](https://notformdocs.vercel.app/llms.txt)

All types are exported from `notform` and are available through TypeScript in both Vue and Nuxt projects. In Nuxt, add `notform` as a direct dependency to import them. See [Nuxt module](https://notformdocs.vercel.app/docs/getting-started/nuxt-module#import-types).

## Schema types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        FormSchema
      </code>
    </td>
    
    <td>
      A Standard Schema whose input and output are both objects. The constraint <code>
        useForm
      </code>
      
       places on <code>
        schema
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        SchemaInput<TSchema>
      </code>
    </td>
    
    <td>
      The data the schema accepts: the shape of <code>
        form.values
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        SchemaOutput<TSchema>
      </code>
    </td>
    
    <td>
      The data the schema produces: the shape <code>
        onSubmit
      </code>
      
       receives.
    </td>
  </tr>
</tbody>
</table>

## Form types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        FormConfig<TSchema>
      </code>
    </td>
    
    <td>
      The options object accepted by <code>
        useForm
      </code>
      
      : <code>
        schema
      </code>
      
      , <code>
        initialValues
      </code>
      
      , <code>
        initialErrors
      </code>
      
      , <code>
        onSubmit
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        UseFormInstance<TSchema>
      </code>
    </td>
    
    <td>
      The public form instance returned by <code>
        useForm
      </code>
      
      . Use this to type props and variables that hold a form.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FormInstance<TSchema>
      </code>
    </td>
    
    <td>
      The wider form type, including members that are not part of the public contract. Prefer <code>
        UseFormInstance
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FormProps<TSchema>
      </code>
      
      / <code>
        FormSlots
      </code>
    </td>
    
    <td>
      Props and slots of <code>
        Form
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Field types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        FieldConfig
      </code>
    </td>
    
    <td>
      Per-field behavior, passed to <code>
        form.field()
      </code>
      
       and <code>
        form.arrayField()
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FieldEvents
      </code>
    </td>
    
    <td>
      The handlers in <code>
        field.events
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FieldValidationEvent
      </code>
    </td>
    
    <td>
      <code>
        'blur' | 'change' | 'input'
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FieldInstance<TValue>
      </code>
    </td>
    
    <td>
      A field bound to one value.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FieldProps<TValue>
      </code>
      
       / <code>
        FieldSlots<TValue>
      </code>
    </td>
    
    <td>
      Props and slots of <code>
        Field
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        FieldErrorProps
      </code>
      
       / <code>
        FieldErrorSlots
      </code>
    </td>
    
    <td>
      Props and slots of <code>
        FieldError
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Array field types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        ArrayFieldInstance<TItem>
      </code>
    </td>
    
    <td>
      A <code>
        FieldInstance<TItem[]>
      </code>
      
       plus <code>
        items
      </code>
      
      , <code>
        append
      </code>
      
      , <code>
        prepend
      </code>
      
      , <code>
        insert
      </code>
      
      , <code>
        remove
      </code>
      
      , <code>
        move
      </code>
      
      , <code>
        swap
      </code>
      
      , <code>
        update
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        ArrayItemInstance<TItem>
      </code>
    </td>
    
    <td>
      One item. A <code>
        FieldInstance<TItem>
      </code>
      
       plus <code>
        index
      </code>
      
      , <code>
        field(path, config?)
      </code>
      
      , and <code>
        arrayField(path, config?)
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        ArrayFieldProps<TItem>
      </code>
      
       / <code>
        ArrayFieldSlots<TItem>
      </code>
    </td>
    
    <td>
      Props and slots of <code>
        ArrayField
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        ArrayItem<TArray>
      </code>
    </td>
    
    <td>
      The item type of an array type.
    </td>
  </tr>
</tbody>
</table>

## Path types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        InputPath<TSchema>
      </code>
    </td>
    
    <td>
      Every valid dot-notation path into the input.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        InputArrayPath<TSchema>
      </code>
    </td>
    
    <td>
      Input paths that point at an array.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        InputPathValue<TSchema, TPath>
      </code>
    </td>
    
    <td>
      The input type at a path.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        OutputPath<TSchema>
      </code>
    </td>
    
    <td>
      Every valid path into the output.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        OutputPathValue<TSchema, TPath>
      </code>
    </td>
    
    <td>
      The output type at a path.
    </td>
  </tr>
</tbody>
</table>

Path types recurse to a depth of 10.

## Validation types

<table>
<thead>
  <tr>
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        ValidationIssue
      </code>
    </td>
    
    <td>
      A Standard Schema issue: <code>
        { message: string, path?: ReadonlyArray<PropertyKey | { key: PropertyKey }> }
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        ValidationResult<TValue>
      </code>
    </td>
    
    <td>
      <code>
        { value: TValue }
      </code>
      
       on success, <code>
        { issues }
      </code>
      
       on failure. Returned by <code>
        form.validate()
      </code>
      
       and <code>
        field.validate()
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Sitemap

See the full [sitemap](https://notformdocs.vercel.app/sitemap.md) for all pages.