Skip to content

Interface: AnyDropToolbarContext ​

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

Context of the toolbar.

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
canobject--ui/src/types.ts:206
can.clearboolean--ui/src/types.ts:206
can.pauseAllboolean--ui/src/types.ts:206
can.resumeAllboolean--ui/src/types.ts:206
can.retryFailedboolean--ui/src/types.ts:206
countsFolderCountsCounts of the whole tree.-ui/src/types.ts:202
elHTMLElementThe library-owned .ad-toolbar.-ui/src/types.ts:199
instanceAnyDropThe instance.AnyDropRenderContext.instanceui/src/types.ts:117
kind"toolbar"--ui/src/types.ts:197
layoutstring & object | AnyDropLayoutThe current layout.AnyDropRenderContext.layoutui/src/types.ts:119
partsobject--ui/src/types.ts:200
parts.actionsHTMLElement--ui/src/types.ts:200
parts.infoHTMLElement--ui/src/types.ts:200
progressnumber0 to 100, rounded.-ui/src/types.ts:204
summaryTextstring--ui/src/types.ts:205

Methods ​

clear() ​

ts
clear(): void;

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

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


pauseAll() ​

ts
pauseAll(): void;

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

Returns ​

void


resumeAll() ​

ts
resumeAll(): void;

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

Returns ​

void


retryFailed() ​

ts
retryFailed(): void;

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

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.