File
The file input uses HTML's native file input. It allows users to select files from their device for upload. In addition to native input features, it adds support for:
- Drag and drop
- Clearing the input
- Repopulating from an array
Basic example
Load Live Example
Array value
The value of the file type should always be an array of objects where each object contains a name (string) and optional file (File) property. When selecting new files from a user’s device, FormKit will convert the native FileList to the required array-based structure automatically.
This structure can be used to pre-populate a file input with previously uploaded file values:
Load Live Example
Display only
Pre-populating an input with file names is for display purposes only. It’s an optional feature that provides a consistent interface to convey that a file was
previously
uploaded — however — a
FileList
is not attached to the actual
<input>
tag for upload.
Uploading files
The file upload process is left to your form’s submission handler. When submitting the form via full page request no further processing is necessary, however when submitting via XHR/Fetch request you will need to create an instance of FormData with the files attached. Here is a working example:
Load Live Example
Props & Attributes
The file input has a few unique props. There are also several commonly used native HTML attributes that assist in controlling file uploads.
| Prop | Type | Default | Description | ||
|---|---|---|---|---|---|
| Commonly used native attributes | |||||
| accept | -- | -- | View on MDN | ||
| capture | -- | -- | View on MDN | ||
| multiple | -- | -- | View on MDN | ||
| webkitdirectory | -- | -- | View on MDN | ||
| Props | |||||
| file-item-icon | String | ’’ | Specifies an icon to put in the fileItemIcon section. Only shows when there is a file selected. Defaults to the fileDoc icon. | ||
| file-remove-icon | String | ’’ | Specifies an icon to put in the fileRemoveIcon section. Only shows when a file is selected. Defaults to the close icon. | ||
| no-files-icon | String | ’’ | Specifies an icon to put in the noFilesIcon section. Only shows when no file is selected. Defaults to the fileDoc icon. | ||
| Show universal props | |||||
| config | Object | {} | Configuration options to provide to the input’s node and any descendent node of this input. | ||
| delay | Number | 20 | Number of milliseconds to debounce an input’s value before the commit hook is dispatched. | ||
| errors | Array | [] | Array of strings to show as error messages on this field. | ||
| help | String | '' | Text for help text associated with the input. | ||
| id | String | input_{n} | The unique id of the input. Providing an id also allows the input’s node to be globally accessed. | ||
| ignore | Boolean | false | Prevents an input from being included in any parent (group, list, form etc). Useful when using inputs for UI instead of actual values. | ||
| index | Number | undefined | Allows an input to be inserted at the given index if the parent is a list. If the input’s value is undefined, it inherits the value from that index position. If it has a value it inserts it into the lists’s values at the given index. | ||
| label | String | '' | Text for the label element associated with the input. | ||
| name | String | input_{n} | The name of the input as identified in the data object. This should be unique within a group of fields. | ||
| parent | FormKitNode | contextual | By default the parent is a wrapping group, list or form — but this props allows explicit assignment of the parent node. | ||
| prefix-icon | String | '' | Specifies an icon to put in the prefixIcon section. | ||
| preserve | boolean | false | Preserves the value of the input on a parent group, list, or form when the input unmounts. | ||
| preserve-errors | boolean | false | By default errors set on inputs using setErrors are automatically cleared on input, setting this prop to true maintains the error until it is explicitly cleared. | ||
| sections-schema | Object | {} | An object of section keys and schema partial values, where each schema partial is applied to the respective section. | ||
| suffix-icon | String | '' | Specifies an icon to put in the suffixIcon section. | ||
| type | String | text | The type of input to render from the library. | ||
| validation | String, Array | [] | The validation rules to be applied to the input. | ||
| validation-visibility | String | blur | Determines when to show an input's failing validation rules. Valid values are blur, dirty, and live. | ||
| validation-label | String | {label prop} | Determines what label to use in validation error messages, by default it uses the label prop if available, otherwise it uses the name prop. | ||
| validation-rules | Object | {} | Additional custom validation rules to make available to the validation prop. | ||
| value | Any | undefined | Seeds the initial value of an input and/or its children. Not reactive. Can seed entire groups (forms) and lists.. | ||
Sections
You can target a specific section of an input using that section's "key", allowing you to modify that section's
classes, HTML (via :sections-schema), or content (via slots). Read more about sections
here.
Single file diagram
Multiple file diagram
| Section-key | Description |
|---|---|
| fileList | A wrapper for the whole list of files. |
| fileItemIcon | An element containing an optional fileItem icon. |
| fileItem | An element containing the fileName and remove action for each file. |
| fileName | The element containing the name of a file. |
| fileRemove | The element that removes a file from the list. |
| fileRemoveIcon | An element containing the fileRemove icon. |
| noFiles | The element shown when there are no files selected. |
| noFilesIcon | An element containing an icon within the noFiles section. |
| Show universal section keys | |
| outer | The outermost wrapping element. |
| wrapper | A wrapper around the label and input. |
| label | The label of the input. |
| prefix | Has no output by default, but allows content directly before an input element. |
| prefixIcon | An element for outputting an icon before the prefix section. |
| inner | A wrapper around the actual input element. |
| suffix | Has no output by default, but allows content directly after an input element. |
| suffixIcon | An element for outputting an icon after the suffix section. |
| input | The input element itself. |
| help | The element containing help text. |
| messages | A wrapper around all the messages. |
| message | The element (or many elements) containing a message — most often validation and error messages. |