Class LSPluginUser

User plugin instance from global namespace logseq.

Example

logseq.UI.showMsg('Hello, Logseq')

Hierarchy

EventEmitter<LSPluginUserEvents>
- LSPluginUser

Implements

ILSPluginUser

Constructors

constructor

new LSPluginUser(
_baseInfo: LSPluginBaseInfo,
_caller: LSPluginCaller,
): LSPluginUser
Parameters
- _baseInfo: LSPluginBaseInfo
- _caller: LSPluginCaller
Returns LSPluginUser
Overrides EventEmitter<LSPluginUserEvents>.constructor
- Defined in src/LSPlugin.user.ts:509

Properties

`Static`prefixed

prefixed: string | boolean

Accessors

App

get App(): IAppProxy
Returns IAppProxy
Implementation of ILSPluginUser.App
- Defined in src/LSPlugin.user.ts:840

Assets

get Assets(): IAssetsProxy
Returns IAssetsProxy
Implementation of ILSPluginUser.Assets
- Defined in src/LSPlugin.user.ts:869

baseInfo

get baseInfo(): LSPluginBaseInfo
The plugin configurations from package.json

Returns LSPluginBaseInfo
Implementation of ILSPluginUser.baseInfo
- Defined in src/LSPlugin.user.ts:708

caller

get caller(): LSPluginCaller
Duplex message caller

Returns LSPluginCaller
Implementation of ILSPluginUser.caller
- Defined in src/LSPlugin.user.ts:724

connected

get connected(): boolean
Connection status with the main app

Returns boolean
Implementation of ILSPluginUser.connected
- Defined in src/LSPlugin.user.ts:704

DB

get DB(): IDBProxy
Returns IDBProxy
Implementation of ILSPluginUser.DB
- Defined in src/LSPlugin.user.ts:850

Editor

get Editor(): IEditorProxy
Returns IEditorProxy
Implementation of ILSPluginUser.Editor
- Defined in src/LSPlugin.user.ts:845

effect

get effect(): Boolean
Returns Boolean
- Defined in src/LSPlugin.user.ts:712

Experiments

get Experiments(): LSPluginExperiments
Returns LSPluginExperiments
Implementation of ILSPluginUser.Experiments
- Defined in src/LSPlugin.user.ts:885

FileStorage

get FileStorage(): LSPluginFileStorage
Returns LSPluginFileStorage
Implementation of ILSPluginUser.FileStorage
- Defined in src/LSPlugin.user.ts:873

Git

get Git(): IGitProxy
Returns IGitProxy
Implementation of ILSPluginUser.Git
- Defined in src/LSPlugin.user.ts:865

isMainUIVisible

get isMainUIVisible(): boolean
Returns boolean
Implementation of ILSPluginUser.isMainUIVisible
- Defined in src/LSPlugin.user.ts:699

logger

get logger(): PluginLogger
Returns PluginLogger
- Defined in src/LSPlugin.user.ts:716

Request

get Request(): LSPluginRequest
Returns LSPluginRequest
Implementation of ILSPluginUser.Request
- Defined in src/LSPlugin.user.ts:879

settings

get settings(): { disabled: boolean } & Record<string, unknown>
The plugin user settings

Returns { disabled: boolean } & Record<string, unknown>
Implementation of ILSPluginUser.settings
- Defined in src/LSPlugin.user.ts:720

UI

get UI(): IUIProxy
Returns IUIProxy
Implementation of ILSPluginUser.UI
- Defined in src/LSPlugin.user.ts:855

Utils

get Utils(): IUtilsProxy
Returns IUtilsProxy
- Defined in src/LSPlugin.user.ts:860

version

get version(): string
Returns string
- Defined in src/LSPlugin.user.ts:695

Methods

_callWin

_callWin(...args: any[]): Promise<any>
Parameters
- ...args: any[]
Returns Promise<any>
- Defined in src/LSPlugin.user.ts:829

_execCallableAPI

_execCallableAPI(method: string, ...args: any[]): void
Parameters
- method: string
- ...args: any[]
Returns void
- Defined in src/LSPlugin.user.ts:822

_execCallableAPIAsync

_execCallableAPIAsync(method: string, ...args: any[]): Promise<any>
Parameters
- method: string
- ...args: any[]
Returns Promise<any>
- Defined in src/LSPlugin.user.ts:815

_makeUserProxy

_makeUserProxy(target: any, nstag?: UserProxyNSTags): any
Internal
Parameters
- target: any
- Optionalnstag: UserProxyNSTags
Returns any
- Defined in src/LSPlugin.user.ts:738

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
Implementation of ILSPluginUser.addListener
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

beforeunload

beforeunload(callback: (e: any) => Promise<void>): void
Parameters
- callback: (e: any) => Promise<void>
Returns void
Implementation of ILSPluginUser.beforeunload
- Defined in src/LSPlugin.user.ts:596

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
Implementation of ILSPluginUser.emit
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

ensureConnected

ensureConnected(): void
Returns void
- Defined in src/LSPlugin.user.ts:590

eventNames

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

Returns LSPluginUserEvents[]
Implementation of ILSPluginUser.eventNames
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
Implementation of ILSPluginUser.hideMainUI
- Defined in src/LSPlugin.user.ts:662

hideSettingsUI

hideSettingsUI(): void
Returns void
Implementation of ILSPluginUser.hideSettingsUI
- Defined in src/LSPlugin.user.ts:649

listenerCount

listenerCount(event: LSPluginUserEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: LSPluginUserEvents
Returns number
Implementation of ILSPluginUser.listenerCount
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)[]
Implementation of ILSPluginUser.listeners
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
Implementation of ILSPluginUser.off
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
Implementation of ILSPluginUser.on
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
Implementation of ILSPluginUser.once
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
Implementation of ILSPluginUser.onSettingsChanged
- Defined in src/LSPlugin.user.ts:639

provideModel

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

provideStyle

provideStyle(style: string): LSPluginUser
Inject custom css for the main Logseq app
Parameters
- style: string
Returns LSPluginUser
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");
 )
```
Implementation of ILSPluginUser.provideStyle
- Defined in src/LSPlugin.user.ts:611

provideTheme

provideTheme(theme: Theme): LSPluginUser
Set the theme for the main Logseq app
Parameters
- theme: Theme
Returns LSPluginUser
Implementation of ILSPluginUser.provideTheme
- Defined in src/LSPlugin.user.ts:606

provideUI

provideUI(ui: UIOptions): LSPluginUser

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 LSPluginUser

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?: any, callback?: any): Promise<void>
The main Logseq app is ready to run the plugin
Parameters
- Optionalmodel: any
  same as the model in provideModel
- Optionalcallback: any
Returns Promise<void>
Implementation of ILSPluginUser.ready
- Defined in src/LSPlugin.user.ts:542

removeAllListeners

removeAllListeners(event?: LSPluginUserEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: LSPluginUserEvents
Returns this
Implementation of ILSPluginUser.removeAllListeners
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
Implementation of ILSPluginUser.removeListener
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

resolveResourceFullUrl

resolveResourceFullUrl(filePath: string): string
Parameters
- filePath: string
Returns string
Implementation of ILSPluginUser.resolveResourceFullUrl
- Defined in src/LSPlugin.user.ts:728

setMainUIAttrs

setMainUIAttrs(attrs: Partial<UIContainerAttrs>): void
Parameters
- attrs: Partial<UIContainerAttrs>
Returns void
Implementation of ILSPluginUser.setMainUIAttrs
- Defined in src/LSPlugin.user.ts:654

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,
})
```
Implementation of ILSPluginUser.setMainUIInlineStyle
- Defined in src/LSPlugin.user.ts:658

showMainUI

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

showSettingsUI

showSettingsUI(): void
Returns void
Implementation of ILSPluginUser.showSettingsUI
- Defined in src/LSPlugin.user.ts:645

toggleMainUI

toggleMainUI(): void
toggle the plugin's UI

Returns void
Implementation of ILSPluginUser.toggleMainUI
- Defined in src/LSPlugin.user.ts:684

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
```
Implementation of ILSPluginUser.updateSettings
- Defined in src/LSPlugin.user.ts:634

useSettingsSchema

useSettingsSchema(schema: SettingSchemaDesc[]): LSPluginUser
Parameters
- schema: SettingSchemaDesc[]
Returns LSPluginUser
Example
```
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts
```
Implementation of ILSPluginUser.useSettingsSchema
- Defined in src/LSPlugin.user.ts:622

Class LSPluginUser

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LSPluginUser

Properties

Staticprefixed

Accessors

App

Returns IAppProxy

Assets

Returns IAssetsProxy

baseInfo

Returns LSPluginBaseInfo

caller

Returns LSPluginCaller

connected

Returns boolean

DB

Returns IDBProxy

Editor

Returns IEditorProxy

effect

Returns Boolean

Experiments

Returns LSPluginExperiments

FileStorage

Returns LSPluginFileStorage

Git

Returns IGitProxy

isMainUIVisible

Returns boolean

logger

Returns PluginLogger

Request

Returns LSPluginRequest

settings

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

UI

Returns IUIProxy

Utils

Returns IUtilsProxy

version

Returns string

Methods

_callWin

Parameters

Returns Promise<any>

_execCallableAPI

Parameters

Returns void

_execCallableAPIAsync

Parameters

Returns Promise<any>

_makeUserProxy

Parameters

Returns any

addListener

Type Parameters

Parameters

Returns this

beforeunload

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

ensureConnected

Returns void

eventNames

Returns LSPluginUserEvents[]

`Static`prefixed