SiFileDropzoneComponent documentation¶
selector
si-file-dropzoneInput Properties¶
| Name | Type | Default | Description |
|---|---|---|---|
| accept ¶ | string | Define which file types are suggested in file browser. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-accept | |
| acceptText ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.ACCEPTED_FILE_TYPES:Accepted file types` | Text or translation key for accepted types. |
| directoryUpload ¶ | boolean | false | Enable directory upload. |
| errorTextFileMaxSize ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.ERROR_FILE_SIZE_EXCEEDED:File exceeds allowed maximum size` | Message or translation key if file exceeds the maximum file size limit. |
| errorTextFileType ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.ERROR_FILE_TYPE:Incorrect file type selected` | Text or translation key of message title if incorrect file type is dragged / dropped. |
| maxFileSize ¶ | number | Define maximal allowed file size in bytes. | |
| maxFileSizeText ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.MAX_SIZE:Maximum upload size` | Text or translation key for max file size. |
| multiple ¶ | boolean | false | Defines whether the file input allows selecting multiple files. When directoryUpload is enabled, this will have no effect. |
| uploadDropText ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.DROP:Drop files here or` | Text or translation key of the drag&drop field (is combined with the uploadTextFileSelect ). |
| uploadTextFileSelect ¶ | TranslatableString | $localize`:@@SI_FILE_UPLOADER.FILE_SELECT:click to upload` | Text or translation key of the input file selector (is combined with the uploadTextRest ). |
Output Properties¶
| Name | Type | Description |
|---|---|---|
| filesAdded ¶ | UploadFile[] | Event emitted when files are added. |
Attributes and Methods¶
| Name | Type | Default | Description |
|---|---|---|---|
| reset() ¶ | () => void | Reset all the files inside the native file input (and therefore the dropzone). |
Types Documentation¶
| Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality. |
|---|
| Copyright (c) Siemens 2016 - 2025 SPDX-License-Identifier: MIT | |||||||
|---|---|---|---|---|---|---|---|
|
Translatable import imported from @siemens/element-translate-ng |
|---|
Except where otherwise noted, content on this site is licensed under MIT License.