API reference
blocks/upload-queue
Import
Section titled “Import”import * as api from "@fungi.computer/caps/blocks/upload-queue";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | UploadQueueAction | LAW — queue thumbnails are decorative. The adjacent filename is the row’s accessible file fact; lifecycle status, progress, and actions remain named. |
| type alias | UploadQueueActions | Caller-owned labels for the row actions that may be shown. |
| type alias | UploadQueueItem | Caller-provided upload queue item data. |
| type alias | UploadQueuePreview | A caller-provided file or image preview for one upload row. |
| type alias | UploadQueueProps | Props accepted by UploadQueue. |
| function | UploadQueue() | Product-neutral upload facts and affordances; lifecycle stays with the host. |
UploadQueueActiontype alias
Section titled “UploadQueueAction”type UploadQueueAction = Readonly<{ accessibleLabel: string; label: string;}>;LAW — queue thumbnails are decorative. The adjacent filename is the row’s accessible file fact; lifecycle status, progress, and actions remain named.
UploadQueueActionstype alias
Section titled “UploadQueueActions”type UploadQueueActions = Readonly<{ cancel?: UploadQueueAction; remove?: UploadQueueAction; retry?: UploadQueueAction;}>;Caller-owned labels for the row actions that may be shown.
UploadQueueItemtype alias
Section titled “UploadQueueItem”type UploadQueueItem = Readonly<{ actions: UploadQueueActions; alert?: string; id: string; name: string; preview: UploadQueuePreview; progress: number | null; progressLabel: string; statusLabel: string;}>;Caller-provided upload queue item data.
UploadQueuePreviewtype alias
Section titled “UploadQueuePreview”type UploadQueuePreview = | Readonly<{ kind: "file"; }> | Readonly<{ kind: "image"; url: string; }>;A caller-provided file or image preview for one upload row.
UploadQueuePropstype alias
Section titled “UploadQueueProps”type UploadQueueProps = Readonly<{ className?: string; items: readonly UploadQueueItem[]; onCancel: (id) => Promise<void> | void; onRemove: (id) => void; onRetry: (id) => Promise<void> | void; rowClassName?: string;}>;Props accepted by UploadQueue.
UploadQueue()function
Section titled “UploadQueue()”function UploadQueue(__namedParameters): Element | null;Product-neutral upload facts and affordances; lifecycle stays with the host.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters |
UploadQueueProps |
Returns
Section titled “Returns”Element | null