Interface Instance

interface Instance {
    $: ComponentInternalInstance;
    $attrs: Data;
    $data: {};
    $el: any;
    $emit: ((event: string, ...args: any[]) => void);
    $forceUpdate: (() => void);
    $nextTick: (<T, R>(this: T, fn?: ((this: T) => R)) => Promise<Awaited<R>>);
    $options: ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}> & MergedComponentOptionsOverride;
    $parent: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
    $props: {};
    $refs: Data;
    $root: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
    $slots: Readonly<InternalSlots>;
    $t: ((path:
        | "close"
        | "default"
        | "app-name"
        | "about"
        | "feedback"
        | "slogan"
        | "cancel"
        | "undo"
        | "ok"
        | "demo-tips"
        | "more"
        | "copied"
        | "others"
        | "insert-different-repo-doc"
        | "need-clipboard-permission"
        | "click-to-copy"
        | "click-to-copy-link"
        | "copy-code"
        | "loading"
        | "add-image"
        | "upload-image"
        | "exit-presentation-msg"
        | "reload"
        | "open-in-new-window"
        | "view-figure"
        | "export"
        | "no-password"
        | "save"
        | "discard"
        | "edit"
        | "outline"
        | "files"
        | "install-extension-tips"
        | "not-support-mas"
        | "learn-more"
        | "print"
        | "markdown-file"
        | "encrypted-markdown-file"
        | "switch-repo-n"
        | "switch-the-last-repo"
        | "edit-or-generate-text-using-ai"
        | "file-readonly-desc"
        | "can-not-edit-this-file-type"
        | "read-only-mode-desc"
        | "premium.premium"
        | "premium.confetti"
        | "premium.need-purchase"
        | "premium.buy-license"
        | "premium.free"
        | "premium.upgrade"
        | "premium.intro.intro"
        | "premium.intro.current-plan"
        | "premium.intro.included"
        | "premium.intro.desc"
        | "premium.intro.free-desc"
        | "premium.intro.premium-desc"
        | "premium.intro.free-list"
        | "premium.intro.premium-list"
        | "premium.buy.buy"
        | "premium.activation.activation"
        | "premium.activation.license"
        | "premium.activation.placeholder"
        | "premium.activation.get-license"
        | "premium.activation.info"
        | "premium.activation.expired"
        | "premium.activation.expiring"
        | "premium.activation.need-refresh"
        | "premium.activation.refresh"
        | "premium.activation.renewal"
        | "premium.activation.devices"
        | "premium.activation.this-machine"
        | "premium.activation.unbind"
        | "premium.activation.unbind-confirm"
        | "premium.activation.name"
        | "premium.activation.email"
        | "premium.activation.expires"
        | "premium.activation.plan"
        | "premium.activation.success"
        | "premium.activation.activating"
        | "premium.activation.tips"
        | "premium.activation.tips-wechat"
        | "premium.activation.activation-tips"
        | "premium.activation.offline-activation"
        | "premium.activation.online-activation"
        | "premium.activation.get-activation-token"
        | "app.error.EADDRINUSE"
        | "app.quit"
        | "app.preferences"
        | "app.close-window"
        | "app.toggle-fullscreen"
        | "app.hide-main-window"
        | "app.tray.quit"
        | "app.tray.preferences"
        | "app.tray.open-main-window"
        | "app.tray.open-in-browser"
        | "app.tray.open-main-dir"
        | "app.tray.start-at-login"
        | "app.tray.version"
        | "app.tray.dev.reload"
        | "app.tray.dev.dev"
        | "app.tray.dev.port-prod"
        | "app.tray.dev.port-dev"
        | "app.tray.dev.dev-tool"
        | "app.tray.dev.restart"
        | "app.tray.dev.force-quit"
        | "app.updater.found-dialog.desc"
        | "app.updater.found-dialog.title"
        | "app.updater.found-dialog.buttons.cancel"
        | "app.updater.found-dialog.buttons.download"
        | "app.updater.found-dialog.buttons.view-changes"
        | "app.updater.found-dialog.buttons.download-and-view-changes"
        | "app.updater.found-dialog.buttons.ignore"
        | "app.updater.progress-bar.title"
        | "app.updater.progress-bar.detail"
        | "app.updater.progress-bar.failed"
        | "app.updater.failed-dialog.title"
        | "app.updater.install-dialog.desc"
        | "app.updater.install-dialog.title"
        | "app.updater.install-dialog.buttons.install"
        | "app.updater.install-dialog.buttons.delay"
        | "app.updater.no-newer-dialog.desc"
        | "app.updater.no-newer-dialog.title"
        | "quit-check-dialog.desc"
        | "quit-check-dialog.title"
        | "quit-check-dialog.buttons.cancel"
        | "quit-check-dialog.buttons.discard"
        | "save-check-dialog.desc"
        | "save-check-dialog.title"
        | "change-setting-reload-main-widow-dialog.desc"
        | "change-setting-reload-main-widow-dialog.title"
        | "file-status.loading"
        | "file-status.unsaved"
        | "file-status.saving"
        | "file-status.saved"
        | "file-status.save-failed"
        | "file-status.loaded"
        | "file-status.no-file"
        | "modal.info"
        | "modal.input-placeholder"
        | "document.current-path"
        | "document.invalid-filename"
        | "document.password-create"
        | "document.password-save"
        | "document.password-open"
        | "document.wrong-password"
        | "document.file-transform-error"
        | "document.custom-extension"
        | "document.create-dialog.title"
        | "document.create-dialog.hint"
        | "document.create-dir-dialog.title"
        | "document.create-dir-dialog.hint"
        | "document.duplicate-dialog.title"
        | "document.duplicate-dialog.hint"
        | "document.delete-dialog.title"
        | "document.delete-dialog.content"
        | "document.move-dialog.title"
        | "document.move-dialog.content"
        | "document.save-encrypted-file-dialog.title"
        | "document.save-encrypted-file-dialog.content"
        | "document.switch-noent-dialog.title"
        | "document.switch-noent-dialog.content"
        | "status-bar.view.view"
        | "status-bar.view.editor"
        | "status-bar.view.xterm"
        | "status-bar.view.preview"
        | "status-bar.view.side-bar"
        | "status-bar.view.word-wrap"
        | "status-bar.view.typewriter-mode"
        | "status-bar.view.editor-preview-exclusive"
        | "status-bar.extension.extension-manager"
        | "status-bar.setting"
        | "status-bar.repo.repo"
        | "status-bar.repo.no-data"
        | "status-bar.nav.nav"
        | "status-bar.nav.goto"
        | "status-bar.nav.reveal-current-file-in-sidebar"
        | "status-bar.nav.forward"
        | "status-bar.nav.back"
        | "status-bar.insert.insert"
        | "status-bar.insert.paste-rt"
        | "status-bar.insert.paste-img-base64"
        | "status-bar.tool.export"
        | "status-bar.tool.print"
        | "status-bar.tool.doc-history"
        | "status-bar.tool.copy-content"
        | "status-bar.tool.share-preview"
        | "status-bar.tool.tool"
        | "status-bar.tool.convert-img-link"
        | "status-bar.tool.macro-copy-markdown"
        | "status-bar.document-info.selected"
        | "status-bar.document-info.lines"
        | "status-bar.document-info.chars"
        | "status-bar.document-info.selections"
        | "status-bar.help.help"
        | "status-bar.help.readme"
        | "status-bar.help.features"
        | "status-bar.help.shortcuts"
        | "status-bar.help.guide"
        | "status-bar.help.plugin"
        | "status-bar.terminal"
        | "status-bar.present"
        | "status-bar.get.get-application"
        | "status-bar.theme.tips"
        | "status-bar.theme.dark"
        | "status-bar.theme.light"
        | "status-bar.theme.system"
        | "view.outline"
        | "view.print"
        | "tree.sort.desc"
        | "tree.sort.asc"
        | "tree.sort.by-name"
        | "tree.sort.by-mtime"
        | "tree.sort.by-birthtime"
        | "tree.sort.by-serial"
        | "tree.db-click-refresh"
        | "tree.add-repo"
        | "tree.add-repo-hint"
        | "tree.created-at"
        | "tree.updated-at"
        | "tree.context-menu.refresh"
        | "tree.context-menu.mark"
        | "tree.context-menu.unmark"
        | "tree.context-menu.duplicate"
        | "tree.context-menu.create-doc"
        | "tree.context-menu.create-dir"
        | "tree.context-menu.add-item"
        | "tree.context-menu.rename"
        | "tree.context-menu.delete"
        | "tree.context-menu.open-in-os"
        | "tree.context-menu.reveal-in-os"
        | "tree.context-menu.open-in-terminal"
        | "tree.context-menu.create-in-cd"
        | "tree.context-menu.copy-name"
        | "tree.context-menu.copy-path"
        | "tree.context-menu.find-in-folder"
        | "tree.toast.copied"
        | "tree.toast.moved"
        | "tabs.close-others"
        | "tabs.close-right"
        | "tabs.close-left"
        | "tabs.close-all"
        | "tabs.pin"
        | "tabs.unpin"
        | "tabs.search-tabs"
        | "tabs.new-tab"
        | "export-panel.loading"
        | "export-panel.export"
        | "export-panel.format"
        | "export-panel.pdf.orientation"
        | "export-panel.pdf.portrait"
        | "export-panel.pdf.landscape"
        | "export-panel.pdf.size"
        | "export-panel.pdf.zoom"
        | "export-panel.pdf.use-browser"
        | "export-panel.pdf.include-bg"
        | "export-panel.use-html"
        | "export-panel.use-markdown"
        | "title-bar.pin"
        | "title-bar.minimize"
        | "title-bar.unmaximize"
        | "title-bar.maximize"
        | "setting-panel.tabs.editor"
        | "setting-panel.tabs.repos"
        | "setting-panel.tabs.appearance"
        | "setting-panel.tabs.render"
        | "setting-panel.tabs.image"
        | "setting-panel.tabs.proxy"
        | "setting-panel.tabs.macros"
        | "setting-panel.tabs.other"
        | "setting-panel.setting"
        | "setting-panel.add"
        | "setting-panel.delete-warning"
        | "setting-panel.error-choose-repo-path"
        | "setting-panel.change-keyboard-shortcuts"
        | "setting-panel.schema.search.number-limit"
        | "setting-panel.schema.assets.path-type"
        | "setting-panel.schema.view.default-previewer-max-width"
        | "setting-panel.schema.view.default-previewer-max-width-desc"
        | "setting-panel.schema.tree.exclude"
        | "setting-panel.schema.editor.mouse-wheel-zoom"
        | "setting-panel.schema.editor.font-size"
        | "setting-panel.schema.editor.tab-size"
        | "setting-panel.schema.editor.ordered-list-completion"
        | "setting-panel.schema.editor.minimap"
        | "setting-panel.schema.editor.line-numbers"
        | "setting-panel.schema.editor.enable-preview"
        | "setting-panel.schema.editor.font-family"
        | "setting-panel.schema.editor.font-ligatures"
        | "setting-panel.schema.editor.complete-emoji"
        | "setting-panel.schema.editor.todo-with-time"
        | "setting-panel.schema.editor.suggest-on-trigger-characters"
        | "setting-panel.schema.editor.sticky-scroll-enabled"
        | "setting-panel.schema.editor.quick-suggestions"
        | "setting-panel.schema.editor.enable-ai-copilot-action"
        | "setting-panel.schema.custom-css"
        | "setting-panel.schema.doc-history.number-limit"
        | "setting-panel.schema.updater.source"
        | "setting-panel.schema.theme"
        | "setting-panel.schema.repos.name"
        | "setting-panel.schema.repos.repo"
        | "setting-panel.schema.repos.repos"
        | "setting-panel.schema.repos.name-placeholder"
        | "setting-panel.schema.repos.path"
        | "setting-panel.schema.repos.path-placeholder"
        | "setting-panel.schema.render.md-html"
        | "setting-panel.schema.render.md-breaks"
        | "setting-panel.schema.render.md-linkify"
        | "setting-panel.schema.render.md-wiki-links"
        | "setting-panel.schema.render.md-typographer"
        | "setting-panel.schema.render.md-sup"
        | "setting-panel.schema.render.md-sub"
        | "setting-panel.schema.render.md-emoji"
        | "setting-panel.schema.render.multimd-multiline"
        | "setting-panel.schema.render.multimd-rowspan"
        | "setting-panel.schema.render.multimd-headerless"
        | "setting-panel.schema.render.multimd-multibody"
        | "setting-panel.schema.proxy.server"
        | "setting-panel.schema.proxy.enabled"
        | "setting-panel.schema.proxy.server-hint"
        | "setting-panel.schema.proxy.bypass-list"
        | "setting-panel.schema.proxy.pac-url"
        | "setting-panel.schema.macros.match"
        | "setting-panel.schema.macros.replace"
        | "setting-panel.schema.macros.macros"
        | "setting-panel.schema.macros.match-placeholder"
        | "setting-panel.schema.macros.replace-placeholder"
        | "setting-panel.schema.language"
        | "setting-panel.schema.assets-dir"
        | "setting-panel.schema.assets-desc"
        | "setting-panel.schema.shell"
        | "setting-panel.schema.envs"
        | "setting-panel.schema.auto-save"
        | "setting-panel.schema.plantuml-api"
        | "setting-panel.schema.server.host"
        | "setting-panel.schema.server.port"
        | "setting-panel.schema.server.port-desc"
        | "setting-panel.schema.hide-main-window-on-startup"
        | "setting-panel.schema.keep-running-after-closing-window"
        | "quick-open.files"
        | "quick-open.input-placeholder"
        | "quick-open.empty"
        | "quick-open.marked"
        | "editor.context-menu.paste-image"
        | "editor.context-menu.paste-image-as-base64"
        | "editor.context-menu.paste-rt-as-markdown"
        | "editor.context-menu.add-attachment"
        | "editor.context-menu.link-doc"
        | "editor.context-menu.link-file"
        | "editor.context-menu.insert-date"
        | "editor.context-menu.insert-time"
        | "editor.context-menu.reveal-line-in-preview"
        | "editor.context-menu.force-insert-new-line"
        | "editor.context-menu.force-insert-indent"
        | "editor.switch-editor"
        | "editor.default-editor"
        | "editor.action-label.reveal-current-file-in-os"
        | "editor.action-label.refresh-current-document"
        | "previewer.default-previewer"
        | "previewer.switch-previewer"
        | "picgo.setting.api-title"
        | "picgo.setting.api-desc"
        | "picgo.setting.api-msg"
        | "picgo.setting.paste-title"
        | "picgo.uploading"
        | "picgo.upload-failed"
        | "picgo.need-api"
        | "picgo.upload-all-images"
        | "code-run.run"
        | "code-run.stop"
        | "code-run.run-in-xterm-tips"
        | "code-run.run-in-xterm"
        | "code-run.running"
        | "code-run.clear"
        | "mind-map.zoom-in"
        | "mind-map.zoom-out"
        | "mind-map.fit-height"
        | "mind-map.switch-layout"
        | "mind-map.switch-loose"
        | "mind-map.convert-error"
        | "table-cell-edit.context-menu.edit"
        | "table-cell-edit.context-menu.quick-edit"
        | "table-cell-edit.context-menu.sort-mode"
        | "table-cell-edit.context-menu.sort-asc"
        | "table-cell-edit.context-menu.sort-desc"
        | "table-cell-edit.context-menu.align-left"
        | "table-cell-edit.context-menu.align-center"
        | "table-cell-edit.context-menu.align-right"
        | "table-cell-edit.context-menu.align-normal"
        | "table-cell-edit.context-menu.add-row-above"
        | "table-cell-edit.context-menu.add-row-below"
        | "table-cell-edit.context-menu.delete-row"
        | "table-cell-edit.context-menu.add-col-left"
        | "table-cell-edit.context-menu.add-col-right"
        | "table-cell-edit.context-menu.delete-col"
        | "table-cell-edit.esc-to-cancel"
        | "table-cell-edit.db-click-edit"
        | "table-cell-edit.canceled"
        | "table-cell-edit.edit-hint"
        | "table-cell-edit.edit-title"
        | "table-cell-edit.edit-error"
        | "table-cell-edit.limit-single-line"
        | "markdown-link.convert-to-titled-link"
        | "custom-css.change-confirm.title"
        | "custom-css.change-confirm.content"
        | "control-center.control-center"
        | "control-center.switch.view"
        | "control-center.switch.editor"
        | "control-center.switch.find-in-preview"
        | "control-center.switch.side-bar"
        | "control-center.switch.word-wrap"
        | "control-center.switch.typewriter-mode"
        | "control-center.switch.sync-scroll"
        | "control-center.switch.sync-rendering"
        | "control-center.navigation.refresh"
        | "control-center.navigation.goto"
        | "control-center.navigation.forward"
        | "control-center.navigation.back"
        | "doc-history.delete-dialog.title"
        | "doc-history.delete-dialog.content"
        | "doc-history.content"
        | "doc-history.mark"
        | "doc-history.unmark"
        | "doc-history.delete"
        | "doc-history.marked"
        | "doc-history.clear"
        | "doc-history.apply-version"
        | "doc-history.no-history"
        | "doc-history.diff"
        | "doc-history.history"
        | "doc-history.current"
        | "doc-history.all"
        | "doc-history.edit-message"
        | "doc-history.clear-dialog.title"
        | "doc-history.clear-dialog.content"
        | "doc-history.mark-dialog.title"
        | "doc-history.mark-dialog.hint"
        | "doc-history.content-too-long-alert.title"
        | "doc-history.content-too-long-alert.content"
        | "copy-content.upload-image"
        | "copy-content.options"
        | "copy-content.type"
        | "copy-content.inline-style"
        | "copy-content.include-style"
        | "copy-content.inline-image"
        | "copy-content.highlight-code"
        | "copy-content.rt"
        | "copy-content.complete"
        | "copy-content.copy-tips"
        | "copy-content.copy-tips-selected"
        | "share-preview.tips"
        | "share-preview.expire"
        | "electron-zoom.zoom-in"
        | "electron-zoom.zoom-out"
        | "electron-zoom.zoom-reset"
        | "extension.reload"
        | "extension.upgrade"
        | "extension.download"
        | "extension.install"
        | "extension.extension-manager"
        | "extension.enabled"
        | "extension.all"
        | "extension.installed"
        | "extension.official"
        | "extension.unofficial"
        | "extension.unknown"
        | "extension.author"
        | "extension.origin"
        | "extension.unpacked-size"
        | "extension.latest-version"
        | "extension.installed-version"
        | "extension.homepage"
        | "extension.toast-loaded"
        | "extension.upgradable"
        | "extension.incompatible"
        | "extension.not-installed"
        | "extension.disabled"
        | "extension.reload-required"
        | "extension.no-extension"
        | "extension.uninstall"
        | "extension.installing"
        | "extension.uninstalling"
        | "extension.disable"
        | "extension.enable"
        | "extension.uninstall-confirm"
        | "extension.registry"
        | "extension.activation-time"
        | "extension.requirement"
        | "extension.auto-upgrade"
        | "extension.unknown-origin-tips"
        | "extension.extensions-auto-upgraded"
        | "extension.fetch-registry-failed"
        | "get-started.get-started"
        | "get-started.help"
        | "get-started.start"
        | "get-started.recent"
        | "search-panel.search-files"
        | "search-panel.placeholder-search"
        | "search-panel.for-history"
        | "search-panel.files-to-include"
        | "search-panel.files-to-exclude"
        | "search-panel.match-case"
        | "search-panel.match-whole-word"
        | "search-panel.use-regex"
        | "search-panel.expand-all"
        | "search-panel.collapse-all"
        | "file-changed-alert.reload"
        | "file-changed-alert.title"
        | "file-changed-alert.content"
        | "command-desc.base_find-in-repository"
        | "command-desc.control-center_toggle"
        | "command-desc.doc_show-history"
        | "command-desc.editor_toggle-wrap"
        | "command-desc.file-tabs_close-current"
        | "command-desc.file-tabs_search-tabs"
        | "command-desc.file-tabs_show-welcome"
        | "command-desc.file-tabs_switch-left"
        | "command-desc.file-tabs_switch-right"
        | "command-desc.layout_toggle-editor"
        | "command-desc.layout_toggle-side"
        | "command-desc.layout_toggle-view"
        | "command-desc.layout_toggle-xterm"
        | "command-desc.plugin_copy-content_copy-content"
        | "command-desc.plugin_document-history-stack_back"
        | "command-desc.plugin_document-history-stack_forward"
        | "command-desc.plugin_editor_focus-editor"
        | "command-desc.plugin_switch-todo_switch"
        | "command-desc.view_enter-presentation"
        | "command-desc.workbench_show-quick-open"
        | "command-desc.workbench_toggle-outline"
        | "command-desc.plugin_electron-zoom_zoom-in"
        | "command-desc.plugin_electron-zoom_zoom-out"
        | "command-desc.plugin_electron-zoom_zoom-reset"
        | "command-desc.view_refresh"
        | "command-desc.extension_show-manager"
        | "command-desc.keyboard-shortcuts_show-manager"
        | "command-desc.plugin_image-localization_all"
        | "command-desc.tree_refresh"
        | "command-desc.plugin_status-bar-theme_switch"
        | "command-desc.editor_rotate-custom-editors"
        | "command-desc.view_show-find-in-preview-widget"
        | "command-desc.tree_reveal-current-node"
        | "keyboard-shortcuts.search"
        | "keyboard-shortcuts.editor"
        | "keyboard-shortcuts.keyboard-shortcuts"
        | "keyboard-shortcuts.empty"
        | "keyboard-shortcuts.clear"
        | "keyboard-shortcuts.workbench"
        | "keyboard-shortcuts.application"
        | "keyboard-shortcuts.unavailable"
        | "keyboard-shortcuts.command"
        | "keyboard-shortcuts.keybinding"
        | "keyboard-shortcuts.not-set"
        | "keyboard-shortcuts.change"
        | "keyboard-shortcuts.reset"
        | "keyboard-shortcuts.recorder.conflict-commands"
        | "keyboard-shortcuts.recorder.tip"
        | "keyboard-shortcuts.conflict"
        | "keyboard-shortcuts.conflict-title"
        | "keyboard-shortcuts.conflict-commands"
        | "find-in-preview.action-tips.close"
        | "find-in-preview.action-tips.prev"
        | "find-in-preview.action-tips.next"
        | "find-in-preview.results"
        | "find-in-preview.toast-no-more"
        | "view-context-menu.copy-image"
        | "view-context-menu.delete-image"
        | "view-context-menu.open-in-new-tab", ...args: string[]) => string);
    hide: (() => void);
    show: ((menuItems: Components.ContextMenu.Item[], opts?: ShowOpts) => void);
    $watch<T>(source: T, cb: T extends ((...args: any) => R)
        ? ((...args: [R, R, OnCleanup]) => any)
        : ((...args: [any, any, OnCleanup]) => any), options?: WatchOptions<boolean>): WatchStopHandle;
}

Hierarchy (view full)

Properties

$ $attrs $data $el $emit $forceUpdate $nextTick $options $parent $props $refs $root $slots $t hide show

Methods

$watch

Properties

$

$: ComponentInternalInstance

$attrs

$attrs: Data

$data

$data: {}

$el

$el: any

$emit

$emit: ((event: string, ...args: any[]) => void)

$forceUpdate

$forceUpdate: (() => void)

$nextTick

$nextTick: (<T, R>(this: T, fn?: ((this: T) => R)) => Promise<Awaited<R>>)

$options

$options: ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}> & MergedComponentOptionsOverride

$parent

$parent: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

$props

$props: {}

$refs

$refs: Data

$root

$root: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

$slots

$slots: Readonly<InternalSlots>

$t

$t: ((path:
    | "close"
    | "default"
    | "app-name"
    | "about"
    | "feedback"
    | "slogan"
    | "cancel"
    | "undo"
    | "ok"
    | "demo-tips"
    | "more"
    | "copied"
    | "others"
    | "insert-different-repo-doc"
    | "need-clipboard-permission"
    | "click-to-copy"
    | "click-to-copy-link"
    | "copy-code"
    | "loading"
    | "add-image"
    | "upload-image"
    | "exit-presentation-msg"
    | "reload"
    | "open-in-new-window"
    | "view-figure"
    | "export"
    | "no-password"
    | "save"
    | "discard"
    | "edit"
    | "outline"
    | "files"
    | "install-extension-tips"
    | "not-support-mas"
    | "learn-more"
    | "print"
    | "markdown-file"
    | "encrypted-markdown-file"
    | "switch-repo-n"
    | "switch-the-last-repo"
    | "edit-or-generate-text-using-ai"
    | "file-readonly-desc"
    | "can-not-edit-this-file-type"
    | "read-only-mode-desc"
    | "premium.premium"
    | "premium.confetti"
    | "premium.need-purchase"
    | "premium.buy-license"
    | "premium.free"
    | "premium.upgrade"
    | "premium.intro.intro"
    | "premium.intro.current-plan"
    | "premium.intro.included"
    | "premium.intro.desc"
    | "premium.intro.free-desc"
    | "premium.intro.premium-desc"
    | "premium.intro.free-list"
    | "premium.intro.premium-list"
    | "premium.buy.buy"
    | "premium.activation.activation"
    | "premium.activation.license"
    | "premium.activation.placeholder"
    | "premium.activation.get-license"
    | "premium.activation.info"
    | "premium.activation.expired"
    | "premium.activation.expiring"
    | "premium.activation.need-refresh"
    | "premium.activation.refresh"
    | "premium.activation.renewal"
    | "premium.activation.devices"
    | "premium.activation.this-machine"
    | "premium.activation.unbind"
    | "premium.activation.unbind-confirm"
    | "premium.activation.name"
    | "premium.activation.email"
    | "premium.activation.expires"
    | "premium.activation.plan"
    | "premium.activation.success"
    | "premium.activation.activating"
    | "premium.activation.tips"
    | "premium.activation.tips-wechat"
    | "premium.activation.activation-tips"
    | "premium.activation.offline-activation"
    | "premium.activation.online-activation"
    | "premium.activation.get-activation-token"
    | "app.error.EADDRINUSE"
    | "app.quit"
    | "app.preferences"
    | "app.close-window"
    | "app.toggle-fullscreen"
    | "app.hide-main-window"
    | "app.tray.quit"
    | "app.tray.preferences"
    | "app.tray.open-main-window"
    | "app.tray.open-in-browser"
    | "app.tray.open-main-dir"
    | "app.tray.start-at-login"
    | "app.tray.version"
    | "app.tray.dev.reload"
    | "app.tray.dev.dev"
    | "app.tray.dev.port-prod"
    | "app.tray.dev.port-dev"
    | "app.tray.dev.dev-tool"
    | "app.tray.dev.restart"
    | "app.tray.dev.force-quit"
    | "app.updater.found-dialog.desc"
    | "app.updater.found-dialog.title"
    | "app.updater.found-dialog.buttons.cancel"
    | "app.updater.found-dialog.buttons.download"
    | "app.updater.found-dialog.buttons.view-changes"
    | "app.updater.found-dialog.buttons.download-and-view-changes"
    | "app.updater.found-dialog.buttons.ignore"
    | "app.updater.progress-bar.title"
    | "app.updater.progress-bar.detail"
    | "app.updater.progress-bar.failed"
    | "app.updater.failed-dialog.title"
    | "app.updater.install-dialog.desc"
    | "app.updater.install-dialog.title"
    | "app.updater.install-dialog.buttons.install"
    | "app.updater.install-dialog.buttons.delay"
    | "app.updater.no-newer-dialog.desc"
    | "app.updater.no-newer-dialog.title"
    | "quit-check-dialog.desc"
    | "quit-check-dialog.title"
    | "quit-check-dialog.buttons.cancel"
    | "quit-check-dialog.buttons.discard"
    | "save-check-dialog.desc"
    | "save-check-dialog.title"
    | "change-setting-reload-main-widow-dialog.desc"
    | "change-setting-reload-main-widow-dialog.title"
    | "file-status.loading"
    | "file-status.unsaved"
    | "file-status.saving"
    | "file-status.saved"
    | "file-status.save-failed"
    | "file-status.loaded"
    | "file-status.no-file"
    | "modal.info"
    | "modal.input-placeholder"
    | "document.current-path"
    | "document.invalid-filename"
    | "document.password-create"
    | "document.password-save"
    | "document.password-open"
    | "document.wrong-password"
    | "document.file-transform-error"
    | "document.custom-extension"
    | "document.create-dialog.title"
    | "document.create-dialog.hint"
    | "document.create-dir-dialog.title"
    | "document.create-dir-dialog.hint"
    | "document.duplicate-dialog.title"
    | "document.duplicate-dialog.hint"
    | "document.delete-dialog.title"
    | "document.delete-dialog.content"
    | "document.move-dialog.title"
    | "document.move-dialog.content"
    | "document.save-encrypted-file-dialog.title"
    | "document.save-encrypted-file-dialog.content"
    | "document.switch-noent-dialog.title"
    | "document.switch-noent-dialog.content"
    | "status-bar.view.view"
    | "status-bar.view.editor"
    | "status-bar.view.xterm"
    | "status-bar.view.preview"
    | "status-bar.view.side-bar"
    | "status-bar.view.word-wrap"
    | "status-bar.view.typewriter-mode"
    | "status-bar.view.editor-preview-exclusive"
    | "status-bar.extension.extension-manager"
    | "status-bar.setting"
    | "status-bar.repo.repo"
    | "status-bar.repo.no-data"
    | "status-bar.nav.nav"
    | "status-bar.nav.goto"
    | "status-bar.nav.reveal-current-file-in-sidebar"
    | "status-bar.nav.forward"
    | "status-bar.nav.back"
    | "status-bar.insert.insert"
    | "status-bar.insert.paste-rt"
    | "status-bar.insert.paste-img-base64"
    | "status-bar.tool.export"
    | "status-bar.tool.print"
    | "status-bar.tool.doc-history"
    | "status-bar.tool.copy-content"
    | "status-bar.tool.share-preview"
    | "status-bar.tool.tool"
    | "status-bar.tool.convert-img-link"
    | "status-bar.tool.macro-copy-markdown"
    | "status-bar.document-info.selected"
    | "status-bar.document-info.lines"
    | "status-bar.document-info.chars"
    | "status-bar.document-info.selections"
    | "status-bar.help.help"
    | "status-bar.help.readme"
    | "status-bar.help.features"
    | "status-bar.help.shortcuts"
    | "status-bar.help.guide"
    | "status-bar.help.plugin"
    | "status-bar.terminal"
    | "status-bar.present"
    | "status-bar.get.get-application"
    | "status-bar.theme.tips"
    | "status-bar.theme.dark"
    | "status-bar.theme.light"
    | "status-bar.theme.system"
    | "view.outline"
    | "view.print"
    | "tree.sort.desc"
    | "tree.sort.asc"
    | "tree.sort.by-name"
    | "tree.sort.by-mtime"
    | "tree.sort.by-birthtime"
    | "tree.sort.by-serial"
    | "tree.db-click-refresh"
    | "tree.add-repo"
    | "tree.add-repo-hint"
    | "tree.created-at"
    | "tree.updated-at"
    | "tree.context-menu.refresh"
    | "tree.context-menu.mark"
    | "tree.context-menu.unmark"
    | "tree.context-menu.duplicate"
    | "tree.context-menu.create-doc"
    | "tree.context-menu.create-dir"
    | "tree.context-menu.add-item"
    | "tree.context-menu.rename"
    | "tree.context-menu.delete"
    | "tree.context-menu.open-in-os"
    | "tree.context-menu.reveal-in-os"
    | "tree.context-menu.open-in-terminal"
    | "tree.context-menu.create-in-cd"
    | "tree.context-menu.copy-name"
    | "tree.context-menu.copy-path"
    | "tree.context-menu.find-in-folder"
    | "tree.toast.copied"
    | "tree.toast.moved"
    | "tabs.close-others"
    | "tabs.close-right"
    | "tabs.close-left"
    | "tabs.close-all"
    | "tabs.pin"
    | "tabs.unpin"
    | "tabs.search-tabs"
    | "tabs.new-tab"
    | "export-panel.loading"
    | "export-panel.export"
    | "export-panel.format"
    | "export-panel.pdf.orientation"
    | "export-panel.pdf.portrait"
    | "export-panel.pdf.landscape"
    | "export-panel.pdf.size"
    | "export-panel.pdf.zoom"
    | "export-panel.pdf.use-browser"
    | "export-panel.pdf.include-bg"
    | "export-panel.use-html"
    | "export-panel.use-markdown"
    | "title-bar.pin"
    | "title-bar.minimize"
    | "title-bar.unmaximize"
    | "title-bar.maximize"
    | "setting-panel.tabs.editor"
    | "setting-panel.tabs.repos"
    | "setting-panel.tabs.appearance"
    | "setting-panel.tabs.render"
    | "setting-panel.tabs.image"
    | "setting-panel.tabs.proxy"
    | "setting-panel.tabs.macros"
    | "setting-panel.tabs.other"
    | "setting-panel.setting"
    | "setting-panel.add"
    | "setting-panel.delete-warning"
    | "setting-panel.error-choose-repo-path"
    | "setting-panel.change-keyboard-shortcuts"
    | "setting-panel.schema.search.number-limit"
    | "setting-panel.schema.assets.path-type"
    | "setting-panel.schema.view.default-previewer-max-width"
    | "setting-panel.schema.view.default-previewer-max-width-desc"
    | "setting-panel.schema.tree.exclude"
    | "setting-panel.schema.editor.mouse-wheel-zoom"
    | "setting-panel.schema.editor.font-size"
    | "setting-panel.schema.editor.tab-size"
    | "setting-panel.schema.editor.ordered-list-completion"
    | "setting-panel.schema.editor.minimap"
    | "setting-panel.schema.editor.line-numbers"
    | "setting-panel.schema.editor.enable-preview"
    | "setting-panel.schema.editor.font-family"
    | "setting-panel.schema.editor.font-ligatures"
    | "setting-panel.schema.editor.complete-emoji"
    | "setting-panel.schema.editor.todo-with-time"
    | "setting-panel.schema.editor.suggest-on-trigger-characters"
    | "setting-panel.schema.editor.sticky-scroll-enabled"
    | "setting-panel.schema.editor.quick-suggestions"
    | "setting-panel.schema.editor.enable-ai-copilot-action"
    | "setting-panel.schema.custom-css"
    | "setting-panel.schema.doc-history.number-limit"
    | "setting-panel.schema.updater.source"
    | "setting-panel.schema.theme"
    | "setting-panel.schema.repos.name"
    | "setting-panel.schema.repos.repo"
    | "setting-panel.schema.repos.repos"
    | "setting-panel.schema.repos.name-placeholder"
    | "setting-panel.schema.repos.path"
    | "setting-panel.schema.repos.path-placeholder"
    | "setting-panel.schema.render.md-html"
    | "setting-panel.schema.render.md-breaks"
    | "setting-panel.schema.render.md-linkify"
    | "setting-panel.schema.render.md-wiki-links"
    | "setting-panel.schema.render.md-typographer"
    | "setting-panel.schema.render.md-sup"
    | "setting-panel.schema.render.md-sub"
    | "setting-panel.schema.render.md-emoji"
    | "setting-panel.schema.render.multimd-multiline"
    | "setting-panel.schema.render.multimd-rowspan"
    | "setting-panel.schema.render.multimd-headerless"
    | "setting-panel.schema.render.multimd-multibody"
    | "setting-panel.schema.proxy.server"
    | "setting-panel.schema.proxy.enabled"
    | "setting-panel.schema.proxy.server-hint"
    | "setting-panel.schema.proxy.bypass-list"
    | "setting-panel.schema.proxy.pac-url"
    | "setting-panel.schema.macros.match"
    | "setting-panel.schema.macros.replace"
    | "setting-panel.schema.macros.macros"
    | "setting-panel.schema.macros.match-placeholder"
    | "setting-panel.schema.macros.replace-placeholder"
    | "setting-panel.schema.language"
    | "setting-panel.schema.assets-dir"
    | "setting-panel.schema.assets-desc"
    | "setting-panel.schema.shell"
    | "setting-panel.schema.envs"
    | "setting-panel.schema.auto-save"
    | "setting-panel.schema.plantuml-api"
    | "setting-panel.schema.server.host"
    | "setting-panel.schema.server.port"
    | "setting-panel.schema.server.port-desc"
    | "setting-panel.schema.hide-main-window-on-startup"
    | "setting-panel.schema.keep-running-after-closing-window"
    | "quick-open.files"
    | "quick-open.input-placeholder"
    | "quick-open.empty"
    | "quick-open.marked"
    | "editor.context-menu.paste-image"
    | "editor.context-menu.paste-image-as-base64"
    | "editor.context-menu.paste-rt-as-markdown"
    | "editor.context-menu.add-attachment"
    | "editor.context-menu.link-doc"
    | "editor.context-menu.link-file"
    | "editor.context-menu.insert-date"
    | "editor.context-menu.insert-time"
    | "editor.context-menu.reveal-line-in-preview"
    | "editor.context-menu.force-insert-new-line"
    | "editor.context-menu.force-insert-indent"
    | "editor.switch-editor"
    | "editor.default-editor"
    | "editor.action-label.reveal-current-file-in-os"
    | "editor.action-label.refresh-current-document"
    | "previewer.default-previewer"
    | "previewer.switch-previewer"
    | "picgo.setting.api-title"
    | "picgo.setting.api-desc"
    | "picgo.setting.api-msg"
    | "picgo.setting.paste-title"
    | "picgo.uploading"
    | "picgo.upload-failed"
    | "picgo.need-api"
    | "picgo.upload-all-images"
    | "code-run.run"
    | "code-run.stop"
    | "code-run.run-in-xterm-tips"
    | "code-run.run-in-xterm"
    | "code-run.running"
    | "code-run.clear"
    | "mind-map.zoom-in"
    | "mind-map.zoom-out"
    | "mind-map.fit-height"
    | "mind-map.switch-layout"
    | "mind-map.switch-loose"
    | "mind-map.convert-error"
    | "table-cell-edit.context-menu.edit"
    | "table-cell-edit.context-menu.quick-edit"
    | "table-cell-edit.context-menu.sort-mode"
    | "table-cell-edit.context-menu.sort-asc"
    | "table-cell-edit.context-menu.sort-desc"
    | "table-cell-edit.context-menu.align-left"
    | "table-cell-edit.context-menu.align-center"
    | "table-cell-edit.context-menu.align-right"
    | "table-cell-edit.context-menu.align-normal"
    | "table-cell-edit.context-menu.add-row-above"
    | "table-cell-edit.context-menu.add-row-below"
    | "table-cell-edit.context-menu.delete-row"
    | "table-cell-edit.context-menu.add-col-left"
    | "table-cell-edit.context-menu.add-col-right"
    | "table-cell-edit.context-menu.delete-col"
    | "table-cell-edit.esc-to-cancel"
    | "table-cell-edit.db-click-edit"
    | "table-cell-edit.canceled"
    | "table-cell-edit.edit-hint"
    | "table-cell-edit.edit-title"
    | "table-cell-edit.edit-error"
    | "table-cell-edit.limit-single-line"
    | "markdown-link.convert-to-titled-link"
    | "custom-css.change-confirm.title"
    | "custom-css.change-confirm.content"
    | "control-center.control-center"
    | "control-center.switch.view"
    | "control-center.switch.editor"
    | "control-center.switch.find-in-preview"
    | "control-center.switch.side-bar"
    | "control-center.switch.word-wrap"
    | "control-center.switch.typewriter-mode"
    | "control-center.switch.sync-scroll"
    | "control-center.switch.sync-rendering"
    | "control-center.navigation.refresh"
    | "control-center.navigation.goto"
    | "control-center.navigation.forward"
    | "control-center.navigation.back"
    | "doc-history.delete-dialog.title"
    | "doc-history.delete-dialog.content"
    | "doc-history.content"
    | "doc-history.mark"
    | "doc-history.unmark"
    | "doc-history.delete"
    | "doc-history.marked"
    | "doc-history.clear"
    | "doc-history.apply-version"
    | "doc-history.no-history"
    | "doc-history.diff"
    | "doc-history.history"
    | "doc-history.current"
    | "doc-history.all"
    | "doc-history.edit-message"
    | "doc-history.clear-dialog.title"
    | "doc-history.clear-dialog.content"
    | "doc-history.mark-dialog.title"
    | "doc-history.mark-dialog.hint"
    | "doc-history.content-too-long-alert.title"
    | "doc-history.content-too-long-alert.content"
    | "copy-content.upload-image"
    | "copy-content.options"
    | "copy-content.type"
    | "copy-content.inline-style"
    | "copy-content.include-style"
    | "copy-content.inline-image"
    | "copy-content.highlight-code"
    | "copy-content.rt"
    | "copy-content.complete"
    | "copy-content.copy-tips"
    | "copy-content.copy-tips-selected"
    | "share-preview.tips"
    | "share-preview.expire"
    | "electron-zoom.zoom-in"
    | "electron-zoom.zoom-out"
    | "electron-zoom.zoom-reset"
    | "extension.reload"
    | "extension.upgrade"
    | "extension.download"
    | "extension.install"
    | "extension.extension-manager"
    | "extension.enabled"
    | "extension.all"
    | "extension.installed"
    | "extension.official"
    | "extension.unofficial"
    | "extension.unknown"
    | "extension.author"
    | "extension.origin"
    | "extension.unpacked-size"
    | "extension.latest-version"
    | "extension.installed-version"
    | "extension.homepage"
    | "extension.toast-loaded"
    | "extension.upgradable"
    | "extension.incompatible"
    | "extension.not-installed"
    | "extension.disabled"
    | "extension.reload-required"
    | "extension.no-extension"
    | "extension.uninstall"
    | "extension.installing"
    | "extension.uninstalling"
    | "extension.disable"
    | "extension.enable"
    | "extension.uninstall-confirm"
    | "extension.registry"
    | "extension.activation-time"
    | "extension.requirement"
    | "extension.auto-upgrade"
    | "extension.unknown-origin-tips"
    | "extension.extensions-auto-upgraded"
    | "extension.fetch-registry-failed"
    | "get-started.get-started"
    | "get-started.help"
    | "get-started.start"
    | "get-started.recent"
    | "search-panel.search-files"
    | "search-panel.placeholder-search"
    | "search-panel.for-history"
    | "search-panel.files-to-include"
    | "search-panel.files-to-exclude"
    | "search-panel.match-case"
    | "search-panel.match-whole-word"
    | "search-panel.use-regex"
    | "search-panel.expand-all"
    | "search-panel.collapse-all"
    | "file-changed-alert.reload"
    | "file-changed-alert.title"
    | "file-changed-alert.content"
    | "command-desc.base_find-in-repository"
    | "command-desc.control-center_toggle"
    | "command-desc.doc_show-history"
    | "command-desc.editor_toggle-wrap"
    | "command-desc.file-tabs_close-current"
    | "command-desc.file-tabs_search-tabs"
    | "command-desc.file-tabs_show-welcome"
    | "command-desc.file-tabs_switch-left"
    | "command-desc.file-tabs_switch-right"
    | "command-desc.layout_toggle-editor"
    | "command-desc.layout_toggle-side"
    | "command-desc.layout_toggle-view"
    | "command-desc.layout_toggle-xterm"
    | "command-desc.plugin_copy-content_copy-content"
    | "command-desc.plugin_document-history-stack_back"
    | "command-desc.plugin_document-history-stack_forward"
    | "command-desc.plugin_editor_focus-editor"
    | "command-desc.plugin_switch-todo_switch"
    | "command-desc.view_enter-presentation"
    | "command-desc.workbench_show-quick-open"
    | "command-desc.workbench_toggle-outline"
    | "command-desc.plugin_electron-zoom_zoom-in"
    | "command-desc.plugin_electron-zoom_zoom-out"
    | "command-desc.plugin_electron-zoom_zoom-reset"
    | "command-desc.view_refresh"
    | "command-desc.extension_show-manager"
    | "command-desc.keyboard-shortcuts_show-manager"
    | "command-desc.plugin_image-localization_all"
    | "command-desc.tree_refresh"
    | "command-desc.plugin_status-bar-theme_switch"
    | "command-desc.editor_rotate-custom-editors"
    | "command-desc.view_show-find-in-preview-widget"
    | "command-desc.tree_reveal-current-node"
    | "keyboard-shortcuts.search"
    | "keyboard-shortcuts.editor"
    | "keyboard-shortcuts.keyboard-shortcuts"
    | "keyboard-shortcuts.empty"
    | "keyboard-shortcuts.clear"
    | "keyboard-shortcuts.workbench"
    | "keyboard-shortcuts.application"
    | "keyboard-shortcuts.unavailable"
    | "keyboard-shortcuts.command"
    | "keyboard-shortcuts.keybinding"
    | "keyboard-shortcuts.not-set"
    | "keyboard-shortcuts.change"
    | "keyboard-shortcuts.reset"
    | "keyboard-shortcuts.recorder.conflict-commands"
    | "keyboard-shortcuts.recorder.tip"
    | "keyboard-shortcuts.conflict"
    | "keyboard-shortcuts.conflict-title"
    | "keyboard-shortcuts.conflict-commands"
    | "find-in-preview.action-tips.close"
    | "find-in-preview.action-tips.prev"
    | "find-in-preview.action-tips.next"
    | "find-in-preview.results"
    | "find-in-preview.toast-no-more"
    | "view-context-menu.copy-image"
    | "view-context-menu.delete-image"
    | "view-context-menu.open-in-new-tab", ...args: string[]) => string)

Type declaration

    • (path, ...args): string

    • Translate

      Parameters

      • path:
            | "close"
            | "default"
            | "app-name"
            | "about"
            | "feedback"
            | "slogan"
            | "cancel"
            | "undo"
            | "ok"
            | "demo-tips"
            | "more"
            | "copied"
            | "others"
            | "insert-different-repo-doc"
            | "need-clipboard-permission"
            | "click-to-copy"
            | "click-to-copy-link"
            | "copy-code"
            | "loading"
            | "add-image"
            | "upload-image"
            | "exit-presentation-msg"
            | "reload"
            | "open-in-new-window"
            | "view-figure"
            | "export"
            | "no-password"
            | "save"
            | "discard"
            | "edit"
            | "outline"
            | "files"
            | "install-extension-tips"
            | "not-support-mas"
            | "learn-more"
            | "print"
            | "markdown-file"
            | "encrypted-markdown-file"
            | "switch-repo-n"
            | "switch-the-last-repo"
            | "edit-or-generate-text-using-ai"
            | "file-readonly-desc"
            | "can-not-edit-this-file-type"
            | "read-only-mode-desc"
            | "premium.premium"
            | "premium.confetti"
            | "premium.need-purchase"
            | "premium.buy-license"
            | "premium.free"
            | "premium.upgrade"
            | "premium.intro.intro"
            | "premium.intro.current-plan"
            | "premium.intro.included"
            | "premium.intro.desc"
            | "premium.intro.free-desc"
            | "premium.intro.premium-desc"
            | "premium.intro.free-list"
            | "premium.intro.premium-list"
            | "premium.buy.buy"
            | "premium.activation.activation"
            | "premium.activation.license"
            | "premium.activation.placeholder"
            | "premium.activation.get-license"
            | "premium.activation.info"
            | "premium.activation.expired"
            | "premium.activation.expiring"
            | "premium.activation.need-refresh"
            | "premium.activation.refresh"
            | "premium.activation.renewal"
            | "premium.activation.devices"
            | "premium.activation.this-machine"
            | "premium.activation.unbind"
            | "premium.activation.unbind-confirm"
            | "premium.activation.name"
            | "premium.activation.email"
            | "premium.activation.expires"
            | "premium.activation.plan"
            | "premium.activation.success"
            | "premium.activation.activating"
            | "premium.activation.tips"
            | "premium.activation.tips-wechat"
            | "premium.activation.activation-tips"
            | "premium.activation.offline-activation"
            | "premium.activation.online-activation"
            | "premium.activation.get-activation-token"
            | "app.error.EADDRINUSE"
            | "app.quit"
            | "app.preferences"
            | "app.close-window"
            | "app.toggle-fullscreen"
            | "app.hide-main-window"
            | "app.tray.quit"
            | "app.tray.preferences"
            | "app.tray.open-main-window"
            | "app.tray.open-in-browser"
            | "app.tray.open-main-dir"
            | "app.tray.start-at-login"
            | "app.tray.version"
            | "app.tray.dev.reload"
            | "app.tray.dev.dev"
            | "app.tray.dev.port-prod"
            | "app.tray.dev.port-dev"
            | "app.tray.dev.dev-tool"
            | "app.tray.dev.restart"
            | "app.tray.dev.force-quit"
            | "app.updater.found-dialog.desc"
            | "app.updater.found-dialog.title"
            | "app.updater.found-dialog.buttons.cancel"
            | "app.updater.found-dialog.buttons.download"
            | "app.updater.found-dialog.buttons.view-changes"
            | "app.updater.found-dialog.buttons.download-and-view-changes"
            | "app.updater.found-dialog.buttons.ignore"
            | "app.updater.progress-bar.title"
            | "app.updater.progress-bar.detail"
            | "app.updater.progress-bar.failed"
            | "app.updater.failed-dialog.title"
            | "app.updater.install-dialog.desc"
            | "app.updater.install-dialog.title"
            | "app.updater.install-dialog.buttons.install"
            | "app.updater.install-dialog.buttons.delay"
            | "app.updater.no-newer-dialog.desc"
            | "app.updater.no-newer-dialog.title"
            | "quit-check-dialog.desc"
            | "quit-check-dialog.title"
            | "quit-check-dialog.buttons.cancel"
            | "quit-check-dialog.buttons.discard"
            | "save-check-dialog.desc"
            | "save-check-dialog.title"
            | "change-setting-reload-main-widow-dialog.desc"
            | "change-setting-reload-main-widow-dialog.title"
            | "file-status.loading"
            | "file-status.unsaved"
            | "file-status.saving"
            | "file-status.saved"
            | "file-status.save-failed"
            | "file-status.loaded"
            | "file-status.no-file"
            | "modal.info"
            | "modal.input-placeholder"
            | "document.current-path"
            | "document.invalid-filename"
            | "document.password-create"
            | "document.password-save"
            | "document.password-open"
            | "document.wrong-password"
            | "document.file-transform-error"
            | "document.custom-extension"
            | "document.create-dialog.title"
            | "document.create-dialog.hint"
            | "document.create-dir-dialog.title"
            | "document.create-dir-dialog.hint"
            | "document.duplicate-dialog.title"
            | "document.duplicate-dialog.hint"
            | "document.delete-dialog.title"
            | "document.delete-dialog.content"
            | "document.move-dialog.title"
            | "document.move-dialog.content"
            | "document.save-encrypted-file-dialog.title"
            | "document.save-encrypted-file-dialog.content"
            | "document.switch-noent-dialog.title"
            | "document.switch-noent-dialog.content"
            | "status-bar.view.view"
            | "status-bar.view.editor"
            | "status-bar.view.xterm"
            | "status-bar.view.preview"
            | "status-bar.view.side-bar"
            | "status-bar.view.word-wrap"
            | "status-bar.view.typewriter-mode"
            | "status-bar.view.editor-preview-exclusive"
            | "status-bar.extension.extension-manager"
            | "status-bar.setting"
            | "status-bar.repo.repo"
            | "status-bar.repo.no-data"
            | "status-bar.nav.nav"
            | "status-bar.nav.goto"
            | "status-bar.nav.reveal-current-file-in-sidebar"
            | "status-bar.nav.forward"
            | "status-bar.nav.back"
            | "status-bar.insert.insert"
            | "status-bar.insert.paste-rt"
            | "status-bar.insert.paste-img-base64"
            | "status-bar.tool.export"
            | "status-bar.tool.print"
            | "status-bar.tool.doc-history"
            | "status-bar.tool.copy-content"
            | "status-bar.tool.share-preview"
            | "status-bar.tool.tool"
            | "status-bar.tool.convert-img-link"
            | "status-bar.tool.macro-copy-markdown"
            | "status-bar.document-info.selected"
            | "status-bar.document-info.lines"
            | "status-bar.document-info.chars"
            | "status-bar.document-info.selections"
            | "status-bar.help.help"
            | "status-bar.help.readme"
            | "status-bar.help.features"
            | "status-bar.help.shortcuts"
            | "status-bar.help.guide"
            | "status-bar.help.plugin"
            | "status-bar.terminal"
            | "status-bar.present"
            | "status-bar.get.get-application"
            | "status-bar.theme.tips"
            | "status-bar.theme.dark"
            | "status-bar.theme.light"
            | "status-bar.theme.system"
            | "view.outline"
            | "view.print"
            | "tree.sort.desc"
            | "tree.sort.asc"
            | "tree.sort.by-name"
            | "tree.sort.by-mtime"
            | "tree.sort.by-birthtime"
            | "tree.sort.by-serial"
            | "tree.db-click-refresh"
            | "tree.add-repo"
            | "tree.add-repo-hint"
            | "tree.created-at"
            | "tree.updated-at"
            | "tree.context-menu.refresh"
            | "tree.context-menu.mark"
            | "tree.context-menu.unmark"
            | "tree.context-menu.duplicate"
            | "tree.context-menu.create-doc"
            | "tree.context-menu.create-dir"
            | "tree.context-menu.add-item"
            | "tree.context-menu.rename"
            | "tree.context-menu.delete"
            | "tree.context-menu.open-in-os"
            | "tree.context-menu.reveal-in-os"
            | "tree.context-menu.open-in-terminal"
            | "tree.context-menu.create-in-cd"
            | "tree.context-menu.copy-name"
            | "tree.context-menu.copy-path"
            | "tree.context-menu.find-in-folder"
            | "tree.toast.copied"
            | "tree.toast.moved"
            | "tabs.close-others"
            | "tabs.close-right"
            | "tabs.close-left"
            | "tabs.close-all"
            | "tabs.pin"
            | "tabs.unpin"
            | "tabs.search-tabs"
            | "tabs.new-tab"
            | "export-panel.loading"
            | "export-panel.export"
            | "export-panel.format"
            | "export-panel.pdf.orientation"
            | "export-panel.pdf.portrait"
            | "export-panel.pdf.landscape"
            | "export-panel.pdf.size"
            | "export-panel.pdf.zoom"
            | "export-panel.pdf.use-browser"
            | "export-panel.pdf.include-bg"
            | "export-panel.use-html"
            | "export-panel.use-markdown"
            | "title-bar.pin"
            | "title-bar.minimize"
            | "title-bar.unmaximize"
            | "title-bar.maximize"
            | "setting-panel.tabs.editor"
            | "setting-panel.tabs.repos"
            | "setting-panel.tabs.appearance"
            | "setting-panel.tabs.render"
            | "setting-panel.tabs.image"
            | "setting-panel.tabs.proxy"
            | "setting-panel.tabs.macros"
            | "setting-panel.tabs.other"
            | "setting-panel.setting"
            | "setting-panel.add"
            | "setting-panel.delete-warning"
            | "setting-panel.error-choose-repo-path"
            | "setting-panel.change-keyboard-shortcuts"
            | "setting-panel.schema.search.number-limit"
            | "setting-panel.schema.assets.path-type"
            | "setting-panel.schema.view.default-previewer-max-width"
            | "setting-panel.schema.view.default-previewer-max-width-desc"
            | "setting-panel.schema.tree.exclude"
            | "setting-panel.schema.editor.mouse-wheel-zoom"
            | "setting-panel.schema.editor.font-size"
            | "setting-panel.schema.editor.tab-size"
            | "setting-panel.schema.editor.ordered-list-completion"
            | "setting-panel.schema.editor.minimap"
            | "setting-panel.schema.editor.line-numbers"
            | "setting-panel.schema.editor.enable-preview"
            | "setting-panel.schema.editor.font-family"
            | "setting-panel.schema.editor.font-ligatures"
            | "setting-panel.schema.editor.complete-emoji"
            | "setting-panel.schema.editor.todo-with-time"
            | "setting-panel.schema.editor.suggest-on-trigger-characters"
            | "setting-panel.schema.editor.sticky-scroll-enabled"
            | "setting-panel.schema.editor.quick-suggestions"
            | "setting-panel.schema.editor.enable-ai-copilot-action"
            | "setting-panel.schema.custom-css"
            | "setting-panel.schema.doc-history.number-limit"
            | "setting-panel.schema.updater.source"
            | "setting-panel.schema.theme"
            | "setting-panel.schema.repos.name"
            | "setting-panel.schema.repos.repo"
            | "setting-panel.schema.repos.repos"
            | "setting-panel.schema.repos.name-placeholder"
            | "setting-panel.schema.repos.path"
            | "setting-panel.schema.repos.path-placeholder"
            | "setting-panel.schema.render.md-html"
            | "setting-panel.schema.render.md-breaks"
            | "setting-panel.schema.render.md-linkify"
            | "setting-panel.schema.render.md-wiki-links"
            | "setting-panel.schema.render.md-typographer"
            | "setting-panel.schema.render.md-sup"
            | "setting-panel.schema.render.md-sub"
            | "setting-panel.schema.render.md-emoji"
            | "setting-panel.schema.render.multimd-multiline"
            | "setting-panel.schema.render.multimd-rowspan"
            | "setting-panel.schema.render.multimd-headerless"
            | "setting-panel.schema.render.multimd-multibody"
            | "setting-panel.schema.proxy.server"
            | "setting-panel.schema.proxy.enabled"
            | "setting-panel.schema.proxy.server-hint"
            | "setting-panel.schema.proxy.bypass-list"
            | "setting-panel.schema.proxy.pac-url"
            | "setting-panel.schema.macros.match"
            | "setting-panel.schema.macros.replace"
            | "setting-panel.schema.macros.macros"
            | "setting-panel.schema.macros.match-placeholder"
            | "setting-panel.schema.macros.replace-placeholder"
            | "setting-panel.schema.language"
            | "setting-panel.schema.assets-dir"
            | "setting-panel.schema.assets-desc"
            | "setting-panel.schema.shell"
            | "setting-panel.schema.envs"
            | "setting-panel.schema.auto-save"
            | "setting-panel.schema.plantuml-api"
            | "setting-panel.schema.server.host"
            | "setting-panel.schema.server.port"
            | "setting-panel.schema.server.port-desc"
            | "setting-panel.schema.hide-main-window-on-startup"
            | "setting-panel.schema.keep-running-after-closing-window"
            | "quick-open.files"
            | "quick-open.input-placeholder"
            | "quick-open.empty"
            | "quick-open.marked"
            | "editor.context-menu.paste-image"
            | "editor.context-menu.paste-image-as-base64"
            | "editor.context-menu.paste-rt-as-markdown"
            | "editor.context-menu.add-attachment"
            | "editor.context-menu.link-doc"
            | "editor.context-menu.link-file"
            | "editor.context-menu.insert-date"
            | "editor.context-menu.insert-time"
            | "editor.context-menu.reveal-line-in-preview"
            | "editor.context-menu.force-insert-new-line"
            | "editor.context-menu.force-insert-indent"
            | "editor.switch-editor"
            | "editor.default-editor"
            | "editor.action-label.reveal-current-file-in-os"
            | "editor.action-label.refresh-current-document"
            | "previewer.default-previewer"
            | "previewer.switch-previewer"
            | "picgo.setting.api-title"
            | "picgo.setting.api-desc"
            | "picgo.setting.api-msg"
            | "picgo.setting.paste-title"
            | "picgo.uploading"
            | "picgo.upload-failed"
            | "picgo.need-api"
            | "picgo.upload-all-images"
            | "code-run.run"
            | "code-run.stop"
            | "code-run.run-in-xterm-tips"
            | "code-run.run-in-xterm"
            | "code-run.running"
            | "code-run.clear"
            | "mind-map.zoom-in"
            | "mind-map.zoom-out"
            | "mind-map.fit-height"
            | "mind-map.switch-layout"
            | "mind-map.switch-loose"
            | "mind-map.convert-error"
            | "table-cell-edit.context-menu.edit"
            | "table-cell-edit.context-menu.quick-edit"
            | "table-cell-edit.context-menu.sort-mode"
            | "table-cell-edit.context-menu.sort-asc"
            | "table-cell-edit.context-menu.sort-desc"
            | "table-cell-edit.context-menu.align-left"
            | "table-cell-edit.context-menu.align-center"
            | "table-cell-edit.context-menu.align-right"
            | "table-cell-edit.context-menu.align-normal"
            | "table-cell-edit.context-menu.add-row-above"
            | "table-cell-edit.context-menu.add-row-below"
            | "table-cell-edit.context-menu.delete-row"
            | "table-cell-edit.context-menu.add-col-left"
            | "table-cell-edit.context-menu.add-col-right"
            | "table-cell-edit.context-menu.delete-col"
            | "table-cell-edit.esc-to-cancel"
            | "table-cell-edit.db-click-edit"
            | "table-cell-edit.canceled"
            | "table-cell-edit.edit-hint"
            | "table-cell-edit.edit-title"
            | "table-cell-edit.edit-error"
            | "table-cell-edit.limit-single-line"
            | "markdown-link.convert-to-titled-link"
            | "custom-css.change-confirm.title"
            | "custom-css.change-confirm.content"
            | "control-center.control-center"
            | "control-center.switch.view"
            | "control-center.switch.editor"
            | "control-center.switch.find-in-preview"
            | "control-center.switch.side-bar"
            | "control-center.switch.word-wrap"
            | "control-center.switch.typewriter-mode"
            | "control-center.switch.sync-scroll"
            | "control-center.switch.sync-rendering"
            | "control-center.navigation.refresh"
            | "control-center.navigation.goto"
            | "control-center.navigation.forward"
            | "control-center.navigation.back"
            | "doc-history.delete-dialog.title"
            | "doc-history.delete-dialog.content"
            | "doc-history.content"
            | "doc-history.mark"
            | "doc-history.unmark"
            | "doc-history.delete"
            | "doc-history.marked"
            | "doc-history.clear"
            | "doc-history.apply-version"
            | "doc-history.no-history"
            | "doc-history.diff"
            | "doc-history.history"
            | "doc-history.current"
            | "doc-history.all"
            | "doc-history.edit-message"
            | "doc-history.clear-dialog.title"
            | "doc-history.clear-dialog.content"
            | "doc-history.mark-dialog.title"
            | "doc-history.mark-dialog.hint"
            | "doc-history.content-too-long-alert.title"
            | "doc-history.content-too-long-alert.content"
            | "copy-content.upload-image"
            | "copy-content.options"
            | "copy-content.type"
            | "copy-content.inline-style"
            | "copy-content.include-style"
            | "copy-content.inline-image"
            | "copy-content.highlight-code"
            | "copy-content.rt"
            | "copy-content.complete"
            | "copy-content.copy-tips"
            | "copy-content.copy-tips-selected"
            | "share-preview.tips"
            | "share-preview.expire"
            | "electron-zoom.zoom-in"
            | "electron-zoom.zoom-out"
            | "electron-zoom.zoom-reset"
            | "extension.reload"
            | "extension.upgrade"
            | "extension.download"
            | "extension.install"
            | "extension.extension-manager"
            | "extension.enabled"
            | "extension.all"
            | "extension.installed"
            | "extension.official"
            | "extension.unofficial"
            | "extension.unknown"
            | "extension.author"
            | "extension.origin"
            | "extension.unpacked-size"
            | "extension.latest-version"
            | "extension.installed-version"
            | "extension.homepage"
            | "extension.toast-loaded"
            | "extension.upgradable"
            | "extension.incompatible"
            | "extension.not-installed"
            | "extension.disabled"
            | "extension.reload-required"
            | "extension.no-extension"
            | "extension.uninstall"
            | "extension.installing"
            | "extension.uninstalling"
            | "extension.disable"
            | "extension.enable"
            | "extension.uninstall-confirm"
            | "extension.registry"
            | "extension.activation-time"
            | "extension.requirement"
            | "extension.auto-upgrade"
            | "extension.unknown-origin-tips"
            | "extension.extensions-auto-upgraded"
            | "extension.fetch-registry-failed"
            | "get-started.get-started"
            | "get-started.help"
            | "get-started.start"
            | "get-started.recent"
            | "search-panel.search-files"
            | "search-panel.placeholder-search"
            | "search-panel.for-history"
            | "search-panel.files-to-include"
            | "search-panel.files-to-exclude"
            | "search-panel.match-case"
            | "search-panel.match-whole-word"
            | "search-panel.use-regex"
            | "search-panel.expand-all"
            | "search-panel.collapse-all"
            | "file-changed-alert.reload"
            | "file-changed-alert.title"
            | "file-changed-alert.content"
            | "command-desc.base_find-in-repository"
            | "command-desc.control-center_toggle"
            | "command-desc.doc_show-history"
            | "command-desc.editor_toggle-wrap"
            | "command-desc.file-tabs_close-current"
            | "command-desc.file-tabs_search-tabs"
            | "command-desc.file-tabs_show-welcome"
            | "command-desc.file-tabs_switch-left"
            | "command-desc.file-tabs_switch-right"
            | "command-desc.layout_toggle-editor"
            | "command-desc.layout_toggle-side"
            | "command-desc.layout_toggle-view"
            | "command-desc.layout_toggle-xterm"
            | "command-desc.plugin_copy-content_copy-content"
            | "command-desc.plugin_document-history-stack_back"
            | "command-desc.plugin_document-history-stack_forward"
            | "command-desc.plugin_editor_focus-editor"
            | "command-desc.plugin_switch-todo_switch"
            | "command-desc.view_enter-presentation"
            | "command-desc.workbench_show-quick-open"
            | "command-desc.workbench_toggle-outline"
            | "command-desc.plugin_electron-zoom_zoom-in"
            | "command-desc.plugin_electron-zoom_zoom-out"
            | "command-desc.plugin_electron-zoom_zoom-reset"
            | "command-desc.view_refresh"
            | "command-desc.extension_show-manager"
            | "command-desc.keyboard-shortcuts_show-manager"
            | "command-desc.plugin_image-localization_all"
            | "command-desc.tree_refresh"
            | "command-desc.plugin_status-bar-theme_switch"
            | "command-desc.editor_rotate-custom-editors"
            | "command-desc.view_show-find-in-preview-widget"
            | "command-desc.tree_reveal-current-node"
            | "keyboard-shortcuts.search"
            | "keyboard-shortcuts.editor"
            | "keyboard-shortcuts.keyboard-shortcuts"
            | "keyboard-shortcuts.empty"
            | "keyboard-shortcuts.clear"
            | "keyboard-shortcuts.workbench"
            | "keyboard-shortcuts.application"
            | "keyboard-shortcuts.unavailable"
            | "keyboard-shortcuts.command"
            | "keyboard-shortcuts.keybinding"
            | "keyboard-shortcuts.not-set"
            | "keyboard-shortcuts.change"
            | "keyboard-shortcuts.reset"
            | "keyboard-shortcuts.recorder.conflict-commands"
            | "keyboard-shortcuts.recorder.tip"
            | "keyboard-shortcuts.conflict"
            | "keyboard-shortcuts.conflict-title"
            | "keyboard-shortcuts.conflict-commands"
            | "find-in-preview.action-tips.close"
            | "find-in-preview.action-tips.prev"
            | "find-in-preview.action-tips.next"
            | "find-in-preview.results"
            | "find-in-preview.toast-no-more"
            | "view-context-menu.copy-image"
            | "view-context-menu.delete-image"
            | "view-context-menu.open-in-new-tab"
      • Rest...args: string[]

      Returns string

hide

hide: (() => void)

show

show: ((menuItems: Components.ContextMenu.Item[], opts?: ShowOpts) => void)

Methods

$watch

  • $watch<T>(source, cb, options?): WatchStopHandle

  • Type Parameters

    • T extends string | ((...args: any) => any)

    Parameters

    • source: T
    • cb: T extends ((...args: any) => R)
          ? ((...args: [R, R, OnCleanup]) => any)
          : ((...args: [any, any, OnCleanup]) => any)
    • Optionaloptions: WatchOptions<boolean>

    Returns WatchStopHandle

Settings

Member Visibility

On This Page

Properties
Methods