Changelog

​

Workspace Changes

• Plugin#onUserEnable - Provides a place to perform one-time initialization after the user installs and enables your plugin. If your plugin has a custom view, this is a good place to initialize it rather than recreating the view in Plugin#onload.

• Workspace#ensureSideLeaf is now public. This function is a shorthand way to create a leaf in the sidebar if one does not already exist.

• Added WorkspaceLeaf#isDeferred and WorkspaceLeaf#loadIfDeferred
• As of Obsidian v1.7.2, Obsidian will now defer tabs by default
• See the guide on handling deferred views

​

Breaking Changes

// Old
let pq: PreparedQuery = prepareQuery(q);
...
fuzzySearch(pq, text);

// New
let fuzzy = prepareFuzzySearch(q);
...
fuzzy(text);

​

New Features

• Plugin#removeCommand - Dynamically remove commands (useful for user-created commands)
• SuggestModal#selectActiveSuggestion is now public - Useful for providing alternative hotkeys to your SuggestModal

• Fixed FileSystemAdapter#rmdir(dirPath, false) always throwing an error when attempting to delete an empty directory
• Added a data-type to the Markdown embed container using subpath type

​

Bug Fixes

• Fixed revealLeaf failing to focus the correct window

​

Breaking Changes

// Call setInstant(true) to restore old behavior
slider.setInstant(true);

// Check if function exists for backwards compatibility
if (slider.setInstant) {
  slider.setInstant(true);
}

​

External Settings Change Callback

​

New Vault Utility Functions

// Old way
const abstract = vault.getAbstractFileByPath(path);
if (abstract instanceof TFile) {
  // work with file
}

// New way
const file = vault.getFileByPath(path); // Returns TFile | null
const folder = vault.getFolderByPath(path); // Returns TFolder | null

​

View Scope Now Public

​

New Utilities

• getFrontMatterInfo - Canonical way to find the offsets of where the frontmatter ends and where the content starts in a file
• FileManager#getAvailablePathForAttachment - If your plugin saves attachments to the vault, use this to generate a safe path that respects the user’s settings for file attachments

​

New Components

• setTooltip - Helper function for setting tooltips on elements is now exposed
• Progress Bar Component - New progress bar component added

​

API Improvements

• FileManager#processFrontMatter now exposes the DataWriteOptions argument to be consistent with other process and write functions

​

Properties Support

​

Frontmatter Links

​

Canvas Spec Update

• As a hex string (e.g., "#FFFFFF")
• As a number "1", "2", etc.

​

Theme Changes

body {
  --callout-bug: var(--color-red-rgb);
  --callout-default: var(--color-blue-rgb);
  --callout-error: var(--color-red-rgb);
  --callout-example: var(--color-purple-rgb);
  --callout-fail: var(--color-red-rgb);
  --callout-important: var(--color-cyan-rgb);
  --callout-info: var(--color-blue-rgb);
  --callout-question: var(--color-yellow-rgb);
  --callout-success: var(--color-green-rgb);
  --callout-summary: var(--color-cyan-rgb);
  --callout-tip: var(--color-cyan-rgb);
  --callout-todo: var(--color-blue-rgb);
  --callout-warning: var(--color-orange-rgb);
  --callout-quote: 158, 158, 158;
}

​

Canvas Integration

• file-open event is now fired when focusing a Canvas file card
• Exposed activeEditor on the Workspace. When a markdown view is active, this will point to the underlying MarkdownEditView. If a canvas view is active, this will be an EmbeddedEditor component.

​

Migration Guide

// Old approach
let view = app.workspace.getActiveViewOfType(MarkdownView);
if (view) {
  let editor = view.editor;
  let file = view.file;
}

// New approach (works with Canvas)
let { activeEditor } = app.workspace;
if (activeEditor) {
  let editor = activeEditor.editor;
  let file = activeEditor.file;
}

​

New Metadata API

interface FileManager {
  /**
   * Atomically read, modify, and save the frontmatter of a note.
   * The frontmatter is passed in as a JS object, and should be mutated directly.
   * @param file - the file to be modified. Must be a markdown file.
   * @param fn - a callback function which mutates the frontMatter object synchronously.
   */
  processFrontMatter(file: TFile, fn: (frontMatter: any) => void): Promise<void>
}

app.fileManager.processFrontMatter(file, (frontmatter) => {
  frontmatter["key1"] = value;
  delete frontmatter["key2"];
});

​

Improvements

• setTooltip now accepts an optional tooltip position
• editorCallback no longer passes the active view: MarkdownView. Instead, it now provides either the MarkdownView or a MarkdownFileInfo object. This change allows for editor commands to work within a Canvas.
• registerHoverLinkSource is now available to register your plugin’s view with the Page preview core plugin

/* Override icon size */
.parent-element {
  --icon-size: var(--icon-xs);
}

/* Available sizes: --icon-xs, --icon-s, --icon-m, --icon-l */

​

Bug Fixes

• Fixed Editor.replaceSelection not working when run immediately after closing a modal

​

Notable Changes

• Added support for optional fundingUrl field in the plugin manifest. This is a link for users who want to donate to show appreciation and support plugin development.
• Added macOS calendar entitlements. This allows scripts run from within Obsidian to request calendar access.

​

New Components

• Added standard color picker component

​

Improvements

• getLeaf can now be used to create a leaf in a new tab, a new tab group, or a new window
• Preferred usage: getLeaf(Keymap.isModEvent(evt)) where evt is the user’s KeyboardEvent. This allows for a consistent user experience when opening files while a modifier key is pressed.

​

Notable Changes

• Added .has-active-menu class to file explorer item that received the right-click
• Added .list-bullet class to HTML markup for unordered list items