appendBlockInPage
appendBlockInPage: ( page: PageIdentity, content: string, opts?: Partial<{ properties: {} }>,) => Promise<BlockEntity> checkEditing
checkEditing: () => Promise<string | boolean>
clearSelectedBlocks
clearSelectedBlocks: () => Promise<void>
createJournalPage
createJournalPage: (date: string | Date) => Promise<PageEntity> createPage
createPage: ( pageName: string, properties?: {}, opts?: Partial< { createFirstBlock: boolean; customUUID: string; format: BlockEntity["format"]; journal: boolean; redirect: boolean; }, >,) => Promise<PageEntity> createTag
createTag: ( tagName: string, opts?: Partial<{ uuid: string }>,) => Promise<PageEntity> deletePage
deletePage: (pageName: string) => Promise<void>
editBlock
editBlock: (srcBlock: BlockIdentity, opts?: { pos: number }) => Promise<void> exitEditingMode
exitEditingMode: (selectBlock?: boolean) => Promise<void>
getAllPages
getAllPages: (repo?: string) => Promise<PageEntity[]> getBlockProperties
getBlockProperties: ( block: number | BlockIdentity,) => Promise<Record<string, any>> getEditingBlockContent
getEditingBlockContent: () => Promise<string>
getPage
getPage: ( srcPage: number | PageIdentity, opts?: Partial<{ includeChildren: boolean }>,) => Promise<PageEntity> getPageProperties
getPageProperties: (page: number | PageIdentity) => Promise<Record<string, any>> getPagesFromNamespace
getPagesFromNamespace: (namespace: string) => Promise<PageEntity[]> getPagesTreeFromNamespace
getPagesTreeFromNamespace: (namespace: string) => Promise<PageEntity[]> getTag
getTag: (nameOrIdent: string | number) => Promise<PageEntity> getTagObjects
getTagObjects: (nameOrIdent: string) => Promise<BlockEntity[]> insertAtEditingCursor
insertAtEditingCursor: (content: string) => Promise<void>
insertBlock
insertBlock: ( srcBlock: number | BlockIdentity, content: string, opts?: Partial< { before: boolean; customUUID: string; end: boolean; properties: {}; sibling: boolean; start: boolean; }, >,) => Promise<BlockEntity> moveBlock
moveBlock: ( srcBlock: BlockIdentity, targetBlock: BlockIdentity, opts?: Partial<{ before: boolean; children: boolean }>,) => Promise<void> newBlockUUID
newBlockUUID: () => Promise<string>
onInputSelectionEnd: IUserHook< { caret: any; end: number; point: { x: number; y: number }; start: number; text: string; },> openInRightSidebar: (id: string | number) => void
openPDFViewer
openPDFViewer: (assetBlockIdOrFileUrl: string | number) => Promise<void>
prependBlockInPage
prependBlockInPage: ( page: PageIdentity, content: string, opts?: Partial<{ properties: {} }>,) => Promise<BlockEntity> registerHighlightContextMenuItem: ( label: string, action: SimpleCommandCallback, opts?: { clearSelection: boolean },) => unknown Type Declaration
- (
label: string,
action: SimpleCommandCallback,
opts?: { clearSelection: boolean },
): unknown Returns unknown
removeBlockProperty
removeBlockProperty: ( block: number | BlockIdentity, key: string,) => Promise<void> removeProperty
removeProperty: (key: string) => Promise<void>
renamePage
renamePage: (oldName: string, newName: string) => Promise<void>
restoreEditingCursor
restoreEditingCursor: () => Promise<void>
saveFocusedCodeEditorContent
saveFocusedCodeEditorContent: () => Promise<void>
scrollToBlockInPage
scrollToBlockInPage: ( pageName: string, blockId: BlockIdentity, opts?: { replaceState: boolean },) => void setBlockCollapsed
setBlockCollapsed: ( srcBlock: number | BlockIdentity, opts: boolean | "toggle" | { flag: boolean | "toggle" },) => Promise<void> setBlockIcon
setBlockIcon: ( blockId: BlockIdentity, iconType: "tabler-icon" | "emoji", iconName: string,) => Promise<void> updateBlock
updateBlock: ( srcBlock: number | BlockIdentity, content: string, opts?: Partial<{ properties: {} }>,) => Promise<void> upsertBlockProperty
upsertBlockProperty: ( block: number | BlockIdentity, key: string, value: any,) => Promise<void> upsertProperty
upsertProperty: ( key: string, schema?: Partial< { cardinality: "many" | "one"; hide: boolean; public: boolean; type: | "default" | "number" | "node" | "date" | "checkbox" | "url" | string; }, >, opts?: { name?: string },) => Promise<IEntityID>
Editor related APIs