VFilePicker
Props
| Name | Type | Description |
|---|---|---|
| label | string | The label for the form element. |
| error-text | string | The error text for the form element. |
| helper-text | string | The helper text for the form element. |
| aria-current | Enum:pagesteplocationdatetimetruefalse | Indicates the element that represents the current item within a container or set of related elements. |
| disabled | boolean | Sets the element's disabled state. A disabled element will not be included during form submission. |
| initial-value | string | The initial value of the form. This value sets the value property only when the value property has not been explicitly set. |
| value | string | The 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. |
| name | string | The name of the element. This element's value will be surfaced during form submission under the provided name. |
| required | boolean | Require the field to be completed prior to form submission. |
| single-file | boolean | Single file state. |
| max-files | number | The max files that can be selected. |
| max-file-size | number | The max file size that can be selected. |
| accept | string | List of accepted files types |
| size | Enum:normalexpanded | The size the file-uploader should have. |
| invalid-file-type-error | string | Overrides the localized error message for invalid file type |
| max-files-exceeded-error | string | Overrides the localized error message for max file exceed |
| file-too-big-error | string | Overrides the localized error message for file too big |
Events
| Name | Event Type | Description |
|---|---|---|
| click | MouseEvent | Fires 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. |
| focus | FocusEvent | Fires when the element receives focus. |
| blur | FocusEvent | Fires when the element loses focus. |
| keydown | KeyboardEvent | Fires when a key is pressed. |
| keyup | KeyboardEvent | Fires when a key is released. |
| input | Event | Fires when the value of an element has been changed. |
| change | CustomEvent<undefined> | Emitted when a file is added or removed. |
Slots
| Name | Description |
|---|---|
| helper-text | Describes how to use the file-picker. Alternative to the helper-text attribute. |
Methods
| Name | Type | Description |
|---|---|---|
| singleFileChanged | () => unknown | |
| maxFilesChanged | (_oldValue: number,newValue: number) => void | |
| maxFileSizeChanged | (_oldValue: number,newValue: number) => void | |
| acceptChanged | (_oldValue: string,newValue: string) => void | |
| invalidFileTypeErrorChanged | (_oldValue: string,newValue: string) => void | |
| maxFilesExceededErrorChanged | (_oldValue: string,newValue: string) => void | |
| fileTooBigErrorChanged | (_oldValue: string,newValue: string) => void | |
| nameChanged | (previous: string,next: string) => unknown | |
| validate | () => void | |
| formResetCallback | () => void | |
| removeAllFiles | () => unknown | Removes all files from the File Picker. |