Skip to content
On this page

VFilePicker

Props

NameTypeDescription
labelstringThe label for the form element.
error-textstringThe error text for the form element.
helper-textstringThe helper text for the form element.
aria-currentEnum:
page
step
location
date
time
true
false
Indicates the element that represents the current item within a container or set of related elements.
disabledbooleanSets the element's disabled state. A disabled element will not be included during form submission.
initial-valuestringThe initial value of the form. This value sets the value property only when the value property has not been explicitly set.
valuestringThe current value of the element. This property serves as a mechanism to set the value property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.
namestringThe name of the element. This element's value will be surfaced during form submission under the provided name.
requiredbooleanRequire the field to be completed prior to form submission.
max-filesnumberThe max files that can be selected.
max-file-sizenumberThe max file size that can be selected.
acceptstringList of accepted files types
sizeEnum:
normal
expanded
The size the file-uploader should have.

Events

NameEvent TypeDescription
clickMouseEventFires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
focusFocusEventFires when the element receives focus.
blurFocusEventFires when the element loses focus.
keydownKeyboardEventFires when a key is pressed.
keyupKeyboardEventFires when a key is released.
inputEventFires when the value of an element has been changed.
changeCustomEvent<undefined>Emitted when a file is added or removed.

Slots

NameDescription
helper-textDescribes how to use the file-picker. Alternative to the helper-text attribute.

Methods

NameTypeDescription
maxFilesChanged(_oldValue: number,newValue: number) => void
maxFileSizeChanged(_oldValue: number,newValue: number) => void
acceptChanged(_oldValue: string,newValue: string) => void
nameChanged(previous: string,next: string) => unknown
validate() => void
formResetCallback() => void