Interface ILSPluginUser

Hierarchy

EventEmitter<LSPluginUserEvents>
- ILSPluginUser

Implemented by

LSPluginUser

Properties

App

App: IAppProxy & Record<string, any>

Assets

Assets: IAssetsProxy

DB

DB: IDBProxy

Editor

Editor: IEditorProxy & Record<string, any>

Experiments

Experiments: LSPluginExperiments

FileStorage

FileStorage: LSPluginFileStorage

Git

Git: IGitProxy

Request

Request: LSPluginRequest

UI

UI: IUIProxy

baseInfo

baseInfo: LSPluginBaseInfo

The plugin configurations from package.json

beforeunload

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

Type declaration

- (callback: (() => Promise<void>)): void
- Parameters
  - callback: (() => Promise<void>)
    - (): Promise<void>
      
      Returns Promise<void>
  Returns void

caller

caller: LSPluginCaller

Duplex message caller

connected

connected: boolean

Connection status with the main app

isMainUIVisible

isMainUIVisible: boolean

`Optional` settings

settings?: {
disabled: boolean;
[key: string]: any;
}

The plugin user settings

Type declaration

[key: string]: any
disabled: boolean

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): ILSPluginUser
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 ILSPluginUser
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

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
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
- Optional opts: {
  restoreEditingCursor: boolean;
  }
  - restoreEditingCursor: boolean
Returns void
- Defined in src/LSPlugin.ts:1050

hideSettingsUI

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

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>(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>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): ILSPluginUser
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 ILSPluginUser
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): ILSPluginUser
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 ILSPluginUser
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
- Defined in src/LSPlugin.ts:1020

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): ILSPluginUser
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 ILSPluginUser
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

provideModel

provideModel(model: Record<string, any>): ILSPluginUser
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 ILSPluginUser
- Defined in src/LSPlugin.ts:966

provideStyle

provideStyle(style: string | StyleOptions): ILSPluginUser

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 | StyleOptions

Returns ILSPluginUser

provideTheme

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

provideUI

provideUI(ui: UIOptions): ILSPluginUser

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 ILSPluginUser

ready

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

removeAllListeners

removeAllListeners(event?: LSPluginUserEvents): ILSPluginUser
Remove all listeners, or those of the specified event.
Parameters
- Optional event: LSPluginUserEvents
Returns ILSPluginUser
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): ILSPluginUser
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 ILSPluginUser
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:1059

setMainUIAttrs

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

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

showMainUI

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

showSettingsUI

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

toggleMainUI

toggleMainUI(): void
toggle the plugin's UI

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

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

useSettingsSchema

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

Interface ILSPluginUser

Hierarchy

Implemented by

Index

Properties

Methods

Properties

App

Assets

DB

Editor

Experiments

FileStorage

Git

Request

UI

baseInfo

beforeunload

Type declaration

Parameters

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

Returns Promise<void>

Returns void

caller

connected

isMainUIVisible

Optional settings

Type declaration

[key: string]: any

disabled: boolean

Methods

addListener

Type Parameters

T extends LSPluginUserEvents

Parameters

event: T

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

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns ILSPluginUser

emit

Type Parameters

T extends LSPluginUserEvents

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns LSPluginUserEvents[]

hideMainUI

Parameters

Optional opts: { restoreEditingCursor: boolean; }

restoreEditingCursor: boolean

Returns void

hideSettingsUI

Returns void

listenerCount

Parameters

event: LSPluginUserEvents

Returns number

listeners

Type Parameters

T extends LSPluginUserEvents

Parameters

event: T

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

off

Type Parameters

T extends LSPluginUserEvents

Parameters

event: T

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

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Optional once: boolean

Returns ILSPluginUser

`Optional` settings

`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

`Rest` ...args: any[]

`Optional` context: any

`Rest` ...args: any[]

`Optional` context: any

`Optional` model: Record<string, any>

`Optional` callback: ((e: any) => void | {})

`Optional` model: Record<string, any>

`Optional` callback: ((e: any) => void | {})