ClientPluginAPI
Interface: ClientPluginAPI
Section titled “Interface: ClientPluginAPI”Defined in: client.d.ts:4
Properties
Section titled “Properties”api:
object
Defined in: client.d.ts:29
fetch()
Section titled “fetch()”fetch(
path,options?):Promise<Response>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”RequestInit
Returns
Section titled “Returns”Promise<Response>
commands
Section titled “commands”commands:
object
Defined in: client.d.ts:20
register()
Section titled “register()”register(
command):void
Parameters
Section titled “Parameters”command
Section titled “command”execute
Section titled “execute”() => void
string
string
shortcut?
Section titled “shortcut?”string
Returns
Section titled “Returns”void
context
Section titled “context”context:
object
Defined in: client.d.ts:23
useCurrentNote()
Section titled “useCurrentNote()”useCurrentNote(): {
content:string;path:string; } |null
Returns
Section titled “Returns”{ content: string; path: string; } | null
useCurrentUser()
Section titled “useCurrentUser()”useCurrentUser(): {
string;id:string;name:string; } |null
Returns
Section titled “Returns”{ email: string; id: string; name: string; } | null
usePluginSettings()
Section titled “usePluginSettings()”usePluginSettings(
key):unknown
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”unknown
useTheme()
Section titled “useTheme()”useTheme():
"light"|"dark"
Returns
Section titled “Returns”"light" | "dark"
editor
Section titled “editor”editor:
object
Defined in: client.d.ts:13
registerExtension()
Section titled “registerExtension()”registerExtension(
extension):void
Parameters
Section titled “Parameters”extension
Section titled “extension”any
Returns
Section titled “Returns”void
markdown
Section titled “markdown”markdown:
object
Defined in: client.d.ts:16
registerCodeFenceRenderer()
Section titled “registerCodeFenceRenderer()”registerCodeFenceRenderer(
language,component):void
Parameters
Section titled “Parameters”language
Section titled “language”string
component
Section titled “component”any
Returns
Section titled “Returns”void
registerPostProcessor()
Section titled “registerPostProcessor()”registerPostProcessor(
fn):void
Parameters
Section titled “Parameters”(html) => string
Returns
Section titled “Returns”void
notify
Section titled “notify”notify:
object
Defined in: client.d.ts:32
error()
Section titled “error()”error(
message):void
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
info()
Section titled “info()”info(
message):void
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
success()
Section titled “success()”success(
message):void
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
ui:
object
Defined in: client.d.ts:5
registerEditorToolbarButton()
Section titled “registerEditorToolbarButton()”registerEditorToolbarButton(
component,options):void
Parameters
Section titled “Parameters”component
Section titled “component”any
options
Section titled “options”string
order?
Section titled “order?”number
Returns
Section titled “Returns”void
registerNoteAction()
Section titled “registerNoteAction()”registerNoteAction(
options):void
Parameters
Section titled “Parameters”options
Section titled “options”string
string
string
onClick
Section titled “onClick”(notePath) => void
Returns
Section titled “Returns”void
registerPage()
Section titled “registerPage()”registerPage(
component,options):void
Parameters
Section titled “Parameters”component
Section titled “component”any
options
Section titled “options”string
string
string
showInSidebar?
Section titled “showInSidebar?”boolean
string
Returns
Section titled “Returns”void
registerSettingsSection()
Section titled “registerSettingsSection()”registerSettingsSection(
component,options):void
Parameters
Section titled “Parameters”component
Section titled “component”any
options
Section titled “options”string
string
Returns
Section titled “Returns”void
registerSidebarPanel()
Section titled “registerSidebarPanel()”registerSidebarPanel(
component,options):void
Parameters
Section titled “Parameters”component
Section titled “component”any
options
Section titled “options”string
string
order?
Section titled “order?”number
string
Returns
Section titled “Returns”void
registerStatusBarItem()
Section titled “registerStatusBarItem()”registerStatusBarItem(
component,options):void
Parameters
Section titled “Parameters”component
Section titled “component”any
options
Section titled “options”string
order?
Section titled “order?”number
position
Section titled “position”"left" | "right"
Returns
Section titled “Returns”void