correct usage of SearchResult and SearchMatches needs clarification
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start with the SearchResult, SearchMatches, and renderResults documentation pages linked in the issue, and trace how their capabilities and usage should be explained for a vault-search plugin. Done means the pages clearly show how to use the native search components to return and render results without recreating the functionality.
Written by the indexing model from the issue text.
Description
I am trying to build a plugin that performs a search on the user's vault and returns search results. I want to use native obsidian components for this as much as possible, and I see that there are typescript componts that seem to be designed for this. However after spending many hours in the docs it is not clear to me how to use the Search related typescript API classes and interfaces properly.
The documentation should be improved to clarify the capabilities and usage of Search related components and functions. Without this, the only practical option is to recreate the functionality from scratch in Svelte or React or plain javascript.
Related docs pages:
https://docs.obsidian.md/Reference/TypeScript+API/SearchResult
https://docs.obsidian.md/Reference/TypeScript+API/SearchMatches
https://docs.obsidian.md/Reference/TypeScript+API/renderResults
- Dominant language
- JavaScript
- Stars
- 532
- Forks
- 173
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from obsidianmd/obsidian-developer-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
obsidianmd/obsidian-developer-docs#265 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
obsidianmd/obsidian-developer-docs#262 · 1 comment ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
obsidianmd/obsidian-developer-docs#252 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
obsidianmd/obsidian-developer-docs#242 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in obsidianmd/obsidian-developer-docs
Similar issues
-
Add: &TV LogoOpencheck:passed logos:add
Difficulty 1/5 Under an hour Newbie friendliness 74/100
-
BUG: Appointment time renders blank and PM appointment slots miscalculate vertical position in CalendarScreenPossibly taken @aryanpatil-07 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
AOSSIE-Org/BabyNest#297 · 1 comment ·
Maintainers usually reply within 1 day
-
Onboarding form: instructor radio never pre-selected "Yes" (permission vs permissions typo)Possibly taken @ThakuraAnki claimed this today. Openbug
Difficulty 1/5 Under an hour Newbie friendliness 72/100
WikiEducationFoundation/WikiEduDashboard#7235 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
Component: Frontend Component: Web Component Type: Maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
it-at-m/refarch-templates#1944 ·
Maintainers usually reply within 2 days