AbstractSearchComponent

Unofficial

Both Official Unofficial

Both Own Inherited

Base interface for search components providing find-and-replace UI.

Import:

import type { AbstractSearchComponent } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface AbstractSearchComponent

Properties

	Property	Type	Description
	app	App	Reference to the app.
	containerEl	HTMLElement	The container element in which the search component exists (i.e. obsidian#Editor).
	replaceInputEl	HTMLInputElement	Container for the replacement input field.
	scope	Scope	Keyscope for search component.
	searchButtonContainerEl	HTMLElement	Container for all the action buttons.
	searchContainerEl	HTMLElement	Container for the search component itself.
	searchInputEl	HTMLInputElement	Container for the search input field.

Methods

	Method	Returns	Description
	getQuery()	string	Returns the current search query.
	goToNextInput(event)	unknown	Switch to the next inputElement.
	onEnter(event)	unknown	Invokes findNextOrReplace.
	onShiftEnter(event)	unknown	Invokes findPrevious.

---

Links to this page:

• EditorSearchComponent