README file from
GithubDataview Toggle
A minimal Obsidian plugin that lets you pause and resume Dataview's automatic refresh with one click or hotkey.
Why?
When editing notes with Dataview queries (especially daily notes with task queries), every keystroke triggers Dataview to re-render its blocks. This causes jank and interrupts your typing flow. This plugin adds a quick toggle so you can pause auto-refresh while writing and resume when you're done.
Usage
- Status bar: Click
DV: Auto/DV: Pausedin the bottom-right to toggle - Command palette: Search "Dataview Toggle: Toggle auto-refresh"
- Hotkey: Assign a hotkey in Settings > Hotkeys > search "Dataview Toggle"
When you resume, Dataview immediately refreshes all views to catch up.
Per-note override
You can override the global setting for individual notes by adding a dataview-refresh property to the note's frontmatter:
---
dataview-refresh: false
---
Setting the property to false pauses auto-refresh whenever that note is open, regardless of the global setting. Setting it to true forces auto-refresh on, even when the global setting is paused. Omitting the property entirely means the note follows the global setting.
The override is temporary. When you navigate away from the note, the global setting is restored. If you manually toggle while on an overriding note, that becomes the new global setting and the note's override is cleared for that visit.
Requirements
- Dataview plugin must be installed and enabled
Installation
Via BRAT (beta)
- Install BRAT from Community Plugins
- Open the command palette and run
BRAT: Add a beta plugin for testing - Enter
p1tt1/obsidian-dataview-toggle - Click "Add Plugin", then enable the plugin in Settings > Community plugins
From Community Plugins (once published)
- Open Settings > Community plugins > Browse
- Search "Dataview Toggle"
- Install and enable
Manual
- Download
main.js,manifest.json, andstyles.cssfrom the latest release - Create a folder
dataview-togglein your vault's.obsidian/plugins/directory - Copy the downloaded files into that folder
- Enable the plugin in Settings > Community plugins