Skip to content

Interface: AnyDropFileContext ​

Defined in: ui/src/types.ts:129

Context of a file row.

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
activebooleanThe keyboard-active row.-ui/src/types.ts:153
canobjectWhether each built-in action applies now.-ui/src/types.ts:159
can.cancelboolean--ui/src/types.ts:159
can.pauseboolean--ui/src/types.ts:159
can.removeboolean--ui/src/types.ts:159
can.resumeboolean--ui/src/types.ts:159
can.retryboolean--ui/src/types.ts:159
depthnumberTree level, 0 at the root.-ui/src/types.ts:151
errorErrorEntry | nullThe error-list entry of the file.-ui/src/types.ts:145
errorMessagestringThe text data-ad-errormessage shows (error or canceled), else an empty string.-ui/src/types.ts:147
file| AnyDropFile | MockFile--ui/src/types.ts:131
instanceAnyDropThe instance.AnyDropRenderContext.instanceui/src/types.ts:117
kind"file"--ui/src/types.ts:130
labelstringThe shown name: file.name, or the relative path in the flat view.-ui/src/types.ts:133
layoutstring & object | AnyDropLayoutThe current layout.AnyDropRenderContext.layoutui/src/types.ts:119
partsobjectThe default parts, already painted.-ui/src/types.ts:157
parts.actionsHTMLElement--ui/src/types.ts:157
parts.badgeHTMLElement--ui/src/types.ts:157
parts.previewHTMLElement--ui/src/types.ts:157
progressnumber0 to 100 (100 when success).-ui/src/types.ts:143
rowHTMLElementThe library-owned .ad-row.-ui/src/types.ts:155
sizeTextstringFormatted size, plain text.-ui/src/types.ts:135
statusFileStatusadded, queued, uploading, paused, success, error or canceled.-ui/src/types.ts:137
statusTextstringThe status badge text.-ui/src/types.ts:139
thumbnailstring | nullThe thumbnail data URL once made.-ui/src/types.ts:149
waitingbooleanPaused only by the system (offline or unreachable).-ui/src/types.ts:141

Methods ​

cancel() ​

ts
cancel(): void;

Defined in: ui/src/types.ts:164

Returns ​

void


html() ​

ts
html(strings, ...values): HTMLElement;

Defined in: ui/src/types.ts:123

Builds DOM from markup; every ${value} is HTML-escaped.

Parameters ​

ParameterType
stringsTemplateStringsArray
...valuesunknown[]

Returns ​

HTMLElement

Inherited from ​

AnyDropRenderContext.html


icon() ​

ts
icon(name): HTMLElement;

Defined in: ui/src/types.ts:125

<span class="ad-icon" aria-hidden="true"> holding the configured icon.

Parameters ​

ParameterType
name| string & object | AnyDropIconName

Returns ​

HTMLElement

Inherited from ​

AnyDropRenderContext.icon


pause() ​

ts
pause(): void;

Defined in: ui/src/types.ts:161

Runs the built-in action (a no-op when it does not apply; never goes through an override).

Returns ​

void


remove() ​

ts
remove(): void;

Defined in: ui/src/types.ts:165

Returns ​

void


resume() ​

ts
resume(): void;

Defined in: ui/src/types.ts:162

Returns ​

void


retry() ​

ts
retry(): void;

Defined in: ui/src/types.ts:163

Returns ​

void


t() ​

ts
t(key, vars?): string;

Defined in: ui/src/types.ts:121

The current text of a dict* option, with placeholders replaced. Unknown keys return the key.

Parameters ​

ParameterType
key| "dictFileTooBig" | "dictInvalidFileType" | "dictResponseError" | "dictUploadCanceled" | "dictMaxFilesExceeded" | "dictFileUnreadable" | "dictInvalidPath" | "dictFileSizeUnits" | keyof AnyDropDict
vars?Record<string, string | number>

Returns ​

string

Inherited from ​

AnyDropRenderContext.t

Released under the MIT License.