App

Constructors

new App()

new App(): App

Returns

App

Properties

appId

appId: string

ID that uniquely identifies the vault

Tutorial

Used for implementing device and vault-specific data storage using LocalStorage or IndexedDB

---

commands

commands: Commands

Contains all registered commands

Tutorial

Can be used to manually invoke the functionality of a specific command

---

customCss

customCss: CustomCSS

Custom CSS (snippets/themes) applied to the application

Tutorial

Can be used to view which snippets are enabled or available, or inspect loaded-in theme manifests

---

dom

dom: ObsidianDOM

References to important DOM elements of the application

---

embedRegistry

embedRegistry: EmbedRegistry

Registry that manages the creation of generic media type embeds

---

fileManager

fileManager: FileManager

---

hotkeyManager

hotkeyManager: HotkeyManager

Manages global hotkeys

Tutorial

Can be used for manually invoking a command, or finding which hotkey is assigned to a specific key input

Remark

This should not be used for adding hotkeys to your custom commands, this can easily be done via the official API

---

internalPlugins

internalPlugins: InternalPlugins

Manager of internal ‘core’ plugins

Tutorial

Can be used to check whether a specific internal plugin is enabled, or grab specific parts from its config for simplifying your own plugin’s settings

---

isMobile

isMobile: boolean

Whether the application is currently running on mobile

Deprecated

Will be inaccessible in a future version, prefer using Platform.isMobile

Remark

Prefer usage of Platform.isMobile

Remark

Will be true if app.emulateMobile() was enabled

---

keymap

keymap: Keymap

---

lastEvent

lastEvent: null | UserEvent

The last known user interaction event, to help commands find out what modifier keys are pressed.

---

loadProgress

loadProgress: LoadProgress

Deprecated

Made inaccessible in 1.6.0, this object can be recreated using Notices

---

metadataCache

metadataCache: MetadataCache

---

metadataTypeManager

metadataTypeManager: MetadataTypeManager

Manages the frontmatter properties of the vault and the rendering of the properties

Tutorial

Fetching properties used in all frontmatter fields, may potentially be used for adding custom frontmatter widgets

---

mobileTabSwitcher

mobileTabSwitcher: null | MobileTabSwitcher

---

plugins

plugins: Plugins

Manages loading and enabling of community (non-core) plugins

Tutorial

Can be used to communicate with other plugins, custom plugin management, …

Remark

Be careful when overriding loading logic, as this may result in other plugins not loading

---

scope

scope: Scope

---

setting

setting: AppSetting

Manages the settings modal and its tabs

Tutorial

Can be used to open the settings modal to a specific tab, extend the settings modal functionality, …

Remark

Do not use this to get settings values from other plugins, it is better to do this via app.plugins.getPlugin(ID)?.settings (check how the plugin stores its settings)

---

title

title: string

Name of the vault with version suffix

Remark

Formatted as ‘NAME - Obsidian vX.Y.Z’

---

vault

vault: Vault

---

viewRegistry

viewRegistry: ViewRegistry

Manages the construction of appropriate views when opening a file of a certain type

Remark

Prefer usage of view registration via the Plugin class

---

workspace

workspace: Workspace

Methods

changeTheme()

changeTheme(theme): void

Sets the accent color of the application (light/dark mode)

Parameters

• theme: "moonstone" | "obsidian"

Returns

void

---

copyObsidianUrl()

copyObsidianUrl(file): void

Copies Obsidian URI of given file to clipboard

Parameters

• file: TFile

File to generate URI for

Returns

void

---

debugMode()

debugMode(isEnabled): void

Toggles debug mode

Parameters

• isEnabled: boolean

Whether to enable or disable debug mode

Returns

void

---

disableCssTransition()

disableCssTransition(): void

Disables all CSS transitions in the vault (until manually re-enabled)

Returns

void

---

emulateMobile()

emulateMobile(emulate): void

Restarts Obsidian and renders workspace in mobile mode

Parameters

• emulate: boolean

Returns

void

Tutorial

Very useful for testing the rendering of your plugin on mobile devices

---

enableCssTransition()

enableCssTransition(): void

Enables all CSS transitions in the vault

Returns

void

---

fixFileLinks()

fixFileLinks(element): void

Manually fix all file links pointing towards image/audio/video resources in element

Parameters

• element: HTMLElement

Element to fix links in

Returns

void

---

garbleText()

garbleText(): void

Applies an obfuscation font to all text characters in the vault

Returns

void

Tutorial

Useful for hiding sensitive information or sharing pretty screenshots of your vault

Remark

Uses the Flow Circular font

Remark

You will have to restart the app to get normal text back

---

getAccentColor()

getAccentColor(): string

Get the accent color of the application

Returns

string

Remark

Often a better alternative than app.vault.getConfig('accentColor') as it returns an empty string if no accent color was set

---

getAppTitle()

getAppTitle(): string

Get the current title of the application

Returns

string

Remark

The title is based on the currently active leaf

---

getObsidianUrl()

getObsidianUrl(file): string

Get the URI for opening specified file in Obsidian

Parameters

• file: TFile

Returns

string

---

getSpellcheckLanguages()

getSpellcheckLanguages(): string[]

Get currently active spellcheck languages

Deprecated

Originally spellcheck languages were stored in app settings, languages are now stored in localStorage.getItem(spellcheck-languages)

Returns

string[]

---

getTheme()

getTheme(): "moonstone" | "obsidian"

Get the current color scheme of the application

Returns

"moonstone" | "obsidian"

Remark

Identical to app.vault.getConfig('theme')

---

importAttachments()

importAttachments(imports, folder): Promise<void>

Import attachments into specified folder

Parameters

• imports: ImportedAttachments[]

• folder: null | TFolder

Returns

Promise<void>

---

isVimEnabled()

isVimEnabled(): boolean

Returns

boolean

---

loadLocalStorage()

loadLocalStorage(key): unknown

Load a value from the localstorage given key

Parameters

• key: string

Key of value to load

Returns

unknown

Remark

This method is device and vault specific

Tutorial

Use load/saveLocalStorage for saving configuration data that needs to be unique to the current vault

---

on()

on(): void

Returns

void

---

openHelp()

openHelp(): void

Open the help vault (or site if mobile)

Returns

void

---

openVaultChooser()

openVaultChooser(): void

Open the vault picker

Returns

void

---

openWithDefaultApp()

openWithDefaultApp(path): void

Open the file with OS defined default file browser application

Parameters

• path: string

Returns

void

---

saveLocalStorage()

saveLocalStorage(key, value): void

Save a value to the localstorage given key

Parameters

• key: string

Key of value to save

• value: unknown

Value to save

Returns

void

Remark

This method is device and vault specific

Tutorial

Use load/saveLocalStorage for saving configuration data that needs to be unique to the current vault

---

setAccentColor()

setAccentColor(color): void

Set the accent color of the application

Parameters

• color: string

Returns

void

Remark

Also updates the CSS --accent variables

---

setAttachmentFolder()

setAttachmentFolder(path): void

Set the path where attachments should be stored

Parameters

• path: string

Returns

void

---

setSpellcheckLanguages()

setSpellcheckLanguages(languages): void

Set the spellcheck languages

Parameters

• languages: string[]

Returns

void

---

setTheme()

setTheme(theme): void

Set the current color scheme of the application and reload the CSS

Parameters

• theme: "moonstone" | "obsidian"

Returns

void

---

showInFolder()

showInFolder(path): void

Open the OS file picker at path location

Parameters

• path: string

Returns

void

---

showReleaseNotes()

showReleaseNotes(version?): void

Show the release notes for provided version as a new leaf

Parameters

• version?: string

Version to show release notes for (defaults to current version)

Returns

void

---

updateAccentColor()

updateAccentColor(): void

Updates the accent color and reloads the CSS

Returns

void

---

updateFontFamily()

updateFontFamily(): void

Update the font family of the application and reloads the CSS

Returns

void

---

updateFontSize()

updateFontSize(): void

Update the font size of the application and reloads the CSS

Returns

void

---

updateInlineTitleDisplay()

updateInlineTitleDisplay(): void

Update the inline title rendering in notes

Returns

void

---

updateRibbonDisplay()

updateRibbonDisplay(): void

Returns

void

---

updateTheme()

updateTheme(): void

Update the color scheme of the application and reloads the CSS

Returns

void

---

updateViewHeaderDisplay()

updateViewHeaderDisplay(): void

Update the view header display in notes

Returns

void