Interface ILSPluginUser

interface ILSPluginUser {
    App: IAppProxy;
    Assets: IAssetsProxy;
    baseInfo: LSPluginBaseInfo;
    beforeunload: (callback: () => Promise<void>) => void;
    caller: LSPluginCaller;
    connected: boolean;
    DB: IDBProxy;
    Editor: IEditorProxy;
    Experiments: LSPluginExperiments;
    FileStorage: LSPluginFileStorage;
    Git: IGitProxy;
    isMainUIVisible: boolean;
    Request: LSPluginRequest;
    settings?: { disabled: boolean } & Record<string, unknown>;
    UI: IUIProxy;
    addListener<T extends LSPluginUserEvents>(
        event: T,
        fn: (...args: any[]) => void,
        context?: any,
    ): this;
    emit<T extends LSPluginUserEvents>(event: T, ...args: any[]): boolean;
    eventNames(): LSPluginUserEvents[];
    hideMainUI(opts?: { restoreEditingCursor: boolean }): void;
    hideSettingsUI(): void;
    listenerCount(event: LSPluginUserEvents): number;
    listeners<T extends LSPluginUserEvents>(
        event: T,
    ): ((...args: any[]) => void)[];
    off<T extends LSPluginUserEvents>(
        event: T,
        fn?: (...args: any[]) => void,
        context?: any,
        once?: boolean,
    ): this;
    on<T extends LSPluginUserEvents>(
        event: T,
        fn: (...args: any[]) => void,
        context?: any,
    ): this;
    once<T extends LSPluginUserEvents>(
        event: T,
        fn: (...args: any[]) => void,
        context?: any,
    ): this;
    onSettingsChanged<T = any>(cb: (a: T, b: T) => void): IUserOffHook;
    provideModel(model: Record<string, any>): this;
    provideStyle(style: string | StyleOptions): this;
    provideTheme(theme: Theme): this;
    provideUI(ui: UIOptions): this;
    ready(model?: Record<string, any>): Promise<any>;
    ready(callback?: (e: any) => void | {}): Promise<any>;
    ready(
        model?: Record<string, any>,
        callback?: (e: any) => void | {},
    ): Promise<any>;
    removeAllListeners(event?: LSPluginUserEvents): this;
    removeListener<T extends LSPluginUserEvents>(
        event: T,
        fn?: (...args: any[]) => void,
        context?: any,
        once?: boolean,
    ): this;
    resolveResourceFullUrl(filePath: string): string;
    setMainUIAttrs(attrs: Record<string, any>): void;
    setMainUIInlineStyle(style: Properties): void;
    showMainUI(opts?: { autoFocus: boolean }): void;
    showSettingsUI(): void;
    toggleMainUI(): void;
    updateSettings(attrs: Record<string, any>): void;
    useSettingsSchema(schemas: SettingSchemaDesc[]): this;
}

Hierarchy

EventEmitter<LSPluginUserEvents>
- ILSPluginUser

Implemented by

LSPluginUser

Properties

The plugin configurations from package.json

beforeunload

beforeunload: (callback: () => Promise<void>) => void

caller

caller: LSPluginCaller

Duplex message caller

connected

connected: boolean

Connection status with the main app

DB

DB: IDBProxy

Editor

Editor: IEditorProxy

Experiments

Experiments: LSPluginExperiments

FileStorage

FileStorage: LSPluginFileStorage

Git

Git: IGitProxy

isMainUIVisible

isMainUIVisible: boolean

Request

Request: LSPluginRequest

`Optional`settings

settings?: { disabled: boolean } & Record<string, unknown>

The plugin user settings

UI

UI: IUIProxy

Methods

addListener

addListener<T extends LSPluginUserEvents>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends LSPluginUserEvents>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): LSPluginUserEvents[]
Return an array listing the events for which the emitter has registered listeners.

Returns LSPluginUserEvents[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

hideMainUI

hideMainUI(opts?: { restoreEditingCursor: boolean }): void
hide the plugin's UI
Parameters
- Optionalopts: { restoreEditingCursor: boolean }
Returns void
- Defined in src/LSPlugin.ts:1155

hideSettingsUI

hideSettingsUI(): void
Returns void
- Defined in src/LSPlugin.ts:1129

listenerCount

listenerCount(event: LSPluginUserEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: LSPluginUserEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends LSPluginUserEvents>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends LSPluginUserEvents>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends LSPluginUserEvents>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends LSPluginUserEvents>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

onSettingsChanged

onSettingsChanged<T = any>(cb: (a: T, b: T) => void): IUserOffHook
Type Parameters
- T = any
Parameters
- cb: (a: T, b: T) => void
Returns IUserOffHook
- Defined in src/LSPlugin.ts:1125

provideModel

provideModel(model: Record<string, any>): this
Create a object to hold the methods referenced in provideUI
Parameters
- model: Record<string, any>
Returns this
Example
```
logseq.provideModel({
 openCalendar () {
   console.log('Open the calendar!')
 }
})
```
- Defined in src/LSPlugin.ts:1071

provideStyle

provideStyle(style: string | StyleOptions): this

Inject custom css for the main Logseq app

Parameters

style: string | StyleOptions

Returns this

Example

https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts

Example

  logseq.provideStyle(`
   @import url("https://at.alicdn.com/t/font_2409735_r7em724douf.css");
 )

provideTheme

provideTheme(theme: Theme): this
Set the theme for the main Logseq app
Parameters
- theme: Theme
Returns this
- Defined in src/LSPlugin.ts:1076

provideUI

provideUI(ui: UIOptions): this

Inject custom UI at specific DOM node. Event handlers can not be passed by string, so you need to create them in provideModel

Parameters

ui: UIOptions

Returns this

Example

https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-a-translator

Example

logseq.provideUI({
key: 'open-calendar',
path: '#search',
template: `
 <a data-on-click="openCalendar" onclick="alert('abc')' style="opacity: .6; display: inline-flex; padding-left: 3px;'>
   <i class="iconfont icon-Calendaralt2"></i>
 </a>
`
})

ready

ready(model?: Record<string, any>): Promise<any>
The main Logseq app is ready to run the plugin
Parameters
- Optionalmodel: Record<string, any>
  same as the model in provideModel
Returns Promise<any>
- Defined in src/LSPlugin.ts:1045
ready(callback?: (e: any) => void | {}): Promise<any>
Parameters
- Optionalcallback: (e: any) => void | {}
  a function to run when the main Logseq app is ready
Returns Promise<any>
- Defined in src/LSPlugin.ts:1050
ready(
model?: Record<string, any>,
callback?: (e: any) => void | {},
): Promise<any>
Parameters
- Optionalmodel: Record<string, any>
- Optionalcallback: (e: any) => void | {}
Returns Promise<any>
- Defined in src/LSPlugin.ts:1052

removeAllListeners

removeAllListeners(event?: LSPluginUserEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: LSPluginUserEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends LSPluginUserEvents>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resolveResourceFullUrl

resolveResourceFullUrl(filePath: string): string
Parameters
- filePath: string
Returns string
- Defined in src/LSPlugin.ts:1164

setMainUIAttrs

setMainUIAttrs(attrs: Record<string, any>): void
Parameters
- attrs: Record<string, any>
Returns void
- Defined in src/LSPlugin.ts:1131

setMainUIInlineStyle

setMainUIInlineStyle(style: Properties): void

Set the style for the plugin's UI

Parameters

style: Properties

Returns void

Example

https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts

Example

logseq.setMainUIInlineStyle({
 position: 'fixed',
 zIndex: 11,
})

showMainUI

showMainUI(opts?: { autoFocus: boolean }): void
show the plugin's UI
Parameters
- Optionalopts: { autoFocus: boolean }
Returns void
- Defined in src/LSPlugin.ts:1150

showSettingsUI

showSettingsUI(): void
Returns void
- Defined in src/LSPlugin.ts:1127

toggleMainUI

toggleMainUI(): void
toggle the plugin's UI

Returns void
- Defined in src/LSPlugin.ts:1160

updateSettings

updateSettings(attrs: Record<string, any>): void
Parameters
- attrs: Record<string, any>
Returns void
Example
```
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts
```
- Defined in src/LSPlugin.ts:1123

useSettingsSchema

useSettingsSchema(schemas: SettingSchemaDesc[]): this
Parameters
- schemas: SettingSchemaDesc[]
Returns this
Example
```
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts
```
- Defined in src/LSPlugin.ts:1116

Interface ILSPluginUser

Hierarchy

Implemented by

Index

Properties

Methods

Properties

App

Assets

baseInfo

beforeunload

caller

connected

DB

Editor

Experiments

FileStorage

Git

isMainUIVisible

Request

Optionalsettings

UI

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns LSPluginUserEvents[]

hideMainUI

Parameters

Returns void

hideSettingsUI

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

onSettingsChanged

Type Parameters

Parameters

Returns IUserOffHook

provideModel

Parameters

Returns this

Example

provideStyle

Parameters

Returns this

Example

Example

provideTheme

Parameters

Returns this

provideUI

Parameters

Returns this

Example

Example

ready

Parameters

`Optional`settings