Trilium Frontend API
    Preparing search index...

    Interface BasicWidget

    This is the base widget for all other widgets.

    For information on using widgets, see the tutorial {@tutorial widget_basics}.

    interface BasicWidget {
        _noteId: string;
        _position: number;
        $widget: any;
        attrs: Record<string, string>;
        children: default[];
        componentId: string;
        initialized: Promise<void>;
        parent?: TypedComponent<any>;
        get position(): number;
        set position(newPosition: number): void;
        get sanitizedClassName(): string;
        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;
        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;
        isEnabled(): boolean;
        isHiddenExt(): boolean;
        isHiddenInt(): boolean;
        isVisible(): boolean;
        logRenderingError(e: Error): void;
        optChild(condition: boolean, ...components: (default | VNode<{}>)[]): this;
        optCss(condition: boolean, name: string, value: string): this;
        registerHandler<T extends EventNames>(name: T, handler: EventHandler): void;
        remove(): void;
        removeHandler<T extends EventNames>(name: T, handler: EventHandler): void;
        render(): any;
        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 parent?

    Accessors

    position sanitizedClassName

    Methods

    callMethod canBeShown child class cleanup collapsible contentSized css cssBlock doRender filling getClosestNtxId getPosition handleEvent handleEventInChildren id isEnabled isHiddenExt isHiddenInt isVisible logRenderingError optChild optCss registerHandler remove removeHandler render 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>
    parent?: TypedComponent<any>

    Accessors

    • get position(): number

      Returns number

    • set position(newPosition: number): void

      Parameters

      • newPosition: number

      Returns void

    • get sanitizedClassName(): string

      Returns string

    Methods

    • Parameters

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

      Returns Promise<unknown>

    • Returns boolean

    • Parameters

      • className: string

      Returns this

    • Returns void

    • 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

    • Parameters

      • id: string

      Returns this

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

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • e: Error

      Returns 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 void

    • Returns any

    • Parameters

      • show: boolean | ""

      Returns void

    • Parameters

      • show: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods