IFileFieldSlots
interface
Slots
Slot signatures for OrigamFileField — extends IFieldSlots and IInputSlots with file-specific slots: counter, field, dropzone, item, chip and selection.
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.
- counter(data: { counter: string, value: string | number, max?: string | number }) => any
- Custom counter display.
- field(data: { id: string, isDisabled: boolean, isDirty: boolean, isValid: boolean | undefined, isReadonly: boolean }) => any
- Replace the inner field content.
- dropzone(data: { isDragging: boolean, browse: () => void }) => any
- Custom dropzone content — isDragging reflects drag-over state, browse() opens the file picker.
- item(data: { file: File, index: number, progress: number, remove: () => void, download: () => void }) => any
- Custom list item renderer for each selected file.
- chip(data: { fileNames: string, totalBytes: number, totalBytesReadable: string, props: Record<string, any> }) => any
- Custom chip renderer when display="chips".
- selection() => any
- Fully replace the selected-files display area.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom dropzone slot with drag indicator