Query Control

approved

by yuanzhixiang

Forked from reply2za/obsidian-query-control

An experimental Obsidian plugin that adds additional control to queries - This plugin has not been manually reviewed by Obsidian staff.

1 stars249 downloadsUpdated 1mo agoMIT

Obsidian Query Control (v1.7.0+)

Note: Updated to work with Obsidian v1.7.0+.

This plugin adds additional functionality to Obsidian's search/query feature. The current version will add a control bar to each embedded query with various actions such as: collapse all, show context, sort, hide title, hide results, render markdown, and copy results.

Controls are added to embedded queries in Live Preview and Reading modes.

Each of the controls have defaults which can be defined in the plugin settings tab. So, if you wanted all embedded queries to render collapsed by default, you would go into the settings and change that default.

If you want to configure the controls on a per embedded query basis, this plugin implements an extended query syntax which allows for this. The full syntax looks like this:

```query
path: foo tag:#obsidian
title: custom query name
collapsed: true | false
context: true | false
hideTitle: true | false
hideResults: true | false
renderMarkdown: true | false
sort: alphabetical | alphabeticalReverse | byModifiedTime | byModifiedTimeReverse | byCreatedTime | byCreatedTimeReverse
```

Each of the extended keys are optional. If a key is not provided, the configured default will be used instead.

Demo

embedded-query-control

Installing via BRAT

Install the BRAT plugin via the Obsidian Plugin Browser and then add the beta repository "reply2za/obsidian-query-control"

Manually installing the plugin

  • Copy over main.js, manifest.json to your vault VaultFolder/.obsidian/plugins/query-control/.

Developing and testing in Obsidian

  • Put this repository directly under VaultFolder/.obsidian/plugins/query-control/.
  • Run pnpm install.
  • Run pnpm dev to watch and rebuild main.js in place whenever you change src/*.ts.
  • In Obsidian, reload the app or disable and re-enable the plugin after each rebuild.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.