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:486

Properties

`Private` _baseInfo

_baseInfo: LSPluginBaseInfo

`Private` `Optional` _beforeunloadCallback

_beforeunloadCallback?: ((e: any) => Promise<void>)

Type declaration

- (e: any): Promise<void>
- Private
  handler of before unload plugin
  Parameters
  - e: any
  Returns Promise<void>

`Private` _caller

_caller: LSPluginCaller

`Private` _connected

_connected: boolean = false

`Private` _debugTag

_debugTag: string = ''

`Private` _mExperiments

_mExperiments: LSPluginExperiments

`Private` _mFileStorage

_mFileStorage: LSPluginFileStorage

`Private` _mRequest

_mRequest: LSPluginRequest

`Private` `Optional` _settingsSchema

_settingsSchema?: SettingSchemaDesc[]

`Private` _ui

_ui: Map<number, uiState> = ...

ui frame identities

`Private` _version

_version: string = LIB_VERSION

`Static` prefixed

prefixed: string | boolean

Accessors

App

get App(): IAppProxy
The interface methods of IAppProxy

Returns IAppProxy
Implementation of ILSPluginUser.App
- Defined in src/LSPlugin.user.ts:798

Experiments

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

FileStorage

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

Git

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

Request

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

UI

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

baseInfo

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

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

caller

get caller(): LSPluginCaller
Duplex message caller

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

connected

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

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

effect

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

isMainUIVisible

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

logger

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

settings

get settings(): {
disabled: boolean;
[key: string]: any;
}
The plugin user settings

Returns {
disabled: boolean;
[key: string]: any;
}
- [key: string]: any
- disabled: boolean
Implementation of ILSPluginUser.settings
- Defined in src/LSPlugin.user.ts:695

version

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

Methods

_callWin

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

_execCallableAPI

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

_execCallableAPIAsync

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

_makeUserProxy

_makeUserProxy(target: any, tag?: UserProxyTags): any
Internal
Parameters
- target: any
- Optional tag: UserProxyTags
Returns any
- Defined in src/LSPlugin.user.ts:713

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): LSPluginUser
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LSPluginUser
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>)
  - - (e: any): Promise<void>
    - Parameters
      
      e: any
      
      Returns Promise<void>
Returns void
Implementation of ILSPluginUser.beforeunload
- Defined in src/LSPlugin.user.ts:571

emit

emit<T>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- Rest ...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:565

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
- Optional opts: {
  restoreEditingCursor: boolean;
  }
  - restoreEditingCursor: boolean
Returns void
Implementation of ILSPluginUser.hideMainUI
- Defined in src/LSPlugin.user.ts:637

hideSettingsUI

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

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>(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>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): LSPluginUser
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns LSPluginUser
Implementation of ILSPluginUser.off

Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): LSPluginUser
Add a listener for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LSPluginUser
Implementation of ILSPluginUser.on

Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

onSettingsChanged

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

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): LSPluginUser
Add a one-time listener for a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns LSPluginUser
Implementation of ILSPluginUser.once

Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

provideModel

provideModel(model: Record<string, any>): LSPluginUser
Create a object to hold the methods referenced in provideUI

Example
```
logseq.provideModel({
 openCalendar () {
   console.log('Open the calendar!')
 }
})
```
Parameters
- model: Record<string, any>
Returns LSPluginUser
Implementation of ILSPluginUser.provideModel
- Defined in src/LSPlugin.user.ts:576

provideStyle

provideStyle(style: string): LSPluginUser

Inject custom css for the main Logseq app

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");
 )

Parameters

style: string

Returns LSPluginUser

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:581

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

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>
`
})

Parameters

ui: UIOptions

Returns LSPluginUser

ready

ready(model?: any, callback?: any): Promise<void>
The main Logseq app is ready to run the plugin
Parameters
- Optional model: any
  
  same as the model in provideModel
- Optional callback: any
Returns Promise<void>
Implementation of ILSPluginUser.ready
- Defined in src/LSPlugin.user.ts:519

removeAllListeners

removeAllListeners(event?: LSPluginUserEvents): LSPluginUser
Remove all listeners, or those of the specified event.
Parameters
- Optional event: LSPluginUserEvents
Returns LSPluginUser
Implementation of ILSPluginUser.removeAllListeners

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): LSPluginUser
Remove the listeners of a given event.
Type Parameters
- T extends LSPluginUserEvents
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns LSPluginUser
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:703

setMainUIAttrs

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

setMainUIInlineStyle

setMainUIInlineStyle(style: Properties<0 | string & {}, string & {}>): void
Set the style for the plugin's UI

Example
```
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-awesome-fonts
```
Example
```
logseq.setMainUIInlineStyle({
 position: 'fixed',
 zIndex: 11,
})
```
Parameters
- style: Properties<0 | string & {}, string & {}>
Returns void
Implementation of ILSPluginUser.setMainUIInlineStyle
- Defined in src/LSPlugin.user.ts:633

showMainUI

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

showSettingsUI

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

toggleMainUI

toggleMainUI(): void
toggle the plugin's UI

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

updateSettings

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

useSettingsSchema

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

Class LSPluginUser

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_baseInfo: LSPluginBaseInfo

_caller: LSPluginCaller

Returns LSPluginUser

Properties

Private _baseInfo

Private Optional _beforeunloadCallback

Type declaration

Parameters

e: any

Returns Promise<void>

Private _caller

Private _connected

Private _debugTag

Private _mExperiments

Private _mFileStorage

Private _mRequest

Private Optional _settingsSchema

Private _ui

Private _version

Static prefixed

Accessors

App

Returns IAppProxy

Assets

Returns IAssetsProxy

DB

Returns IDBProxy

Editor

Returns IEditorProxy

Experiments

Returns LSPluginExperiments

FileStorage

Returns LSPluginFileStorage

Git

Returns IGitProxy

Request

Returns LSPluginRequest

UI

Returns IUIProxy

baseInfo

Returns LSPluginBaseInfo

caller

Returns LSPluginCaller

connected

Returns boolean

effect

Returns Boolean

isMainUIVisible

Returns boolean

logger

Returns PluginLogger

settings

Returns { disabled: boolean; [key: string]: any; }

[key: string]: any

disabled: boolean

version

Returns string

Methods

_callWin

Parameters

Rest ...args: any[]

Returns Promise<any>

_execCallableAPI

Parameters

method: string

Rest ...args: any[]

Returns void

_execCallableAPIAsync

`Private` _baseInfo

`Private` `Optional` _beforeunloadCallback

`Private` _caller

`Private` _connected

`Private` _debugTag

`Private` _mExperiments

`Private` _mFileStorage

`Private` _mRequest

`Private` `Optional` _settingsSchema

`Private` _ui

`Private` _version

`Static` prefixed

Returns {
disabled: boolean;
[key: string]: any;
}

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` tag: UserProxyTags

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` opts: {
restoreEditingCursor: boolean;
}

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean