Options
All
  • Public
  • Public/Protected
  • All
Menu

@logseq/libs

Index

Type aliases

BlockCommandCallback: (e: IHookEvent & { uuid: BlockUUID }) => Promise<void>

Type declaration

BlockCursorPosition: { height: number; left: number; pos: number; rect: DOMRect; top: number }

Type declaration

  • height: number
  • left: number
  • pos: number
  • rect: DOMRect
  • top: number
BlockIdentity: BlockUUID | Pick<BlockEntity, "uuid">
BlockPageName: string
BlockUUID: string
BlockUUIDTuple: ["uuid", BlockUUID]
EntityID: number
ExternalCommandType: "logseq.command/run" | "logseq.editor/cycle-todo" | "logseq.editor/down" | "logseq.editor/up" | "logseq.editor/expand-block-children" | "logseq.editor/collapse-block-children" | "logseq.editor/open-file-in-default-app" | "logseq.editor/open-file-in-directory" | "logseq.editor/select-all-blocks" | "logseq.editor/toggle-open-blocks" | "logseq.editor/zoom-in" | "logseq.editor/zoom-out" | "logseq.editor/indent" | "logseq.editor/outdent" | "logseq.editor/copy" | "logseq.editor/cut" | "logseq.go/home" | "logseq.go/journals" | "logseq.go/keyboard-shortcuts" | "logseq.go/next-journal" | "logseq.go/prev-journal" | "logseq.go/search" | "logseq.go/search-in-page" | "logseq.go/tomorrow" | "logseq.go/backward" | "logseq.go/forward" | "logseq.search/re-index" | "logseq.sidebar/clear" | "logseq.sidebar/open-today-page" | "logseq.ui/goto-plugins" | "logseq.ui/select-theme-color" | "logseq.ui/toggle-brackets" | "logseq.ui/toggle-cards" | "logseq.ui/toggle-contents" | "logseq.ui/toggle-document-mode" | "logseq.ui/toggle-help" | "logseq.ui/toggle-left-sidebar" | "logseq.ui/toggle-right-sidebar" | "logseq.ui/toggle-settings" | "logseq.ui/toggle-theme" | "logseq.ui/toggle-wide-mode" | "logseq.command-palette/toggle"
IBatchBlock: { children?: IBatchBlock[]; content: string; properties?: Record<string, any> }

Type declaration

  • Optional children?: IBatchBlock[]
  • content: string
  • Optional properties?: Record<string, any>
IDatom: [e: number, a: string, v: any, t: number, added: boolean]
IEntityID: { id: EntityID }

Type declaration

IGitResult: { exitCode: number; stderr: string; stdout: string }

Type declaration

  • exitCode: number
  • stderr: string
  • stdout: string
IHookEvent: {}

Type declaration

  • [key: string]: any
IUserHook<E, R>: (callback: (e: IHookEvent & E) => void) => IUserOffHook

Type parameters

Type declaration

IUserOffHook: () => void

Type declaration

    • (): void
    • Returns void

IUserSlotHook<E>: (callback: (e: IHookEvent & UISlotIdentity & E) => void) => void

Type parameters

  • E = any

Type declaration

LSPluginUserEvents: "ui:visible:changed" | "settings:changed"
PluginLocalIdentity: string
SettingSchemaDesc: { default: string | number | boolean | any[] | object | null; description: string; enumChoices?: string[]; enumPicker?: "select" | "radio" | "checkbox"; inputAs?: "color" | "date" | "datetime-local" | "range"; key: string; title: string; type: "string" | "number" | "boolean" | "enum" | "object" }

Type declaration

  • default: string | number | boolean | any[] | object | null
  • description: string
  • Optional enumChoices?: string[]
  • Optional enumPicker?: "select" | "radio" | "checkbox"
  • Optional inputAs?: "color" | "date" | "datetime-local" | "range"
  • key: string
  • title: string
  • type: "string" | "number" | "boolean" | "enum" | "object"
SimpleCommandCallback: (e: IHookEvent) => void

Type declaration

SimpleCommandKeybinding: { binding: string; mac?: string; mode?: "global" | "non-editing" | "editing" }

Type declaration

  • binding: string
  • Optional mac?: string
  • Optional mode?: "global" | "non-editing" | "editing"
SlashCommandAction: [cmd: SlashCommandActionCmd, args: any]
SlashCommandActionCmd: "editor/input" | "editor/hook" | "editor/clear-current-slash" | "editor/restore-saved-cursor"
StyleOptions: { key?: string; style: StyleString }

Type declaration

StyleString: string
ThemeMode: "light" | "dark"
UIBaseOptions: { attrs?: Record<string, string>; close?: "outside" | string; key?: string; replace?: boolean; reset?: boolean; style?: CSS.Properties; template: string | null }

Type declaration

  • Optional attrs?: Record<string, string>
  • Optional close?: "outside" | string
  • Optional key?: string
  • Optional replace?: boolean
  • Optional reset?: boolean
  • Optional style?: CSS.Properties
  • template: string | null
UIContainerAttrs: { draggable: boolean; resizable: boolean }

Type declaration

  • [key: string]: any
  • draggable: boolean
  • resizable: boolean
UIMsgKey: UIMsgOptions["key"]
UIMsgOptions: { key: string; timeout: number }

UI related APIs

Type declaration

  • key: string
  • timeout: number
UIPathIdentity: { path: string }

Type declaration

  • path: string

    DOM selector

UIPathOptions: UIBaseOptions & UIPathIdentity
UISlotIdentity: { slot: string }

Type declaration

  • slot: string

    Slot key

UISlotOptions: UIBaseOptions & UISlotIdentity
UserProxyTags: "app" | "editor" | "db" | "git" | "ui" | "assets"

Functions

Generated using TypeDoc