IFileFieldProps
Full prop surface for OrigamFileField — controls multiple selection, display mode (list/chips/counter), dropzone mode, upload progress, size display, custom icons and inherits the full IFieldProps and IInputProps surfaces.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- chipsboolean
- Render selected files as chips (shorthand for display="chips").
- counterboolean
- Show a file count indicator.
- counterSizeStringstring
- Custom size format string for the counter.
- counterStringstring
- Custom count format string for the counter.
- placeholderstring
- Placeholder text shown when no file is selected.
- persistentPlaceholderboolean
- Keep the placeholder visible even when a file is selected.
- persistentCounterboolean
- Keep the counter visible even when no file is selected.
- multipleboolean
- Allow multiple file selection.
- showSizeTFileSize
- Display file sizes. Pass 1000 (SI) or 1024 (binary).
- modelValueTFile
- v-model value — a File, FileList, or array of Files.
- chipPropsIChipProps
- Extra props forwarded to each chip when display="chips".
- dividerstring
- Separator string between file names in the inline text display.
- maxFileSizenumber
- Maximum allowed file size in bytes. Triggers error:max-size when exceeded.
- dragndropboolean
- Legacy alias for dropzone — enable drag-and-drop mode.
- iconColorstring
- Override the color of the file type icon.
- dragndropIconstring
- Icon shown in the dropzone area.
- fileIconstring
- Default icon for file items.
- removeIconstring
- Icon for the remove action on file items.
- downloadIconstring
- Icon for the download action on file items.
- downloadableboolean
- Show a download button on each file item.
- progressArray<number>
- Per-file upload progress values (0–100) indexed by file position.
- dropzoneTitlestring
- Title text displayed inside the dropzone.
- dropzoneSubtitlestring
- Subtitle text displayed inside the dropzone.
- maxFileSizeErrorStringstring
- Custom error message template for the max-size violation.
- displayTFileFieldDisplay
- How to render multi-file selections: list (default), chips, or counter.
- dropzoneboolean
- Render as a large outlined drag-and-drop zone instead of an inline input.
- browseTextstring
- Label for the browse/click-to-select action inside the dropzone.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Multi-file dropzone with progress and size display