Skip to content

OpenDemoVaultParams

Parameters for openDemoVault.

Import:

import type { OpenDemoVaultParams } from 'obsidian-dev-utils/obsidian/desktop-demo-vault-opener';

Signature:

export interface OpenDemoVaultParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
pluginIdstringThe plugin id, used to locate the GitHub repository, to name the archive asset, and to name the cached archive and the extracted vault folder.
pluginNamestringThe plugin display name, used to label the notices and the version-choice dialog.
pluginNoticeComponentPluginNoticeComponentThe notice component used to report progress and problems (plugin not in the registry, missing archive).
pluginVersionstringThe currently installed plugin version, offered as one of the version choices.

Links to this page: