Trilium Frontend API
    Preparing search index...

    Interface NoteContextAwareWidget

    This widget allows for changing and updating depending on the active note.

    interface NoteContextAwareWidget {
        _noteId: string;
        _position: number;
        $widget: any;
        attrs: Record<string, string>;
        children: default[];
        componentId: string;
        initialized: Promise<void>;
        noteContext?: NoteContext;
        parent?: TypedComponent<any>;
        get hoistedNoteId(): string;
        get note(): FNote;
        get noteId(): string;
        get notePath(): string;
        get ntxId(): string;
        get position(): number;
        set position(newPosition: number): void;
        get sanitizedClassName(): string;
        activeContextChanged(): Promise<void>;
        activeContextChangedEvent(
            __namedParameters: { noteContext: NoteContext },
        ): Promise<void>;
        callMethod(
            fun: (arg: unknown) => Promise<unknown>,
            data: unknown,
        ): Promise<unknown>;
        canBeShown(): boolean;
        child(..._components: (default | VNode<{}>)[]): this;
        class(className: string): this;
        cleanup(): void;
        collapsible(): this;
        contentSized(): this;
        css(name: string, value: string): this;
        cssBlock(block: string): this;
        doRender(): void;
        filling(): this;
        frocaReloadedEvent(): Promise<void>;
        getClosestNtxId(): string;
        getPosition(): number;
        handleEvent<T extends EventNames>(
            name: T,
            data: EventData<T>,
        ): Promise<unknown>;
        handleEventInChildren<T extends EventNames>(
            name: T,
            data: EventData<T>,
        ): Promise<unknown>;
        id(id: string): this;
        isActiveNoteContext(): boolean;
        isEnabled(): boolean;
        isHiddenExt(): boolean;
        isHiddenInt(): boolean;
        isNote(noteId: string): boolean;
        isNoteContext(ntxId: string | string[]): boolean | "";
        isVisible(): boolean;
        logRenderingError(e: Error): void;
        noteSwitched(): Promise<void>;
        noteSwitchedAndActivatedEvent(
            __namedParameters: NoteSwitchedContext,
        ): Promise<void>;
        noteSwitchedEvent(__namedParameters: NoteSwitchedContext): Promise<void>;
        noteTypeMimeChangedEvent(
            __namedParameters: { noteId: string },
        ): Promise<void>;
        optChild(condition: boolean, ...components: (default | VNode<{}>)[]): this;
        optCss(condition: boolean, name: string, value: string): this;
        refresh(): Promise<void>;
        refreshWithNote(note: FNote): Promise<void>;
        registerHandler<T extends EventNames>(name: T, handler: EventHandler): void;
        remove(): void;
        removeHandler<T extends EventNames>(name: T, handler: EventHandler): void;
        render(): any;
        setNoteContextEvent(__namedParameters: { noteContext: NoteContext }): void;
        setParent(parent: TypedComponent<any>): this;
        toggleExt(show: boolean | ""): void;
        toggleInt(show: boolean): void;
        triggerCommand<K extends keyof CommandMappings>(
            name: K,
            data?: CommandMappings[K],
        ): Promise<unknown>;
        triggerEvent<T extends EventNames>(
            name: T,
            data: EventData<T>,
        ): Promise<unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _noteId _position $widget attrs children componentId initialized noteContext? parent?

    Accessors

    hoistedNoteId note noteId notePath ntxId position sanitizedClassName

    Methods

    activeContextChanged activeContextChangedEvent callMethod canBeShown child class cleanup collapsible contentSized css cssBlock doRender filling frocaReloadedEvent getClosestNtxId getPosition handleEvent handleEventInChildren id isActiveNoteContext isEnabled isHiddenExt isHiddenInt isNote isNoteContext isVisible logRenderingError noteSwitched noteSwitchedAndActivatedEvent noteSwitchedEvent noteTypeMimeChangedEvent optChild optCss refresh refreshWithNote registerHandler remove removeHandler render setNoteContextEvent setParent toggleExt toggleInt triggerCommand triggerEvent

    Properties

    _noteId

    _noteId: string

    _position

    _position: number
    $widget: any
    attrs: Record<string, string>
    children: default[]
    componentId: string
    initialized: Promise<void>
    noteContext?: NoteContext
    parent?: TypedComponent<any>

    Accessors

    • get hoistedNoteId(): string

      Returns string

    • get note(): FNote

      Returns FNote

    • get noteId(): string

      Returns string

    • get notePath(): string

      Returns string

    • get ntxId(): string

      Returns string

    • get position(): number

      Returns number

    • set position(newPosition: number): void

      Parameters

      • newPosition: number

      Returns void

    • get sanitizedClassName(): string

      Returns string

    Methods

    • Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

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

      Returns Promise<unknown>

    • Returns boolean

    • Parameters

      Returns this

    • Parameters

      • className: string

      Returns this

    • Returns void

    • Returns this

    • Returns 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.

    • Accepts a string of CSS to add with the widget.

      Parameters

      • block: string

      Returns this

      for chaining

    • 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

    • Returns this

    • Returns Promise<void>

    • Returns string

    • Returns number

    • Parameters

      • id: string

      Returns this

    • Returns 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.

      If the widget is not enabled, it will not receive `refreshWithNote` updates.

      Returns boolean

      true when an active note exists

    • Returns boolean

    • Returns boolean

    • Parameters

      • noteId: string

      Returns boolean

    • Parameters

      • ntxId: string | string[]

      Returns boolean | ""

    • Returns boolean

    • Parameters

      • e: Error

      Returns void

    • Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • __namedParameters: { noteId: string }

      Returns Promise<void>

    • 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.

    • 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.

    • Returns Promise<void>

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

      Parameters

      Returns Promise<void>

    • Returns void

    • Returns any

    • Parameters

      Returns void

    • Parameters

      • show: boolean | ""

      Returns void

    • Parameters

      • show: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods