Skip to content

Interface: AnyDropFolderContext ​

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

Context of a folder row.

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
activeboolean--ui/src/types.ts:180
canobject--ui/src/types.ts:187
can.cancelboolean--ui/src/types.ts:187
can.pauseboolean--ui/src/types.ts:187
can.resumeboolean--ui/src/types.ts:187
can.retryboolean--ui/src/types.ts:187
countsFolderCounts--ui/src/types.ts:182
depthnumber--ui/src/types.ts:179
expandedboolean--ui/src/types.ts:183
folderFolderNode--ui/src/types.ts:171
instanceAnyDropThe instance.AnyDropRenderContext.instanceui/src/types.ts:117
kind"folder"--ui/src/types.ts:170
labelstringfolder.name.-ui/src/types.ts:173
layoutstring & object | AnyDropLayoutThe current layout.AnyDropRenderContext.layoutui/src/types.ts:119
partsobject--ui/src/types.ts:186
parts.actionsHTMLElement--ui/src/types.ts:186
parts.badgeHTMLElement--ui/src/types.ts:186
parts.mainHTMLElement--ui/src/types.ts:186
parts.toggleHTMLButtonElement--ui/src/types.ts:186
progressnumberfolder.progress.-ui/src/types.ts:178
rowHTMLElement--ui/src/types.ts:181
statusFileStatus--ui/src/types.ts:174
statusTextstring--ui/src/types.ts:175
waitingboolean--ui/src/types.ts:176

Methods ​

cancel() ​

ts
cancel(): void;

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

cancelFolder(path).

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:188

Returns ​

void


resume() ​

ts
resume(): void;

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

Returns ​

void


retry() ​

ts
retry(): void;

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

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


toggle() ​

ts
toggle(): void;

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

Expands or collapses the folder.

Returns ​

void

Released under the MIT License.