tw5-typed / core / IWidgetEvent
Interface: IWidgetEvent
core.IWidgetEvent
Indexable
▪ [extraKeys: string]: unknown
Table of contents
Properties
Properties
event
• event: Event | UIEvent
maybe a DOM click event, if trigger by button click
Defined in
src/modules/widgets/index.d.ts:37
name
• name: string
Defined in
src/modules/widgets/index.d.ts:38
navigateFromTitle
• Optional navigateFromTitle: string
Defined in
src/modules/widgets/index.d.ts:39
param
• Optional param: string
Get $param
Defined in
src/modules/widgets/index.d.ts:43
paramObject
• Optional paramObject: Record<string, unknown>
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" }
Defined in
src/modules/widgets/index.d.ts:48
tiddlerTitle
• Optional tiddlerTitle: string
Defined in
src/modules/widgets/index.d.ts:49
type
• type: string
the first parameter of addEventListener
For example, the 'open-command-palette' in $tw.rootWidget.addEventListener('open-command-palette', (e: IWidgetEvent) => this.openPalette(e));
Defined in
src/modules/widgets/index.d.ts:54
widget
• widget: widget