VFileUpload API

Props

name	type	default
`append-icon`	\| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	undefined
Creates a v-icon component after default content in the append slot.
`base-color`	string	undefined
Sets the color of the input when it is not focused.
`browse-text`	string	'$vuetify.fileUpload.browse'
Text for the browse button.
`center-affix`	boolean	true
Vertically align appendInner, prependInner, clearIcon and label in the center.
`clearable`	boolean	false
Allows for the component to be cleared.
`color`	string	undefined
Applies specified color to the control - supports utility colors with or without `text-` prefix (for example `success`, `purple` or `text-purple`) or CSS color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the colors page.
`density`	'default' \| 'comfortable' \| 'compact'	'default'
Adjusts the vertical height used by the component.
`disabled`	boolean	null
Removes the ability to click or target the component.
`divider-text`	string	'$vuetify.fileUpload.divider'
Text in the divider.
`error`	boolean	false
Puts the input in a manual error state.
`error-messages`	string \| string[]	[]
Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the rules prop. This field will not trigger validation.
`filter-by-type` New in v3.10.0	string	undefined
Make the input accept only files matched by one or more unique file type specifiers. Applies to drag & drop and selecting folders. Emits `rejected` event when some files do not pass through to make it possible to notify user and deliver better user experience.
`focused`	boolean	false
Forces a focused state styling on the component.
`glow`	boolean	false
Makes prepend/append icons full opacity when the input is focused and apply color.
`hide-browse`	boolean	false
Hides the browse button.
`hide-details`	boolean \| 'auto'	false
Hides hint and validation errors. When set to `auto` messages will be rendered only if there’s a message (hint, error message, counter value etc) to display.
`hide-spin-buttons`	boolean	false
Hides spin buttons on the input when type is set to `number`.
`hint`	string	undefined
Displays hint text below the input when focused. Force this always open with the persistent-hint property.
`icon`	\| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	'$upload'
Apply a specific icon using the v-icon component.
`icon-color`	string \| boolean	false
Sets the color of the prepend/append icons.
`id`	string	undefined
Sets the DOM id on the component.
`indent-details`	boolean	null
Adds / removes inline padding in inputs details. Useful when trying to align different variants of fields and selection controls.
`inset-file-list`	boolean	false
Renders the file list inside the dropzone container instead of below it.
`label`	string	undefined
Sets the text of the v-label or v-field-label component.
`max-errors`	string \| number	1
Control the maximum number of shown errors from validation.
`max-width`	string \| number	undefined
Sets the maximum width for the component.
`messages`	string \| string[]	[]
Displays a list of messages or a single message if using a string.
`min-width`	string \| number	undefined
Sets the minimum width for the component.
`model-value`	File \| File[]	null
The v-model value of the component. If component supports the multiple prop, this defaults to an empty array.
`multiple`	boolean	false
Allows multiple files to be uploaded.
`name`	string	undefined
Sets the component’s name attribute.
`persistent-hint`	boolean	false
Forces hint to always be visible.
`prepend-icon`	\| string \| (string \| [string, number])[] \| (new () => any) \| FunctionalComponent	undefined
Prepends an icon to the component, uses the same syntax as `v-icon`.
`readonly`	boolean	null
Puts input in readonly state.
`rules`	( \| string \| boolean \| PromiseLike<ValidationResult> \| ((value: any) => string \| false \| true) \| ((value: any) => PromiseLike<ValidationResult>) \| [string, any, string] )[]	[]
Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`.
`scrim`	string \| boolean	true
Determines whether an overlay is used when hovering over the component with files. Accepts true/false to enable background, and string to define color.
`show-size`	boolean	false
Shows the size of the file.
`subtitle`	string	undefined
Specify a subtitle text for the component.
`theme`	string	undefined
Specify a theme for this component and all of its children.
`title`	string	'$vuetify.fileUpload.title'
Specify a title text for the component.
`validate-on`	\| 'eager' \| 'lazy' \| 'blur' \| 'input' \| 'submit' \| 'invalid-input' \| 'blur lazy' \| 'input lazy' \| 'submit lazy' \| 'invalid-input lazy' \| 'blur eager' \| 'input eager' \| 'submit eager' \| 'invalid-input eager' \| 'lazy blur' \| 'lazy input' \| 'lazy submit' \| 'lazy invalid-input' \| 'eager blur' \| 'eager input' \| 'eager submit' \| 'eager invalid-input'	undefined
Change what type of event triggers validation to run.
`validation-value`	any	undefined
The value used when applying validation rules.
`width`	string \| number	undefined
Sets the width for the component.

Events

name	type
`click:append`	[MouseEvent]
Emitted when appended icon is clicked.
`click:prepend`	[MouseEvent]
Emitted when prepended icon is clicked.
`rejected`	[File[]]
Emitted when some of the files from user input, drop or folder selection did not pass through `strict-accept` filter.
`update:focused`	[boolean]
Event that is emitted when the component’s focus state changes.
`update:modelValue`	[File[]]
Event that is emitted when the component’s model changes.

Slots

{
  id: ComputedRef<string>
  messagesId: ComputedRef<string | undefined>
  isDirty: ComputedRef<boolean>
  isDisabled: ComputedRef<boolean>
  isReadonly: ComputedRef<boolean>
  isPristine: Ref<boolean, boolean>
  isValid: ComputedRef<boolean | null>
  isValidating: Ref<boolean, boolean>
  hasDetails: Ref<boolean, boolean>
  reset: () => void
  resetValidation: () => void
  validate: () => void
}

{ props: { onClick: (e: MouseEvent) => void } }

never

{
  id: ComputedRef<string>
  messagesId: ComputedRef<string | undefined>
  isDirty: ComputedRef<boolean>
  isDisabled: ComputedRef<boolean>
  isReadonly: ComputedRef<boolean>
  isPristine: Ref<boolean, boolean>
  isValid: ComputedRef<boolean | null>
  isValidating: Ref<boolean, boolean>
  hasDetails: Ref<boolean, boolean>
  reset: () => void
  resetValidation: () => void
  validate: () => void
}

never

never

{
  inputNode: VNode<RendererNode, RendererElement, { [key: string]: any }>
}

{ file: File; props: { 'onClick:remove': () => void } }

{ message: string }

{
  id: ComputedRef<string>
  messagesId: ComputedRef<string | undefined>
  isDirty: ComputedRef<boolean>
  isDisabled: ComputedRef<boolean>
  isReadonly: ComputedRef<boolean>
  isPristine: Ref<boolean, boolean>
  isValid: ComputedRef<boolean | null>
  isValidating: Ref<boolean, boolean>
  hasDetails: Ref<boolean, boolean>
  reset: () => void
  resetValidation: () => void
  validate: () => void
}

{ file: File; props: { 'onClick:remove': () => void } }

never

`append`
Adds an item inside the input and after input content.
`browse`
Slot for the browse button.
`default`
The default Vue slot.
`details`
Slot for custom input details to modifying the display of messages.
`divider`
Slot for the divider between icon and the browse button.
`icon`
Slot for a custom appearance in icon section.
`input`
Define a custom native input.
`item`
Define a custom item appearance.
`message`
Slot used to customize the message content.
`prepend`
Adds an item outside the input and before input content.
`single`
Slot for customizing the appearance of a single file when using inset file list mode.
`title`
Slot for the component’s title content.

Exposed

HTMLInputElement

string[]

boolean

() => Promise<void>

() => Promise<void>

(silent: boolean) => Promise<string[]>

`controlRef`
Reference to the underlying input control element.
`errorMessages`
An array of error messages that were set by the `setErrors` method.
`isValid`
Boolean indicating if the input is valid.
`reset`
Resets the input value.
`resetValidation`
Resets validation of the input without modifying its value.
`validate`
Validates the input’s value.

#VFileUpload API

VFileUpload API