Logseq Libs

https://logseq.github.io/plugins
Admin
Logseq Libs is the official software development kit (SDK) used to build plugins and interact with...
Tokens:12,431
Snippets:132
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install @logseq/libs

Source: https://logseq.github.io/plugins/index.html

Use yarn to add the library to your project dependencies.

```bash
yarn add @logseq/libs
```

--------------------------------

### makeSandboxStorage()

Source: https://logseq.github.io/plugins/interfaces/IAssetsProxy.html

Creates a sandbox storage instance.

```APIDOC
## makeSandboxStorage()

### Description
Creates an IAsyncStorage instance for sandbox operations.

### Returns
- **IAsyncStorage** - The sandbox storage interface.

### Added
0.0.10
```

--------------------------------

### Import Logseq SDK

Source: https://logseq.github.io/plugins/index.html

Load the Logseq plugin SDK as a global namespace in your project.

```javascript
import "@logseq/libs"
```

--------------------------------

### showSettingsUI

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Displays the plugin's settings UI.

```APIDOC
## showSettingsUI()

### Description
Opens the settings interface for the plugin.

### Returns
- **void**
```

--------------------------------

### ready

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Signals that the main Logseq app is ready to run the plugin.

```APIDOC
## ready(model?: any, callback?: any)

### Description
Registers a callback or model to be executed when the main Logseq app is ready.

### Parameters
- **model** (any) - Optional - The model object, same as in `provideModel`.
- **callback** (any) - Optional - The callback function to execute.

### Returns
- **Promise<void>**
```

--------------------------------

### ready

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Signals that the main Logseq app is ready to run the plugin. Can accept an optional model and a callback function.

```APIDOC
## ready(model?: Record<string, any>, callback?: (e: any) => void | {})

### Description
Initializes the plugin once the main Logseq application is ready. You can provide a model object or a callback function to execute upon readiness.

### Parameters
- **model** (Record<string, any>) - Optional - The model to be used by the plugin.
- **callback** ((e: any) => void | {}) - Optional - A function to execute when the app is ready.

### Returns
- **Promise<any>**
```

--------------------------------

### q

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Executes a DSL query.

```APIDOC
## q

### Description
Run a DSL query.

### Signature
`q<T = any>(dsl: string) => Promise<T[]>`
```

--------------------------------

### relaunch

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Relaunches the application.

```APIDOC
## relaunch()

### Description
Triggers an application restart.
```

--------------------------------

### provideModel

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Creates an object to hold methods that can be referenced by UI components, such as those defined in provideUI.

```APIDOC
## provideModel(model: Record<string, any>)

### Description
Creates an object to hold the methods referenced in `provideUI`.

### Parameters
- **model** (Record<string, any>) - Required - The object containing methods to be used in UI templates.

### Returns
- **this** (ILSPluginUser) - The plugin instance.

### Example
```javascript
logseq.provideModel({  
 openCalendar () {  
   console.log('Open the calendar!')  
 }  
})
```
```

--------------------------------

### provideStyle

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Injects custom CSS into the main Logseq application.

```APIDOC
## provideStyle(style: string | StyleOptions)

### Description
Injects custom CSS for the main Logseq app.

### Parameters
- **style** (string | StyleOptions) - Required - The CSS string or style options object.

### Returns
- **this** (ILSPluginUser) - The plugin instance.

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

--------------------------------

### q Property

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Executes a DSL query.

```typescript
q: <T = any>(dsl: string) => Promise<T[]>
```

--------------------------------

### execCommand

Source: https://logseq.github.io/plugins/interfaces/IGitProxy.html

Executes a Git command with the provided arguments.

```APIDOC
## execCommand

### Description
Executes a Git command using the provided array of arguments. Returns a promise that resolves to an IGitResult.

### Signature
`execCommand: (args: string[]) => Promise<IGitResult>`

### Parameters
- **args** (string[]) - Required - An array of strings representing the Git command arguments.
```

--------------------------------

### selectTheme

Source: https://logseq.github.io/plugins/interfaces/ILSPluginThemeManager.html

Applies a selected theme to the application.

```APIDOC
## selectTheme(opt: Theme | LegacyTheme, options: { effect?: boolean; emit?: boolean })

### Description
Sets the active theme for the application. You can specify whether to apply visual effects or emit events upon selection.

### Parameters
- **opt** (Theme | LegacyTheme) - The theme object to select.
- **options** (Object) - Configuration options for the selection.
  - **effect** (boolean, optional) - Whether to apply theme effects.
  - **emit** (boolean, optional) - Whether to emit a theme change event.

### Returns
- **Promise<void>**
```

--------------------------------

### loadIgnoreFile

Source: https://logseq.github.io/plugins/interfaces/IGitProxy.html

Loads the content of the Git ignore file.

```APIDOC
## loadIgnoreFile

### Description
Reads and returns the content of the Git ignore file as a string.

### Signature
`loadIgnoreFile: () => Promise<string>`
```

--------------------------------

### showMainUI

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Displays the plugin's UI.

```APIDOC
## showMainUI(opts?: { autoFocus: boolean })

### Description
Makes the plugin's main UI visible to the user.

### Parameters
- **opts** ({ autoFocus: boolean }) - Optional - Configuration options, such as autoFocus.

### Returns
- **void**
```

--------------------------------

### provideUI

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Injects custom UI at a specific DOM node. Event handlers must be defined in provideModel.

```APIDOC
## provideUI(ui: UIOptions)

### Description
Injects custom UI at a specific DOM node. Event handlers cannot be passed by string, so they must be created in `provideModel`.

### Parameters
- **ui** (UIOptions) - Required - The configuration object for the UI component.

### Returns
- **LSPluginUser**
```

--------------------------------

### Application State and Info

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Methods to retrieve information about the current graph, user configuration, and application state.

```APIDOC
## getCurrentGraph() -> Promise<AppGraphInfo>
Returns information about the currently active graph.

## getStateFromStore(path: string | string[]) -> Promise<T>
Retrieves state from the application store based on the provided path.

## getUserConfigs() -> Promise<AppUserConfigs>
Returns the current user configuration settings.
```

--------------------------------

### builtInOpen(path: string)

Source: https://logseq.github.io/plugins/interfaces/IAssetsProxy.html

Attempts to open an asset file within the Logseq application.

```APIDOC
## builtInOpen(path: string)

### Description
Try to open an asset type file in the Logseq app.

### Parameters
- **path** (string) - Required - The path to the asset file.

### Returns
- **Promise<boolean>** - Returns true if the file was opened successfully, false otherwise.

### Added
0.0.16
```

--------------------------------

### setFullScreen

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Toggles or sets the full-screen mode.

```APIDOC
## setFullScreen(flag)

### Description
Controls the full-screen state of the application window.

### Parameters
- **flag** (boolean | "toggle") - Required - The state to set or "toggle" to switch current state.
```

--------------------------------

### Generate CLJS SDK Wrappers

Source: https://logseq.github.io/plugins/index.html

Commands to regenerate the ClojureScript facade from JS SDK declarations.

```bash
yarn run generate:schema              # emits dist/logseq-sdk-schema.json  
bb libs:generate-cljs-sdk            # emits logseq/core.cljs and per-proxy files under target/generated-cljs
```

--------------------------------

### ILSPluginUser Interface Methods

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

The ILSPluginUser interface provides methods for managing plugin lifecycle, UI interactions, event subscriptions, and settings management.

```APIDOC
## ILSPluginUser Methods

### UI Management
- **showMainUI(opts?: { autoFocus: boolean }): void** - Displays the main plugin UI.
- **hideMainUI(opts?: { restoreEditingCursor: boolean }): void** - Hides the main plugin UI.
- **toggleMainUI(): void** - Toggles the visibility of the main plugin UI.
- **showSettingsUI(): void** - Displays the plugin settings UI.
- **hideSettingsUI(): void** - Hides the plugin settings UI.

### Event Handling
- **on<T>(event: T, fn: (...args: any[]) => void, context?: any): this** - Registers an event listener.
- **off<T>(event: T, fn?: (...args: any[]) => void, context?: any, once?: boolean): this** - Removes an event listener.
- **emit<T>(event: T, ...args: any[]): boolean** - Emits an event to registered listeners.

### Plugin Configuration
- **useSettingsSchema(schemas: SettingSchemaDesc[]): this** - Defines the settings schema for the plugin.
- **updateSettings(attrs: Record<string, any>): void** - Updates the plugin settings.
- **provideModel(model: Record<string, any>): this** - Provides a model for the plugin UI.
- **provideStyle(style: string | StyleOptions): this** - Injects CSS styles into the application.

### Lifecycle
- **ready(model?: Record<string, any>, callback?: (e: any) => void | {}): Promise<any>** - Initializes the plugin and returns a promise that resolves when ready.
```

--------------------------------

### provideModel

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Registers a model object to hold methods referenced in the plugin UI.

```APIDOC
## provideModel(model: Record<string, any>): LSPluginUser

### Description
Create an object to hold the methods referenced in provideUI.

### Parameters
- **model** (Record<string, any>) - Required - The model object containing methods.
```

--------------------------------

### provideUI

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Injects custom UI elements into specific DOM nodes within the Logseq application.

```APIDOC
## provideUI(ui: UIOptions)

### Description
Injects custom UI at a specific DOM node. Event handlers must be defined in `provideModel` as they cannot be passed directly via string.

### Parameters
- **ui** (UIOptions) - Required - The configuration object for the UI element.

### Returns
- **this** (ILSPluginUser) - The plugin instance.

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

--------------------------------

### Handle Macro Renderer Slots

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Register a callback to provide UI slots for macro renderers in blocks. This allows for dynamic content rendering based on macro arguments.

```javascript
// e.g. {{renderer :h1, hello world, green}}  
  
logseq.App.onMacroRendererSlotted(({ slot, payload: { arguments } }) => {  
  let [type, text, color] = arguments  
  if (type !== ':h1') return  
   logseq.provideUI({  
     key: 'h1-playground',  
     slot, template: `  
      <h2 style="color: ${color || 'red'}">${text}</h2>  
     `,  
  })  
})
```

--------------------------------

### makeUrl(path: string)

Source: https://logseq.github.io/plugins/interfaces/IAssetsProxy.html

Generates an asset scheme URL based on the current graph.

```APIDOC
## makeUrl(path: string)

### Description
Generates an assets scheme URL based on the current graph for the provided path.

### Parameters
- **path** (string) - Required - The path to the asset.

### Returns
- **Promise<string>** - The generated asset URL.

### Added
0.0.15
```

--------------------------------

### useSettingsSchema

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Registers a settings schema for the plugin.

```APIDOC
## useSettingsSchema(schemas: SettingSchemaDesc[])

### Description
Defines the configuration schema for the plugin's settings.

### Parameters
- **schemas** (SettingSchemaDesc[]) - Required - An array of setting schema descriptions.

### Returns
- **this**
```

--------------------------------

### Command Registration

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Methods for registering custom commands and command palette entries.

```APIDOC
## registerCommand(type: string, opts: { desc?: string; key: string; keybinding?: SimpleCommandKeybinding; label: string; palette?: boolean; }, action: SimpleCommandCallback) -> void
Registers a new command in the application.

## registerCommandPalette(opts: { key: string; keybinding?: SimpleCommandKeybinding; label: string; }, action: SimpleCommandCallback) -> void
Registers a command specifically for the command palette.
```

--------------------------------

### Define CreatedAt Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Timestamp of page creation.

```typescript
createdAt: number
```

--------------------------------

### registerUIItem

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Registers a UI item in the toolbar or pagebar.

```APIDOC
## registerUIItem(type, opts)

### Description
Adds a UI component to the specified application area.

### Parameters
- **type** ("toolbar" | "pagebar") - Required - The location to place the UI item.
- **opts** ({ key: string; template: string }) - Required - Configuration containing the key and HTML template.
```

--------------------------------

### addListener

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Registers a listener function for a specific plugin event.

```APIDOC
## addListener<T extends LSPluginUserEvents>(event: T, fn: (...args: any[]) => void, context?: any): this

### Description
Adds a listener for a given event.

### Parameters
- **event** (T) - Required - The event name.
- **fn** (Function) - Required - The callback function.
- **context** (any) - Optional - The execution context.
```

--------------------------------

### Template Management

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Methods for creating, checking, and retrieving templates within the application.

```APIDOC
## createTemplate(target: string, name: string, opts?: { overwrite: boolean }) -> Promise<any>
Creates a new template at the specified target.

## existTemplate(name: string) -> Promise<Boolean>
Checks if a template with the given name exists.

## getTemplate(name: string) -> Promise<BlockEntity>
Retrieves a specific template by name.

## insertTemplate(target: string, name: string) -> Promise<any>
Inserts a template into the specified target.
```

--------------------------------

### registerTheme

Source: https://logseq.github.io/plugins/interfaces/ILSPluginThemeManager.html

Registers a new theme with a specific ID.

```APIDOC
## registerTheme(id: string, opt: Theme)

### Description
Registers a theme into the system using the provided ID and theme configuration.

### Parameters
- **id** (string) - The unique identifier for the theme.
- **opt** (Theme) - The theme configuration object.

### Returns
- **Promise<void>**
```

--------------------------------

### LSPluginPkgConfig Interface Definition

Source: https://logseq.github.io/plugins/interfaces/LSPluginPkgConfig.html

Defines the structure for plugin configuration objects.

```typescript
interface LSPluginPkgConfig {  
devEntry: string;  
entry: string;  
icon: string;  
id: string;  
main: string;  
mode: "iframe" | "shadow";  
theme: unknown;  
themes: Theme[];  
title: string;  
}
```

--------------------------------

### Event Hooks

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Methods for subscribing to application lifecycle events and UI slots.

```APIDOC
## onRouteChanged(callback: (data: { path: string; template: string }) => void) -> IUserHook
Registers a callback to be executed when the application route changes.

## onThemeChanged(callback: (data: Partial<{ mode: string; name: string; pid: string; url: string }>) => void) -> IUserHook
Registers a callback for theme change events.

## onMacroRendererSlotted(callback: (data: { payload: { arguments: string[]; uuid: string; [key: string]: any } }) => void) -> IUserSlotHook
Provides a UI slot for block renderer macros.
```

--------------------------------

### registerCommandShortcut

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Registers a keyboard shortcut for a specific command action.

```APIDOC
## registerCommandShortcut(keybinding, action, opts?)

### Description
Registers a command shortcut that triggers a callback when the specified keybinding is pressed.

### Parameters
- **keybinding** (string | SimpleCommandKeybinding) - Required - The key combination to trigger the action.
- **action** (SimpleCommandCallback) - Required - The function to execute.
- **opts** (Partial<{desc: string, extras: Record<string, any>, key: string, label: string}>) - Optional - Additional configuration options for the command.
```

--------------------------------

### Define Optional Namespace Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Reference to the page namespace.

```typescript
namespace?: IEntityID
```

--------------------------------

### IAppProxy SDK Reference

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

The IAppProxy interface provides methods for managing application state, templates, UI elements, and event listeners within a Logseq plugin.

```APIDOC
## IAppProxy Interface

### Overview
Provides application-level APIs for plugins to interact with the Logseq environment.

### Methods
- **checkCurrentIsDbGraph()**: Promise<Boolean> - Checks if the current graph is a database graph.
- **clearRightSidebarBlocks(opts?: { close: boolean })**: void - Clears blocks from the right sidebar.
- **createTemplate(target: string, name: string, opts?: { overwrite: boolean })**: Promise<any> - Creates a new template.
- **execGitCommand(args: string[])**: Promise<string> - Executes a git command.
- **existTemplate(name: string)**: Promise<Boolean> - Checks if a template exists.
- **getCurrentGraph()**: Promise<AppGraphInfo> - Retrieves current graph information.
- **getCurrentGraphConfigs(...keys: string[])**: Promise<any> - Retrieves configuration keys for the current graph.
- **getCurrentGraphFavorites()**: Promise<(string | PageEntity)[]> - Gets favorite pages/blocks.
- **getCurrentGraphRecent()**: Promise<(string | PageEntity)[]> - Gets recently accessed pages/blocks.
- **getCurrentGraphTemplates()**: Promise<Record<string, BlockEntity>> - Retrieves all templates in the current graph.
- **getInfo(key?: keyof AppInfo)**: Promise<any> - Gets application information.
- **getStateFromStore<T>(path: string | string[])**: Promise<T> - Retrieves state from the application store.
- **getTemplate(name: string)**: Promise<BlockEntity> - Retrieves a specific template.
- **getUserConfigs()**: Promise<AppUserConfigs> - Gets user configurations.
- **getUserInfo()**: Promise<AppUserInfo> - Gets user information.
- **insertTemplate(target: string, name: string)**: Promise<any> - Inserts a template into the target.
- **invokeExternalCommand(type: ExternalCommandType, ...args: any[])**: Promise<void> - Invokes an external command.
- **openExternalLink(url: string)**: Promise<void> - Opens a URL in the default browser.
- **quit()**: Promise<void> - Quits the application.
- **registerCommand(type: string, opts: { desc?: string; key: string; keybinding?: SimpleCommandKeybinding; label: string; palette?: boolean; }, action: SimpleCommandCallback)**: void - Registers a custom command.
- **relaunch()**: Promise<void> - Relaunches the application.
- **setFullScreen(flag: boolean | "toggle")**: void - Toggles or sets full-screen mode.
- **setLeftSidebarVisible(flag: boolean | "toggle")**: void - Toggles or sets left sidebar visibility.
- **setRightSidebarVisible(flag: boolean | "toggle")**: void - Toggles or sets right sidebar visibility.
- **setZoomFactor(factor: number)**: void - Sets the application zoom factor.
```

--------------------------------

### saveIgnoreFile

Source: https://logseq.github.io/plugins/interfaces/IGitProxy.html

Saves the provided content to the Git ignore file.

```APIDOC
## saveIgnoreFile

### Description
Writes the specified content to the Git ignore file.

### Signature
`saveIgnoreFile: (content: string) => Promise<void>`

### Parameters
- **content** (string) - Required - The string content to be saved to the ignore file.
```

--------------------------------

### themes

Source: https://logseq.github.io/plugins/interfaces/ILSPluginThemeManager.html

Retrieves a map of all currently registered themes.

```APIDOC
## get themes()

### Description
Returns a map containing all registered themes, where the key is the theme ID and the value is an array of Theme objects.

### Returns
- **Map<string, Theme[]>** - A map of theme identifiers to their respective theme definitions.
```

--------------------------------

### Display a message using the UI proxy

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Use the UI proxy to display a notification message within the Logseq interface.

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

--------------------------------

### Define Optional File Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Reference to the associated file entity.

```typescript
file?: IEntityID
```

--------------------------------

### Define Format Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Specifies the file format of the page.

```typescript
format: "markdown" | "org"
```

--------------------------------

### LSPluginPkgConfig Interface Definition

Source: https://logseq.github.io/plugins/interfaces/LSPluginPkgConfig.html

The LSPluginPkgConfig interface specifies the required and optional properties for configuring a Logseq plugin.

```APIDOC
## Interface LSPluginPkgConfig

### Properties
- **devEntry** (string) - Alternative entrypoint for development.
- **entry** (string) - The primary entrypoint for the plugin.
- **icon** (string) - The icon associated with the plugin.
- **id** (string) - The unique identifier for the plugin.
- **main** (string) - The main file path for the plugin.
- **mode** ("iframe" | "shadow") - The UI rendering mode for the plugin.
- **theme** (unknown) - Legacy theme property; do not use.
- **themes** (Theme[]) - A list of themes associated with the plugin.
- **title** (string) - The display title of the plugin.
```

--------------------------------

### showMsg

Source: https://logseq.github.io/plugins/interfaces/IUIProxy.html

Displays a message in the UI.

```APIDOC
## showMsg(content: string, status?: string, opts?: Partial<UIMsgOptions>)

### Description
Displays a notification or message in the Logseq UI.

### Parameters
- **content** (string) - Required - The message text to display.
- **status** (string) - Optional - The status level of the message.
- **opts** (Partial<UIMsgOptions>) - Optional - Additional configuration options for the message.

### Returns
- **Promise<string>** - The unique key of the displayed message.
```

--------------------------------

### toggleMainUI

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Toggles the visibility of the plugin's UI.

```APIDOC
## toggleMainUI()

### Description
Switches the visibility state of the plugin's main UI between shown and hidden.

### Returns
- **void**
```

--------------------------------

### SimpleCommandKeybinding Type Definition

Source: https://logseq.github.io/plugins/types/SimpleCommandKeybinding.html

Defines the structure for command keybindings, specifying the required binding and optional properties for macOS and operational modes.

```typescript
type SimpleCommandKeybinding = {  
binding: Keybinding;  
mac?: string;  
mode?: "global" | "non-editing" | "editing";  
}
```

--------------------------------

### Provide a model for UI methods

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Registers an object containing methods that can be referenced by UI components.

```typescript
logseq.provideModel({  
 openCalendar () {  
   console.log('Open the calendar!')  
 }  
})
```

--------------------------------

### Retrieve Application State

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Access specific application state values using a path string or array. Refer to the Logseq source for valid state paths.

```javascript
const isDocMode = await logseq.App.getStateFromStore('document/mode?')
```

--------------------------------

### onChanged

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Hooks into all transaction data of the database.

```APIDOC
## onChanged

### Description
Hook all transaction data of DB.

### Signature
`onChanged: IUserHook<{ blocks: BlockEntity[]; txData: IDatom[]; txMeta?: { outlinerOp: string; [key: string]: any }; }>`
```

--------------------------------

### listFilesOfCurrentGraph(exts?: string | string[])

Source: https://logseq.github.io/plugins/interfaces/IAssetsProxy.html

Lists files within the current graph, optionally filtered by file extensions.

```APIDOC
## listFilesOfCurrentGraph(exts?: string | string[])

### Description
Retrieves a list of files in the current graph, optionally filtered by specific extensions.

### Parameters
- **exts** (string | string[]) - Optional - File extensions to filter by.

### Returns
- **Promise<Array<{accessTime: number, birthTime: number, changeTime: number, modifiedTime: number, path: string, size: number}>>** - A list of file metadata objects.

### Added
0.0.2
```

--------------------------------

### updateSettings

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Updates the plugin's settings with new values.

```APIDOC
## updateSettings(attrs: Record<string, any>)

### Description
Updates the plugin settings with the provided key-value pairs.

### Parameters
- **attrs** (Record<string, any>) - Required - The settings to update.

### Returns
- **void**
```

--------------------------------

### Define Name Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

The name of the page.

```typescript
name: string
```

--------------------------------

### IEditorProxy Methods

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

The IEditorProxy interface exposes various methods for managing blocks and pages within the Logseq editor.

```APIDOC
## IEditorProxy Methods

### Description
Methods for manipulating blocks, pages, and editor state in Logseq.

### Methods
- **addBlockTag**(blockId: BlockIdentity, tagId: BlockIdentity) -> Promise<void>
- **appendBlockInPage**(page: PageIdentity, content: string, opts?: Partial<{ properties: {} }>) -> Promise<BlockEntity>
- **createPage**(pageName: string, properties?: {}, opts?: Partial<{ createFirstBlock: boolean, customUUID: string, format: BlockEntity["format"], journal: boolean, redirect: boolean }>) -> Promise<PageEntity>
- **deletePage**(pageName: string) -> Promise<void>
- **getBlock**(srcBlock: number | BlockIdentity, opts?: Partial<{ includeChildren: boolean }>) -> Promise<BlockEntity>
- **getCurrentBlock**() -> Promise<BlockEntity>
- **getCurrentPage**() -> Promise<BlockEntity | PageEntity>
- **insertBlock**(srcBlock: number | BlockIdentity, content: string, opts?: Partial<{ before: boolean, customUUID: string, end: boolean, properties: {}, sibling: boolean, start: boolean }>) -> Promise<BlockEntity>
- **openInRightSidebar**(id: string | number) -> void
- **registerSlashCommand**(tag: string, action: BlockCommandCallback | [cmd: SlashCommandActionCmd, ...args: any[]][]) -> unknown
- **removeBlock**(srcBlock: number | BlockIdentity) -> Promise<void>
```

--------------------------------

### Access Individual Configuration Properties

Source: https://logseq.github.io/plugins/interfaces/AppUserConfigs.html

Individual property definitions for the AppUserConfigs interface.

```typescript
currentGraph: string
```

```typescript
enabledFlashcards: boolean
```

```typescript
enabledJournals: boolean
```

```typescript
preferredDateFormat: string
```

```typescript
preferredFormat: "markdown" | "org"
```

```typescript
preferredLanguage: string
```

```typescript
preferredStartOfWeek: string
```

```typescript
preferredThemeMode: ThemeMode
```

```typescript
preferredWorkflow: string
```

```typescript
showBracket: boolean
```

--------------------------------

### onChanged Property

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Hook for monitoring all transaction data within the database.

```typescript
onChanged: IUserHook<  
{  
blocks: BlockEntity[];  
txData: IDatom[];  
txMeta?: { outlinerOp: string; [key: string]: any };  
},  
>
```

--------------------------------

### registerSlashCommand

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Registers a custom command in the Logseq slash command list.

```APIDOC
## registerSlashCommand

### Description
Registers a custom command which will be added to the Logseq slash command list.

### Parameters
- **tag** (string) - Displayed name of command
- **action** (BlockCommandCallback | [cmd: SlashCommandActionCmd, ...args: any[]][]) - Callback function or array of fixed commands to run when the command is called
```

--------------------------------

### LSPluginPkgConfig Property Definitions

Source: https://logseq.github.io/plugins/interfaces/LSPluginPkgConfig.html

Individual property definitions for the LSPluginPkgConfig interface.

```typescript
devEntry: string
```

```typescript
entry: string
```

```typescript
icon: string
```

```typescript
id: string
```

```typescript
main: string
```

```typescript
mode: "iframe" | "shadow"
```

```typescript
theme: unknown
```

```typescript
themes: Theme[]
```

```typescript
title: string
```

--------------------------------

### Set Main UI Inline Style

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Applies CSS styles to the plugin's main UI container.

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

--------------------------------

### Define UIBaseOptions Type

Source: https://logseq.github.io/plugins/types/UIBaseOptions.html

The structure of the UIBaseOptions type alias used for configuring UI components.

```typescript
type UIBaseOptions = {  
attrs?: Record<string, string>;  
close?: "outside" | string;  
key?: string;  
replace?: boolean;  
reset?: boolean;  
style?: CSS.Properties;  
template: string | null;  
}
```

--------------------------------

### Define LSPluginBaseInfo Interface

Source: https://logseq.github.io/plugins/interfaces/LSPluginBaseInfo.html

The structure representing the base information of a Logseq plugin.

```typescript
interface LSPluginBaseInfo {  
effect: boolean;  
id: string;  
iir: boolean;  
lsr: string;  
mode: "iframe" | "shadow";  
settings: { disabled: boolean } & Record<string, unknown>;  
}
```

--------------------------------

### datascriptQuery

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Executes a Datascript query against the database.

```APIDOC
## datascriptQuery

### Description
Run a datascript query.

### Signature
`datascriptQuery<T = any>(query: string, ...inputs: any[]) => Promise<T>`
```

--------------------------------

### registerPageMenuItem

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Registers a menu item for pages.

```APIDOC
## registerPageMenuItem(tag, action)

### Description
Adds a custom item to the page menu.

### Parameters
- **tag** (string) - Required - The identifier for the menu item.
- **action** ((e: IHookEvent & { page: string }) => void) - Required - The callback function executed when the item is selected.
```

--------------------------------

### Define AppUserConfigs Interface

Source: https://logseq.github.io/plugins/interfaces/AppUserConfigs.html

The primary interface structure for accessing user configuration settings within the Logseq application.

```typescript
interface AppUserConfigs {  
currentGraph: string;  
enabledFlashcards: boolean;  
enabledJournals: boolean;  
preferredDateFormat: string;  
preferredFormat: "markdown" | "org";  
preferredLanguage: string;  
preferredStartOfWeek: string;  
preferredThemeMode: ThemeMode;  
preferredWorkflow: string;  
showBracket: boolean;  
[key: string]: unknown;  
}
```

--------------------------------

### IDBProxy Interface Definition

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

The complete interface definition for IDBProxy, outlining available query methods and event hooks.

```typescript
interface IDBProxy {  
datascriptQuery: <T = any>(  
query: string,  
...inputs: any[],  
) => Promise<T>;  
onChanged: IUserHook<  
{  
blocks: BlockEntity[];  
txData: IDatom[];  
txMeta?: { outlinerOp: string; [key: string]: any };  
},  
>;  
q: <T = any>(dsl: string) => Promise<T[]>;  
onBlockChanged(  
uuid: string,  
callback: (  
block: BlockEntity,  
txData: IDatom[],  
txMeta?: { outlinerOp: string; [key: string]: any },  
) => void,  
): IUserOffHook;  
}
```

--------------------------------

### hideMainUI

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Hides the plugin's main user interface.

```APIDOC
## hideMainUI(opts?: { restoreEditingCursor: boolean }): void

### Description
Hide the plugin's UI.

### Parameters
- **opts** (Object) - Optional - Configuration options including restoreEditingCursor.
```

--------------------------------

### setMainUIAttrs

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Sets attributes for the plugin's main UI.

```APIDOC
## setMainUIAttrs(attrs: Record<string, any>)

### Description
Updates the attributes of the plugin's main UI container.

### Parameters
- **attrs** (Record<string, any>) - Required - The attributes to set.

### Returns
- **void**
```

--------------------------------

### Retrieve current page blocks as a tree

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Fetches all blocks of the currently active page in a hierarchical tree structure.

```typescript
const blocks = await logseq.Editor.getCurrentPageBlocksTree()  
initMindMap(blocks)
```

--------------------------------

### toJs

Source: https://logseq.github.io/plugins/interfaces/IUtilsProxy.html

Converts a Logseq object to a standard JavaScript object.

```APIDOC
## toJs

### Description
Converts a provided Logseq object into a standard JavaScript object. This method returns a Promise that resolves to the converted object.

### Signature
`toJs<R = unknown>(obj: {}): Promise<R>`

### Parameters
- **obj** ({}) - Required - The Logseq object to be converted.

### Returns
- **Promise<R>** - A promise that resolves to the converted object of type R.
```

--------------------------------

### Insert batch blocks

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Inserts multiple blocks at once. The keepUUID option allows setting custom UUIDs via properties.id.

```text
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-reddit-hot-news  
  
`keepUUID` will allow you to set a custom UUID for blocks by setting their properties.id
```

--------------------------------

### resolveResourceFullUrl

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Resolves a file path to a full URL for a resource.

```APIDOC
## resolveResourceFullUrl(filePath: string)

### Description
Converts a relative file path into a full URL accessible by the plugin.

### Parameters
- **filePath** (string) - Required - The path to the resource.

### Returns
- **string**
```

--------------------------------

### IEditorProxy Interface Definition

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

The complete interface definition for IEditorProxy, detailing all available methods for editor manipulation.

```typescript
interface IEditorProxy {  
addBlockTag: (  
blockId: BlockIdentity,  
tagId: BlockIdentity,  
) => Promise<void>;  
addTagExtends: (  
tagId: BlockIdentity,  
parentTagIdOrName: BlockIdentity,  
) => Promise<void>;  
addTagProperty: (  
tagId: BlockIdentity,  
propertyIdOrName: BlockIdentity,  
) => Promise<void>;  
appendBlockInPage: (  
page: PageIdentity,  
content: string,  
opts?: Partial<{ properties: {} }>,  
) => Promise<BlockEntity>;  
checkEditing: () => Promise<string | boolean>;  
clearSelectedBlocks: () => Promise<void>;  
createJournalPage: (date: string | Date) => Promise<PageEntity>;  
createPage: (  
pageName: string,  
properties?: {},  
opts?: Partial<  
{  
createFirstBlock: boolean;  
customUUID: string;  
format: BlockEntity["format"];  
journal: boolean;  
redirect: boolean;  
},  
>,  
) => Promise<PageEntity>;  
createTag: (  
tagName: string,  
opts?: Partial<{ uuid: string }>,  
) => Promise<PageEntity>;  
deletePage: (pageName: string) => Promise<void>;  
editBlock: (  
srcBlock: BlockIdentity,  
opts?: { pos: number },  
) => Promise<void>;  
exitEditingMode: (selectBlock?: boolean) => Promise<void>;  
getAllPages: (repo?: string) => Promise<PageEntity[]>;  
getAllProperties: () => Promise<PageEntity[]>;  
getAllTags: () => Promise<PageEntity[]>;  
getBlock: (  
srcBlock: number | BlockIdentity,  
opts?: Partial<{ includeChildren: boolean }>,  
) => Promise<BlockEntity>;  
getBlockProperties: (  
block: number | BlockIdentity,  
) => Promise<Record<string, any>>;  
getBlockProperty: (  
block: number | BlockIdentity,  
key: string,  
) => Promise<BlockEntity>;  
getCurrentBlock: () => Promise<BlockEntity>;  
getCurrentPage: () => Promise<BlockEntity | PageEntity>;  
getCurrentPageBlocksTree: () => Promise<BlockEntity[]>;  
getEditingBlockContent: () => Promise<string>;  
getEditingCursorPosition: () => Promise<BlockCursorPosition>;  
getNextSiblingBlock: (  
srcBlock: number | BlockIdentity,  
) => Promise<BlockEntity>;  
getPage: (  
srcPage: number | PageIdentity,  
opts?: Partial<{ includeChildren: boolean }>,  
) => Promise<PageEntity>;  
getPageBlocksTree: (srcPage: PageIdentity) => Promise<BlockEntity[]>;  
getPageLinkedReferences: (  
srcPage: PageIdentity,  
) => Promise<[page: PageEntity, blocks: BlockEntity[]][]>;  
getPageProperties: (  
page: number | PageIdentity,  
) => Promise<Record<string, any>>;  
getPagesFromNamespace: (namespace: string) => Promise<PageEntity[]>;  
getPagesTreeFromNamespace: (namespace: string) => Promise<PageEntity[]>;  
getPreviousSiblingBlock: (  
srcBlock: number | BlockIdentity,  
) => Promise<BlockEntity>;  
getProperty: (key: string) => Promise<BlockEntity>;  
getSelectedBlocks: () => Promise<BlockEntity[]>;  
getTag: (nameOrIdent: string | number) => Promise<PageEntity>;  
getTagObjects: (nameOrIdent: string) => Promise<BlockEntity[]>;  
getTagsByName: (tagName: string) => Promise<PageEntity[]>;  
insertAtEditingCursor: (content: string) => Promise<void>;  
insertBatchBlock: (  
srcBlock: BlockIdentity,  
batch: IBatchBlock | IBatchBlock[],  
opts?: Partial<{ before: boolean; keepUUID: boolean; sibling: boolean }>,  
) => Promise<BlockEntity[]>;  
insertBlock: (  
srcBlock: number | BlockIdentity,  
content: string,  
opts?: Partial<  
{  
before: boolean;  
customUUID: string;  
end: boolean;  
properties: {};  
sibling: boolean;  
start: boolean;  
},  
>,  
) => Promise<BlockEntity>;  
isPageBlock: (block: BlockEntity | PageEntity) => Boolean;  
moveBlock: (  
srcBlock: BlockIdentity,  
targetBlock: BlockIdentity,  
opts?: Partial<{ before: boolean; children: boolean }>,  
) => Promise<void>;  
newBlockUUID: () => Promise<string>;  
onInputSelectionEnd: IUserHook<  
{  
caret: any;  
end: number;  
point: { x: number; y: number };  
start: number;  
text: string;  
},  
>;  
openInRightSidebar: (id: string | number) => void;  
openPDFViewer: (assetBlockIdOrFileUrl: string | number) => Promise<void>;  
prependBlockInPage: (  
page: PageIdentity,  
content: string,  
opts?: Partial<{ properties: {} }>,  
) => Promise<BlockEntity>;  
registerBlockContextMenuItem: (  
label: string,  
action: BlockCommandCallback,  
) => unknown;  
registerHighlightContextMenuItem: (  
label: string,  
action: SimpleCommandCallback,  
opts?: { clearSelection: boolean },  
) => unknown;  
registerSlashCommand: (  
tag: string,  
action:  
| BlockCommandCallback  
| [cmd: SlashCommandActionCmd, ...args: any[]][],  
) => unknown;  
removeBlock: (srcBlock: number | BlockIdentity) => Promise<void>;  
removeBlockIcon: (blockId: BlockIdentity) => Promise<void>;  
removeBlockProperty: (  
block: number | BlockIdentity,  
key: string,  
) => Promise<void>;  
removeBlockTag: (  
blockId: BlockIdentity,  
tagId: BlockIdentity,  
) => Promise<void>;  
removeProperty: (key: string) => Promise<void>;  
removeTagExtends: (  
tagId: BlockIdentity,  
parentTagIdOrName: BlockIdentity,  

```

--------------------------------

### unregisterTheme

Source: https://logseq.github.io/plugins/interfaces/ILSPluginThemeManager.html

Removes a registered theme from the system.

```APIDOC
## unregisterTheme(id: string, effect?: boolean)

### Description
Unregisters a theme by its ID. Optionally triggers a visual effect during removal.

### Parameters
- **id** (string) - The ID of the theme to remove.
- **effect** (boolean, optional) - Whether to apply a visual effect during unregistration.

### Returns
- **Promise<void>**
```

--------------------------------

### Inject custom UI components

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Injects custom UI elements into the Logseq DOM. Event handlers must be defined in the model provided via provideModel.

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

--------------------------------

### insertBlock

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Inserts a new block relative to a source block with optional configuration.

```APIDOC
## insertBlock

### Description
Inserts a new block relative to a source block with optional configuration.

### Signature
`insertBlock(srcBlock: number | BlockIdentity, content: string, opts?: Partial<{ before: boolean; customUUID: string; end: boolean; properties: {}; sibling: boolean; start: boolean; }>): Promise<BlockEntity>`
```

--------------------------------

### Define Optional Properties Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Custom properties associated with the page.

```typescript
properties?: Record<string, any>
```

--------------------------------

### Property Definitions

Source: https://logseq.github.io/plugins/interfaces/LSPluginBaseInfo.html

Individual property type definitions for the LSPluginBaseInfo interface.

```typescript
effect: boolean
```

```typescript
id: string
```

```typescript
iir: boolean
```

```typescript
lsr: string
```

```typescript
mode: "iframe" | "shadow"
```

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

--------------------------------

### setMainUIInlineStyle

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Sets the CSS inline style for the plugin's UI.

```APIDOC
## setMainUIInlineStyle(style: Properties)

### Description
Applies CSS styles directly to the plugin's main UI element.

### Parameters
- **style** (Properties) - Required - The CSS properties to apply.

### Returns
- **void**
```

--------------------------------

### Inject custom CSS styles

Source: https://logseq.github.io/plugins/classes/LSPluginUser.html

Injects custom CSS into the main Logseq application. Use this to apply themes or custom styling to the plugin interface.

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

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

--------------------------------

### Define Optional Ident Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Optional identifier string.

```typescript
ident?: string
```

--------------------------------

### Inject custom CSS styles

Source: https://logseq.github.io/plugins/interfaces/ILSPluginUser.html

Injects custom CSS into the Logseq application.

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

--------------------------------

### Theme Interface Definition

Source: https://logseq.github.io/plugins/interfaces/Theme.html

Defines the structure of the Theme interface used within the application.

```typescript
interface Theme {  
description?: string;  
mode: ThemeMode;  
name: string;  
pid: string;  
url: string;  
}
```

--------------------------------

### insertBatchBlock

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Inserts a batch of blocks relative to a source block.

```APIDOC
## insertBatchBlock

### Description
Inserts a batch of blocks relative to a source block.

### Signature
`insertBatchBlock(srcBlock: BlockIdentity, batch: IBatchBlock | IBatchBlock[], opts?: Partial<{ before: boolean; keepUUID: boolean; sibling: boolean }>): Promise<BlockEntity[]>`
```

--------------------------------

### getPageBlocksTree

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Retrieves all blocks for the specified page.

```APIDOC
## getPageBlocksTree

### Description
Retrieves all blocks for the specified page.

### Signature
`getPageBlocksTree(srcPage: PageIdentity): Promise<BlockEntity[]>`

### Parameters
- **srcPage** (PageIdentity) - Required - The page name or uuid.
```

--------------------------------

### registerSearchService

Source: https://logseq.github.io/plugins/interfaces/IAppProxy.html

Registers a custom search service.

```APIDOC
## registerSearchService(s)

### Description
Registers a search service implementation for the application.

### Parameters
- **s** (T extends IPluginSearchServiceHooks) - Required - The search service instance.
```

--------------------------------

### Insert a single block

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Inserts a new block relative to an existing block with various configuration options.

```text
https://github.com/logseq/logseq-plugin-samples/tree/master/logseq-reddit-hot-news
```

--------------------------------

### updateBlock

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Updates the content and properties of a block.

```APIDOC
## updateBlock

### Description
Updates the content of a specified block.

### Signature
`updateBlock(srcBlock: number | BlockIdentity, content: string, opts?: Partial<{ properties: {} }>) => Promise<void>`
```

--------------------------------

### upsertProperty

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Creates or updates a property definition.

```APIDOC
## upsertProperty(key: string, schema?: Partial<{ cardinality: "many" | "one", hide: boolean, public: boolean, type: string }>, opts?: { name?: string })

### Description
Upserts a property definition with optional schema configuration.

### Parameters
- **key** (string) - The property key.
- **schema** (Partial) - The schema definition for the property.
- **opts** (object) - Additional options including name.

### Returns
- **Promise<IEntityID>**
```

--------------------------------

### updateBlock

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Updates the content and properties of a specific block.

```APIDOC
## updateBlock(srcBlock: number | BlockIdentity, content: string, opts?: Partial<{ properties: {} }>)

### Description
Updates the content of a block identified by its ID or index, with optional property updates.

### Parameters
- **srcBlock** (number | BlockIdentity) - The block identifier.
- **content** (string) - The new content for the block.
- **opts** (Partial<{ properties: {} }>) - Optional configuration for block properties.

### Returns
- **Promise<void>**
```

--------------------------------

### onBlockChanged

Source: https://logseq.github.io/plugins/interfaces/IDBProxy.html

Subscribes to change events for a specific block.

```APIDOC
## onBlockChanged

### Description
Subscribe a specific block changed event.

### Parameters
- **uuid** (string) - The UUID of the block to monitor.
- **callback** (function) - Function called when the block changes, receiving the block entity, transaction data, and metadata.

### Returns
- **IUserOffHook** - A hook to unsubscribe from the event.
```

--------------------------------

### Register Slash Command

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Registers a custom command in the Logseq slash command list. The action can be a callback function or an array of predefined commands.

```typescript
logseq.Editor.registerSlashCommand("Say Hi", () => {  
  console.log('Hi!')  
})
```

```typescript
logseq.Editor.registerSlashCommand("💥 Big Bang", [  
  ["editor/hook", "customCallback"],  
  ["editor/clear-current-slash"],
]);
```

--------------------------------

### Define Optional OriginalName Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

The original name of the page before any transformations.

```typescript
originalName?: string
```

--------------------------------

### newBlockUUID

Source: https://logseq.github.io/plugins/interfaces/IEditorProxy.html

Generates a unique UUID for a new block.

```APIDOC
## newBlockUUID

### Description
Creates a unique UUID string which can then be assigned to a block.

### Signature
`newBlockUUID() => Promise<string>`
```

--------------------------------

### Access Indexable Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

The interface supports arbitrary string keys.

```typescript
[key: string]: unknown
```

--------------------------------

### Define Optional Children Property

Source: https://logseq.github.io/plugins/interfaces/PageEntity.html

Represents nested page entities.

```typescript
children?: PageEntity[]
```
Tokens:
Raw