Skip to main content

IWidgetEvent

tw5-typed

tw5-typed / hooks / IWidgetEvent

Interface: IWidgetEvent

Defined in: src/modules/widgets/index.d.ts:31

Indexable​

[extraKeys: string]: unknown

Properties​

event​

event: Event | UIEvent

Defined in: src/modules/widgets/index.d.ts:34

maybe a DOM click event, if trigger by button click

name​

name: string

Defined in: src/modules/widgets/index.d.ts:35

optional navigateFromTitle: string

Defined in: src/modules/widgets/index.d.ts:36

param?​

optional param: string

Defined in: src/modules/widgets/index.d.ts:40

Get $param

paramObject?​

optional paramObject: Record<string, unknown>

Defined in: src/modules/widgets/index.d.ts:45

Optional hashmap of additional tiddler fields. Widget event can carry any other parameters

For example, <$action-sendmessage $message="tw-mobile-sync-set-active-server-and-sync" title={{!!title}} /> will produce paramObject: { title: "xxxx" }

tiddlerTitle?​

optional tiddlerTitle: string

Defined in: src/modules/widgets/index.d.ts:46

type​

type: string

Defined in: src/modules/widgets/index.d.ts:51

the first parameter of addEventListener

For example, the 'open-command-palette' in $tw.rootWidget.addEventListener('open-command-palette', (e: IWidgetEvent) => this.openPalette(e));

widget​

widget: Widget

Defined in: src/modules/widgets/index.d.ts:52