Ability to Create Dynamic Search Query Blocks Using JS Engine

Open
#25 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
tooling

Research direction

Start with the engine.markdown.create and engine.markdown.createBuilder entry points shown in the examples, then compare their output with a native query block in Obsidian reading mode. Done means dynamically generated file:button content renders search results rather than plain text, including when the value is updated through the proposed Meta Bind textarea integration.

Written by the indexing model from the issue text.

Description

Hi @mProjectsCode,

First of all, thanks for creating this amazing plugin! It's been a great addition to my Obsidian setup.

I wanted to ask if it's possible to dynamically generate native search query blocks using the js-engine plugin. I've been exploring different ways to use the plugin and found that generating JavaScript code blocks works perfectly. However, I'm struggling to create dynamic search query blocks that work in the same way.

Here's what I've tried so far:

let searchQuery = `~~~query
file:button
~~~`;
return engine.markdown.create(searchQuery);

And another attempt:

let markdownBuilder = engine.markdown.createBuilder();
let searchQuery = `file:button`;
markdownBuilder.createCodeBlock('query', searchQuery);
return markdownBuilder;

Unfortunately, neither of these attempts seems to render the search query block correctly in Obsidian.

The output is:

file:button

Instead of the search query result I would get using:

```query
file:button
```

However, this approach does work perfectly for JavaScript code blocks:

let jsCode = `~~~js
var foo = 'bar';
~~~`;
return engine.markdown.create(jsCode);

Or

let markdownBuilder = engine.markdown.createBuilder();
let jsCode = `var foo = 'bar';`;
markdownBuilder.createCodeBlock('js', jsCode);
return markdownBuilder;

I'm aware of the workaround using DataView or DataViewJS for similar tasks, but I'd prefer to use the native search query blocks directly if possible. My ultimate goal is to integrate this with a textarea using the Meta Bind Plugin, so that in reading mode, I can dynamically update and view search results in real-time.

Could you please let me know if it's possible to achieve this using the js-engine plugin? If not, any suggestions or workarounds would be greatly appreciated!

Thanks again for your work on this plugin!

Best regards,
CharlesHaanel

Dominant language
TypeScript
Stars
191
Forks
15
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mProjectsCode/obsidian-js-engine-plugin

All issues in mProjectsCode/obsidian-js-engine-plugin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.