Blazorise File Picker API
Explore the Blazorise File Picker API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the File Picker documentation.
API
Parameters
| Parameter | Default | Type |
|---|---|---|
AutoReset | false | bool |
If true file input will be automatically reset after it has being uploaded. | ||
ButtonsTemplate | null | RenderFragment<FilePickerButtonsContext> |
Provides a custom content for upload, clear and cancel buttons. | ||
ChildTemplate | null | RenderFragment |
Input content. | ||
Directory | false | bool |
Determines whether file picker should upload directories. | ||
Disabled | false | bool |
Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter. | ||
DisableProgressReport | false | bool |
Determines whether report progress should be disabled. By enabling this setting, Progressed and Written callbacks won't be called. Internal file progress won't be tracked. This setting can speed up file transfer considerably. | ||
Feedback | null | RenderFragment |
Placeholder for validation messages. | ||
FilePickerLocalizer | null | TextLocalizerHandler |
Function used to handle custom localization that will override a default ITextLocalizer. | ||
FileTemplate | null | RenderFragment<FilePickerFileContext> |
Provides a custom file content. | ||
Filter | — | string |
Specifies the types of files that the input accepts. See w3schools.com. | ||
MaxChunkSize | 20 * 1024 | int |
Specifies the max chunk size when uploading the file. | ||
MaxFileSize | long.MaxValue | long |
Maximum file size in bytes, checked before starting upload (note: never trust client, always check file size at server-side). Defaults to long.MaxValue. | ||
Multiple | false | bool |
Enables the multiple file selection. | ||
Placeholder | — | string |
Sets the placeholder for the empty file input. | ||
ReadOnly | false | bool |
Add the readonly boolean attribute on an input to prevent modification of the input value. | ||
SegmentFetchTimeout | TimeSpan.FromMinutes( 1 ) | TimeSpan |
Specifies the Segment Fetch Timeout when uploading the file. | ||
ShowMode | List | FilePickerShowMode |
Specifies FilePicker's show mode. Defaults to List Possible values: ListDropdown | ||
Events
| Event | Type |
|---|---|
Changed | EventCallback<FileChangedEventArgs> |
Occurs every time the selected file has changed, including when the reset operation is executed. | |
Ended | EventCallback<FileEndedEventArgs> |
Notifies when an individual file upload has ended. | |
Progressed | EventCallback<FileProgressedEventArgs> |
Notifies the progress of file being written to the destination stream. | |
Started | EventCallback<FileStartedEventArgs> |
Notifies when an individual file upload has started. | |
Upload | EventCallback<FileUploadEventArgs> |
Occurs once the FilePicker's Upload is triggered for every file. | |
Written | EventCallback<FileWrittenEventArgs> |
Occurs every time the part of file has being written to the destination stream. | |
Methods
| Method | Return | Parameters |
|---|---|---|
Cancel | Task | bool confirm |
Cancels any ongoing upload operation.
| ||
Clear | Task | bool confirm |
Clears the FileInput by resetting the state.
| ||
GetFileSizeReadable | string | IFileEntry file |
Converts the file size in bytes into a proper human readable format.
| ||
GetFileStatus | string | IFileEntry file |
Gets the File Status
| ||
GetLocalizedString | string | string name |
Gets a FilePicker Localized string.
| ||
GetProgressPercentage | int | — |
Gets progress for percentage display.
| ||
IsBusy | bool | — |
Tracks whether the FilePicker is busy and user interaction should be disabled.
| ||
IsFileBeingUploaded | bool | IFileEntry file |
Tracks whether the current file is being uploaded.
| ||
IsUploadReady | bool | — |
Tracks whether the FilePicker has files ready to upload.
| ||
RemoveFile | Task | IFileEntry file, bool confirm |
Removes the file from FileInput.
| ||
UploadAll | Task | — |
Uploads the current files.
| ||
UploadFile | Task | IFileEntry file, bool forceUpload |
Uploads a single file if the status is set to ready.
| ||