Obsidian-quick-preview NPM

Obsidian Quick Preview

This Obsidian.md plugin adds a quick preview functionality to

Hold down Alt/Option (by default) to quickly preview a suggestion before actually selecting it.

Link suggestions (file/heading/block)

Screen Recording 2023-12-13 at 18 27 42

Quick switcher / Quick switcher++

Screen Recording 2023-12-13 at 18 24 34

!tip
You can adjust the font size for quick preview via Style Settings.
Other plugins also can utilize the quick preview feature via the API. See below for more details.

Installation

You can find this plugin in the community plugin browser within Obsidian.

You can also install the latest beta release using BRAT:

Install BRAT and enable it.
Go to Options. In the Beta Plugin List section, click on the Add Beta plugin button.
Copy and paste RyotaUshio/obsidian-quick-preview in the pop-up prompt and click on Add Plugin.
(Optional but highly recommended) Turn on Auto-update plugins at startup at the top of the page.
Go to Community plugins > Installed plugins. You will find “Quick Preview” in the list. Click on the toggle button to enable it.

Using the API

This plugin provides an API to allow other plugins to add the quick preview functionality to their custom suggesters. Supported suggester types are:

SuggestModal
PopoverSuggest, including:
- EditorSuggest
- AbstractInputSuggest

Installation

npm install -D obsidian-quick-preview

Usage examples

import { Plugin, EditorSuggest, SuggestModal, TFile, SectionCache } from "obsidian";
import { registerQuickPreview } from "obsidian-quick-preview";

class MyCustomEditorSuggest extends EditorSuggest<{ file: TFile }> { ... }

class MyCustomSuggestModal extends SuggestModal<{ path: string, cache: SectionCache }> { ... }

export default MyPlugin extends Plugin {
    excludedFiles: string[];

    onload() {
        registerQuickPreview(this.app, this, MyCustomEditorSuggest, (item) => {
            // - `linktext` can be any string representing a proper internal link,
            //   e.g. "note", "note.md", "folder/note", "folder/note.md", "note#heading", "note#^block-id" etc
            // - `sourcePath` is used to resolve relative links. In many cases, you can just pass an empty string.
            return { linktext: item.file.path, sourcePath: "" };
        });
        // or
        registerQuickPreview(this.app, this, MyCustomSuggestModal, (item) => {
            if (this.excludedFiles.contains(item.path)) {
                // Return `null` when you don't want to show a quick preview for the item.
                return null;
            }
            // Add a `line` parameter to focus on a specific line.
            return { linktext: item.path, sourcePath: "", line: item.cache.position.start.line };
        });
    }
}