Class default<SettingsT>

_noteId

_position

$widget

children

componentId

initialized

OptionalnoteContext

Optionalparent

hoistedNoteId

• get hoistedNoteId(): string

  Returns string

note

• get note(): FNote

  Returns FNote

noteId

• get noteId(): string

  Returns string

notePath

• get notePath(): string

  Returns string

ntxId

• get ntxId(): string

  Returns string

position

• get position(): number

  Returns number

• set position(newPosition: number): void

  Parameters

  • newPosition: number

  Returns void

sanitizedClassName

• get sanitizedClassName(): string

  Returns string

activeContextChanged

• activeContextChanged(): Promise<void>

  Returns Promise<void>

activeContextChangedEvent

• activeContextChangedEvent(
      __namedParameters: { noteContext: NoteContext },
  ): Promise<void>

  Parameters

  • __namedParameters: { noteContext: NoteContext }

  Returns Promise<void>

callMethod

• callMethod(
      fun: (arg: unknown) => Promise<unknown>,
      data: unknown,
  ): Promise<unknown>

  Parameters

  • fun: (arg: unknown) => Promise<unknown>
  • data: unknown

  Returns Promise<unknown>

canBeShown

• canBeShown(): boolean

  Returns boolean

child

• child(..._components: (default | VNode<{}>)[]): this

  Parameters

  • ..._components: (default | VNode<{}>)[]

  Returns this

class

• class(className: string): this

  Parameters

  • className: string

  Returns this

cleanup

• cleanup(): void

  Returns void

collapsible

• collapsible(): this

  Returns this

contentSized

• contentSized(): this

  Returns this

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.

cssBlock

• cssBlock(block: string): this

  Accepts a string of CSS to add with the widget.

  Parameters

  • block: string

  Returns this

  for chaining

filling

• filling(): this

  Returns this

frocaReloadedEvent

• frocaReloadedEvent(): Promise<void>

  Returns Promise<void>

getClosestNtxId

• getClosestNtxId(): string

  Returns string

getPosition

• getPosition(): number

  Returns number

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>

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>

id

• id(id: string): this

  Parameters

  • id: string

  Returns this

isActiveNoteContext

• isActiveNoteContext(): boolean

  Returns boolean

isHiddenExt

• isHiddenExt(): boolean

  Returns boolean

isHiddenInt

• isHiddenInt(): boolean

  Returns boolean

isNote

• isNote(noteId: string): boolean

  Parameters

  • noteId: string

  Returns boolean

isNoteContext

• isNoteContext(ntxId: string | string[]): boolean | ""

  Parameters

  • ntxId: string | string[]

  Returns boolean | ""

isVisible

• isVisible(): boolean

  Returns boolean

logRenderingError

• logRenderingError(e: Error): void

  Parameters

  • e: Error

  Returns void

noteSwitched

• noteSwitched(): Promise<void>

  Returns Promise<void>

noteSwitchedAndActivatedEvent

• noteSwitchedAndActivatedEvent(
      __namedParameters: NoteSwitchedContext,
  ): Promise<void>

  Parameters

  • __namedParameters: NoteSwitchedContext

  Returns Promise<void>

noteSwitchedEvent

• noteSwitchedEvent(__namedParameters: NoteSwitchedContext): Promise<void>

  Parameters

  • __namedParameters: NoteSwitchedContext

  Returns Promise<void>

noteTypeMimeChangedEvent

• noteTypeMimeChangedEvent(__namedParameters: { noteId: string }): Promise<void>

  Parameters

  • __namedParameters: { noteId: string }

  Returns Promise<void>

optChild

• optChild(condition: boolean, ...components: (default | VNode<{}>)[]): this

  Conditionally adds the given components as children to this component.

  Parameters

  • condition: boolean

    whether to add the components.

  • ...components: (default | VNode<{}>)[]

    the components to be added as children to this component provided the condition is truthy.

  Returns this

  self for chaining.

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.

refresh

• refresh(): Promise<void>

  Returns Promise<void>

refreshWithNote

• refreshWithNote(note: FNote): Promise<void>

  Override this method to be able to refresh your widget with each note.

  Parameters

  • note: FNote

  Returns Promise<void>

registerHandler

• registerHandler<T extends EventNames>(name: T, handler: EventHandler): void

  Type Parameters

  • T extends EventNames

  Parameters

  • name: T
  • handler: EventHandler

  Returns void

remove

• remove(): void

  Returns void

removeHandler

• removeHandler<T extends EventNames>(name: T, handler: EventHandler): void

  Type Parameters

  • T extends EventNames

  Parameters

  • name: T
  • handler: EventHandler

  Returns void

render

• render(): any

  Returns any

setNoteContextEvent

• setNoteContextEvent(__namedParameters: { noteContext: NoteContext }): void

  Parameters

  • __namedParameters: { noteContext: NoteContext }

  Returns void

setParent

• setParent(parent: TypedComponent<any>): this

  Parameters

  • parent: TypedComponent<any>

  Returns this

toggleExt

• toggleExt(show: boolean | ""): void

  Parameters

  • show: boolean | ""

  Returns void

toggleInt

• toggleInt(show: boolean): void

  Parameters

  • show: boolean

  Returns void

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>

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>