IFileFieldProps
interface
Form & Input
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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- 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.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Multi-file dropzone with progress and size display