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.

typescript

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.

chips
boolean
Render selected files as chips (shorthand for display="chips").
counter
boolean
Show a file count indicator.
counterSizeString
string
Custom size format string for the counter.
counterString
string
Custom count format string for the counter.
placeholder
string
Placeholder text shown when no file is selected.
persistentPlaceholder
boolean
Keep the placeholder visible even when a file is selected.
persistentCounter
boolean
Keep the counter visible even when no file is selected.
multiple
boolean
Allow multiple file selection.
showSize
TFileSize
Display file sizes. Pass 1000 (SI) or 1024 (binary).
modelValue
TFile
v-model value — a File, FileList, or array of Files.
chipProps
IChipProps
Extra props forwarded to each chip when display="chips".
divider
string
Separator string between file names in the inline text display.
maxFileSize
number
Maximum allowed file size in bytes. Triggers error:max-size when exceeded.
dragndrop
boolean
Legacy alias for dropzone — enable drag-and-drop mode.
iconColor
string
Override the color of the file type icon.
dragndropIcon
string
Icon shown in the dropzone area.
fileIcon
string
Default icon for file items.
removeIcon
string
Icon for the remove action on file items.
downloadIcon
string
Icon for the download action on file items.
downloadable
boolean
Show a download button on each file item.
progress
Array<number>
Per-file upload progress values (0–100) indexed by file position.
dropzoneTitle
string
Title text displayed inside the dropzone.
dropzoneSubtitle
string
Subtitle text displayed inside the dropzone.
maxFileSizeErrorString
string
Custom error message template for the max-size violation.
display
TFileFieldDisplay
How to render multi-file selections: list (default), chips, or counter.
dropzone
boolean
Render as a large outlined drag-and-drop zone instead of an inline input.
browseText
string
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

vue