BlogPlaygroundOne

VFileUploadDropzone API


Props
name
type
default
string | number | boolean
false

Applies utility border classes to the component. To use it, you need to omit the border- prefix, (for example use border-sm as border="sm"). Find a list of the built-in border classes on the borders page.

string
'$vuetify.fileUpload.browse'

Text for the browse button.

boolean
false

Allows for the component to be cleared.

string | number
undefined

Milliseconds to wait before closing component. Only applies to hover and focus events.

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.

'default' | 'comfortable' | 'compact'
'default'

Adjusts the vertical height used by the component.

boolean
false

Removes the ability to click or target the component.

string
'$vuetify.fileUpload.divider'

Text in the divider.

string | number
undefined

Designates an elevation applied to the component between 0 and 5. You can find more information on the elevation page.

boolean
false

Puts the dropzone in an error state, changing the border color.

string | number
undefined

Sets the height for the component.

boolean
false

Hides the browse button.

  | string
  | (new () => any)
  | FunctionalComponent
  | (string | [string, number])[]
'$upload'

Apply a specific icon using the v-icon component.

boolean
false

Renders the file list inside the dropzone container instead of below it.

string | number
150

Sets the dividers length. Default unit is px.

Anchor
undefined

Specifies the component’s location. Can combine by using a space separated string.

string | number
undefined

Sets the maximum height for the component.

string | number
undefined

Sets the maximum width for the component.

string | number
undefined

Sets the minimum height for the component.

string | number
undefined

Sets the minimum width for the component.

File[]
[]

The v-model value of the component. If component supports the multiple prop, this defaults to an empty array.

boolean
false

Allows multiple files to be uploaded.

string | number
undefined

Sets the component’s opacity value

string | number
undefined

Milliseconds to wait before opening component. Only applies to hover and focus events.

'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'
undefined

Sets the position for the component.

string | number | boolean
undefined

Designates the border-radius applied to the component. This can be 0, xs, sm, true, lg, xl, pill, circle, and shaped. Find more information on available border radius classes on the Border Radius page.

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.

boolean
false

Shows the size of the file.

string
undefined

Specify a subtitle text for the component.

string | (new () => any) | FunctionalComponent
'div'

Specify a custom tag used on the root element.

string
undefined

Specify a theme for this component and all of its children.

string | number
undefined

Sets the dividers thickness. Default unit is px.

boolean
false

Removes any applied border-radius from the component.

string
'$vuetify.fileUpload.title'

Specify a title text for the component.

string | number
undefined

Sets the width for the component.

Events
name
type
[]

Emitted when the browse button is clicked.

[number]

Emitted when a file’s remove button is clicked.

[File[]]

Emitted when files are dropped onto the dropzone.

Slots
{ props: { onClick: (e: MouseEvent) => void } }
{ isDragging: boolean hasFiles: boolean files: File[] props: { onClick: () => void } }
never
never
never
{ file: File; props: { 'onClick:remove': () => void } }
{ file: File; props: { 'onClick:remove': () => void } }
never

Slot for the browse button.

The default Vue slot.

Slot for the divider between icon and the browse button.

Slot to replace the default upload icon.

Slot to replace the native file input.

Define a custom item appearance.

Slot for customizing the appearance of a single file when using inset file list mode.

Slot for the component’s title content.