App

Class: App

Defined in: context.svelte.ts:200

Central runtime service container exposed to plugins, views, and renderer integrations.

App owns the active vault session, workspace layout, plugin runtime, commands, metadata cache, notifications, and related shared services.

Constructors

Constructor

new App(props): App

Defined in: context.svelte.ts:261

Create the application service container for a mounted vault session.

Parameters

props

AppStateProperties

Runtime services and adapters required to bootstrap the app.

Returns

App

Properties

appDatabase

readonly appDatabase: AppDatabase

Defined in: context.svelte.ts:204

---

commands

commands: CommandManager

Defined in: context.svelte.ts:229

---

configuration

readonly configuration: Configuration

Defined in: context.svelte.ts:213

---

configurationOptionSources

readonly configurationOptionSources: ConfigurationOptionSourceRegistry

Defined in: context.svelte.ts:234

---

contextKeys

readonly contextKeys: ContextKeyService

Defined in: context.svelte.ts:215

---

editors

readonly editors: Map<string, Set<ExtType>>

Defined in: context.svelte.ts:211

---

editorSuggest

readonly editorSuggest: Map<string, Set<EditorSuggest<any>>>

Defined in: context.svelte.ts:212

---

embedRegistry

embedRegistry: EmbedRegistry

Defined in: context.svelte.ts:233

---

fileManager

readonly fileManager: FileManager

Defined in: context.svelte.ts:214

---

i18n

readonly i18n: LocalizationManager = localeManager

Defined in: context.svelte.ts:201

---

keymap

keymap: Keymap

Defined in: context.svelte.ts:209

---

languageServices

readonly languageServices: LanguageServiceManager

Defined in: context.svelte.ts:240

---

lastEvent

lastEvent: UserEvent | null

Defined in: context.svelte.ts:235

---

logger

readonly logger: Logger

Defined in: context.svelte.ts:253

---

mardownCodeBlockPostProcessor

mardownCodeBlockPostProcessor: Record<string, MarkdownPostProcessor[]>

Defined in: context.svelte.ts:222

---

mardownPostProcessor

mardownPostProcessor: MarkdownPostProcessor[]

Defined in: context.svelte.ts:221

---

markdownDirectiveRenderers

markdownDirectiveRenderers: Record<string, MarkdownDirectiveRenderer>

Defined in: context.svelte.ts:224

---

markdownViewMenuItems

readonly markdownViewMenuItems: Set<MarkdownViewMenuItemProvider>

Defined in: context.svelte.ts:226

---

metadataCache

metadataCache: MetadataCache

Defined in: context.svelte.ts:232

---

metadataTypeManager

metadataTypeManager: MetadataTypeManager

Defined in: context.svelte.ts:227

---

notifications

notifications: NotificationManager

Defined in: context.svelte.ts:238

---

pluginDistribution

readonly pluginDistribution: DefaultPluginDistributionManager

Defined in: context.svelte.ts:219

---

plugins

plugins: PluginManager

Defined in: context.svelte.ts:207

---

props

readonly props: AppStateProperties

Defined in: context.svelte.ts:261

Runtime services and adapters required to bootstrap the app.

---

renderContext

renderContext: RenderContext

Defined in: context.svelte.ts:236

---

safeMode

readonly safeMode: AppSafeModeState

Defined in: context.svelte.ts:206

---

scope

scope: Scope

Defined in: context.svelte.ts:208

---

secretStorage

secretStorage: SecretStorage

Defined in: context.svelte.ts:237

---

session?

readonly optional session?: VaultSession

Defined in: context.svelte.ts:205

---

settings

readonly settings: AppSettings

Defined in: context.svelte.ts:210

---

settingsOpen

settingsOpen: boolean

Defined in: context.svelte.ts:230

---

settingsTabId

settingsTabId: string | null

Defined in: context.svelte.ts:231

---

statusBar

readonly statusBar: StatusBarManager

Defined in: context.svelte.ts:216

---

telemetry

telemetry: TelemetryService

Defined in: context.svelte.ts:239

---

urls

readonly urls: AppUrlService

Defined in: context.svelte.ts:217

---

vault

readonly vault: Vault

Defined in: context.svelte.ts:203

---

workspace

readonly workspace: Workspace

Defined in: context.svelte.ts:202

---

workspaceTrust

readonly workspaceTrust: WorkspaceTrustService

Defined in: context.svelte.ts:218

Accessors

internalPlugins

Get Signature

get internalPlugins(): object

Defined in: context.svelte.ts:249

Returns

object

getEnabledPluginById

getEnabledPluginById: (pluginId) => any

Parameters

pluginId

string

Returns

any

plugins

plugins: Record<string, { manifest: PluginManifest; }>

---

isDarkMode

Get Signature

get isDarkMode(): boolean

Defined in: context.svelte.ts:596

Returns

boolean

---

version

Get Signature

get version(): string

Defined in: context.svelte.ts:592

Returns

string

Methods

editorExtensions()

editorExtensions(viewType, context?): Extension[]

Defined in: context.svelte.ts:461

Parameters

viewType

string

context?

Record<string, any> = {}

Returns

Extension[]

---

emulateMobile()

emulateMobile(enable?): Promise<void>

Defined in: context.svelte.ts:618

Force mobile or desktop workspace layout and reload the app.

Intended for devtools/console use when testing mobile shell behavior on desktop viewports.

Parameters

enable?

boolean = true

When true or omitted, forces mobile layout; when false, forces desktop layout.

Returns

Promise<void>

---

loadLocalStorage()

loadLocalStorage(key): string | null

Defined in: context.svelte.ts:600

Parameters

key

string

Returns

string | null

---

openFile()

openFile(file, openState?): Promise<void>

Defined in: context.svelte.ts:414

Parameters

file

TFile

openState?

OpenViewState

Returns

Promise<void>

---

registerEditorExtension()

registerEditorExtension(extension, viewType?): void

Defined in: context.svelte.ts:489

Registers a CodeMirror 6 extension. To reconfigure cm6 extensions for a plugin on the fly, an array should be passed in, and modified dynamically. Once this array is modified, calling Workspace#updateOptions will apply the changes.

Parameters

extension

ExtType

Must be a CodeMirror 6 Extension, or an array of Extensions.

viewType?

string = "markdown"

Returns

void

---

registerEditorSuggest()

registerEditorSuggest(suggest, viewType?): void

Defined in: context.svelte.ts:508

Parameters

suggest

EditorSuggest<any>

viewType?

string = "markdown"

Returns

void

---

registerMarkdownCodeBlockProcessor()

registerMarkdownCodeBlockProcessor(language, postProcessor): void

Defined in: context.svelte.ts:542

Parameters

language

string

postProcessor

MarkdownPostProcessor

Returns

void

---

registerMarkdownDirectiveRenderer()

registerMarkdownDirectiveRenderer(directive, renderer): void

Defined in: context.svelte.ts:569

Parameters

directive

string

renderer

MarkdownDirectiveRenderer

Returns

void

---

registerMarkdownPostProcessor()

registerMarkdownPostProcessor(postProcessor): void

Defined in: context.svelte.ts:527

Parameters

postProcessor

MarkdownPostProcessor

Returns

void

---

registerMarkdownViewMenuItem()

registerMarkdownViewMenuItem(provider): void

Defined in: context.svelte.ts:584

Parameters

provider

MarkdownViewMenuItemProvider

Returns

void

---

saveLocalStorage()

saveLocalStorage(key, data): void

Defined in: context.svelte.ts:604

Parameters

key

string

data

string

Returns

void

---

setting()

setting(id): SettingGroup

Defined in: context.svelte.ts:628

Parameters

id

"options" | "core-plugins" | "community-plugins"

Returns

SettingGroup

---

setWorkspaceTrusted()

setWorkspaceTrusted(trusted): void

Defined in: context.svelte.ts:410

Parameters

trusted

boolean

Returns

void

---

unregisterEditorExtension()

unregisterEditorExtension(extension, viewType?): void

Defined in: context.svelte.ts:500

Parameters

extension

ExtType

viewType?

string = "markdown"

Returns

void

---

unregisterEditorSuggest()

unregisterEditorSuggest(suggest, viewType?): void

Defined in: context.svelte.ts:519

Parameters

suggest

EditorSuggest<any>

viewType?

string = "markdown"

Returns

void

---

unregisterMarkdownCodeBlockProcessor()

unregisterMarkdownCodeBlockProcessor(language, postProcessor): void

Defined in: context.svelte.ts:558

Parameters

language

string

postProcessor

MarkdownPostProcessor

Returns

void

---

unregisterMarkdownDirectiveRenderer()

unregisterMarkdownDirectiveRenderer(directive): void

Defined in: context.svelte.ts:579

Parameters

directive

string

Returns

void

---

unregisterMarkdownPostProcessor()

unregisterMarkdownPostProcessor(postProcessor): void

Defined in: context.svelte.ts:536

Parameters

postProcessor

MarkdownPostProcessor

Returns

void

---

unregisterMarkdownViewMenuItem()

unregisterMarkdownViewMenuItem(provider): void

Defined in: context.svelte.ts:588

Parameters

provider

MarkdownViewMenuItemProvider

Returns

void