Class TypedBasicWidget<T>

Abstract class for all components in the Trilium's frontend.

Contains also event implementation with following properties:

event / command distribution is synchronous which among others mean that events are well-ordered - event which was sent out first will also be processed first by the component
execution of the event / command is asynchronous - each component executes the event on its own without regard for other components.
although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the event / command is executed in all components - by simply awaiting the triggerEvent().

Type Parameters

T extends TypedComponent<any>

Hierarchy (View Summary)

TypedComponent<T>
- TypedBasicWidget
  - BasicWidget

Constructors

constructor

new TypedBasicWidget<T extends TypedComponent<any>>(): TypedBasicWidget<T>
Type Parameters
- T extends TypedComponent<any>
Returns TypedBasicWidget<T>
Overrides TypedComponent.constructor
- Defined in apps/client/dist/widgets/basic_widget.d.ts:9

Properties

_noteId

_noteId: string

_position

_position: number

$widget: any

`Protected`attrs

attrs: Record<string, string>

children

children: T[]

componentId

componentId: string

initialized

initialized: Promise<void>

`Optional`parent

parent?: TypedComponent<any>

Accessors

position

get position(): number
Returns number
Inherited from TypedComponent.position
- Defined in apps/client/dist/components/component.d.ts:24
set position(newPosition: number): void
Parameters
- newPosition: number
Returns void
Inherited from TypedComponent.position
- Defined in apps/client/dist/components/component.d.ts:25

sanitizedClassName

get sanitizedClassName(): string
Returns string
Inherited from TypedComponent.sanitizedClassName
- Defined in apps/client/dist/components/component.d.ts:23

Methods

callMethod

callMethod(
fun: (arg: unknown) => Promise<unknown>,
data: unknown,
): Promise<unknown>
Parameters
- fun: (arg: unknown) => Promise<unknown>
- data: unknown
Returns Promise<unknown>
Inherited from TypedComponent.callMethod
- Defined in apps/client/dist/components/component.d.ts:32

canBeShown

canBeShown(): boolean
Returns boolean
- Defined in apps/client/dist/widgets/basic_widget.d.ts:64

child

child(..._components: (T | VNode<{}>)[]): this
Parameters
- ..._components: (T | VNode<{}>)[]
Returns this
Overrides TypedComponent.child
- Defined in apps/client/dist/widgets/basic_widget.d.ts:10

class

class(className: string): this
Parameters
- className: string
Returns this
- Defined in apps/client/dist/widgets/basic_widget.d.ts:20

cleanup

cleanup(): void
Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:69

collapsible

collapsible(): this
Returns this
- Defined in apps/client/dist/widgets/basic_widget.d.ts:39

contentSized

contentSized(): this
Returns this
- Defined in apps/client/dist/widgets/basic_widget.d.ts:38

css

css(name: string, value: string): this
Sets the CSS attribute of the given name to the given value.
Parameters
- name: string
  the name of the CSS attribute to set (e.g. padding-inline-start).
- value: string
  the value of the CSS attribute to set (e.g. 12px).
Returns this
self for chaining.
- Defined in apps/client/dist/widgets/basic_widget.d.ts:28

cssBlock

cssBlock(block: string): this
Accepts a string of CSS to add with the widget.
Parameters
- block: string
Returns this
for chaining
- Defined in apps/client/dist/widgets/basic_widget.d.ts:45

doRender

doRender(): void
Method used for rendering the widget.

Your class should override this method. The method is expected to create a this.$widget containing jQuery object

Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:59

filling

filling(): this
Returns this
- Defined in apps/client/dist/widgets/basic_widget.d.ts:40

getClosestNtxId

getClosestNtxId(): string
Returns string
- Defined in apps/client/dist/widgets/basic_widget.d.ts:68

getPosition

getPosition(): number
Returns number
- Defined in apps/client/dist/widgets/basic_widget.d.ts:66

handleEvent

handleEvent<T extends EventNames>(name: T, data: EventData<T>): Promise<unknown>
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns Promise<unknown>
Inherited from TypedComponent.handleEvent
- Defined in apps/client/dist/components/component.d.ts:28

handleEventInChildren

handleEventInChildren<T extends EventNames>(
name: T,
data: EventData<T>,
): Promise<unknown>
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns Promise<unknown>
Inherited from TypedComponent.handleEventInChildren
- Defined in apps/client/dist/components/component.d.ts:30

id

id(id: string): this
Parameters
- id: string
Returns this
- Defined in apps/client/dist/widgets/basic_widget.d.ts:19

isEnabled

isEnabled(): boolean
Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

Returns boolean
whether the widget is enabled.
- Defined in apps/client/dist/widgets/basic_widget.d.ts:52

isHiddenExt

isHiddenExt(): boolean
Returns boolean
- Defined in apps/client/dist/widgets/basic_widget.d.ts:63

isHiddenInt

isHiddenInt(): boolean
Returns boolean
- Defined in apps/client/dist/widgets/basic_widget.d.ts:61

isVisible

isVisible(): boolean
Returns boolean
- Defined in apps/client/dist/widgets/basic_widget.d.ts:65

logRenderingError

logRenderingError(e: Error): void
Parameters
- e: Error
Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:47

optChild

optChild(condition: boolean, ...components: (T | VNode<{}>)[]): this
Conditionally adds the given components as children to this component.
Parameters
- condition: boolean
  whether to add the components.
- ...components: (T | VNode<{}>)[]
  the components to be added as children to this component provided the condition is truthy.
Returns this
self for chaining.
- Defined in apps/client/dist/widgets/basic_widget.d.ts:18

optCss

optCss(condition: boolean, name: string, value: string): this
Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.
Parameters
- condition: boolean
  true in order to apply the CSS, false to ignore it.
- name: string
  the name of the CSS attribute to set (e.g. padding-inline-start).
- value: string
  the value of the CSS attribute to set (e.g. 12px).
Returns this
self for chaining.
- Defined in apps/client/dist/widgets/basic_widget.d.ts:37

registerHandler

registerHandler<T extends EventNames>(name: T, handler: EventHandler): void
Type Parameters
- T extends EventNames
Parameters
- name: T
- handler: EventHandler
Returns void
Inherited from TypedComponent.registerHandler
- Defined in apps/client/dist/components/component.d.ts:33

remove

remove(): void
Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:67

removeHandler

removeHandler<T extends EventNames>(name: T, handler: EventHandler): void
Type Parameters
- T extends EventNames
Parameters
- name: T
- handler: EventHandler
Returns void
Inherited from TypedComponent.removeHandler
- Defined in apps/client/dist/components/component.d.ts:34

render

render(): any
Returns any
- Defined in apps/client/dist/widgets/basic_widget.d.ts:46

setParent

setParent(parent: TypedComponent<any>): this
Parameters
- parent: TypedComponent<any>
Returns this
Inherited from TypedComponent.setParent
- Defined in apps/client/dist/components/component.d.ts:26

toggleExt

toggleExt(show: boolean | ""): void
Parameters
- show: boolean | ""
Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:62

toggleInt

toggleInt(show: boolean): void
Parameters
- show: boolean
Returns void
- Defined in apps/client/dist/widgets/basic_widget.d.ts:60

triggerCommand

triggerCommand<K extends keyof CommandMappings>(
name: K,
data?: CommandMappings[K],
): Promise<unknown>
Type Parameters
- K extends keyof CommandMappings
Parameters
- name: K
- Optionaldata: CommandMappings[K]
Returns Promise<unknown>
Inherited from TypedComponent.triggerCommand
- Defined in apps/client/dist/components/component.d.ts:31

triggerEvent

triggerEvent<T extends EventNames>(
name: T,
data: EventData<T>,
): Promise<unknown>
Type Parameters
- T extends EventNames
Parameters
- name: T
- data: EventData<T>
Returns Promise<unknown>
Inherited from TypedComponent.triggerEvent
- Defined in apps/client/dist/components/component.d.ts:29

Class TypedBasicWidget<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns TypedBasicWidget<T>

Properties

_noteId

_position

$widget

Protectedattrs

children

componentId

initialized

Optionalparent

Accessors

position

Returns number

Parameters

Returns void

sanitizedClassName

Returns string

Methods

callMethod

Parameters

Returns Promise<unknown>

canBeShown

Returns boolean

child

Parameters

Returns this

class

Parameters

Returns this

cleanup

Returns void

collapsible

Returns this

contentSized

Returns this

css

Parameters

Returns this

cssBlock

Parameters

Returns this

doRender

Returns void

filling

Returns this

getClosestNtxId

Returns string

getPosition

Returns number

handleEvent

Type Parameters

Parameters

Returns Promise<unknown>

handleEventInChildren

Type Parameters

Parameters

Returns Promise<unknown>

id

Parameters

Returns this

isEnabled

Returns boolean

isHiddenExt

Returns boolean

isHiddenInt

Returns boolean

isVisible

Returns boolean

logRenderingError

`Protected`attrs

`Optional`parent