Interface FindReplace

interface FindReplace {
    activeIndex: number;
    element: HTMLElement;
    isOpen: boolean;
    matches: readonly SearchMatch[];
    close(): void;
    destroy(): void;
    findNext(): void;
    findPrevious(): void;
    open(): void;
    replaceAllMatches(replacement: string): number;
    replaceCurrent(replacement: string): boolean;
    search(query: FindReplaceQuery): FindReplaceResult;
}

Index

Properties

activeIndex element isOpen matches

Methods

close destroy findNext findPrevious open replaceAllMatches replaceCurrent search

Properties

`Readonly`activeIndex

activeIndex: number

Index of the highlighted match, or -1 when there is none.

`Readonly`element

element: HTMLElement

`Readonly`isOpen

isOpen: boolean

`Readonly`matches

matches: readonly SearchMatch[]

Methods

close

close(): void
Hide the bar and clear its highlights.

Returns void
- Defined in find-replace.ts:56

destroy

destroy(): void
Returns void
- Defined in find-replace.ts:68

findNext

findNext(): void
Returns void
- Defined in find-replace.ts:62

findPrevious

findPrevious(): void
Returns void
- Defined in find-replace.ts:63

open

open(): void
Show the bar and focus the query field.

Returns void
- Defined in find-replace.ts:54

replaceAllMatches

replaceAllMatches(replacement: string): number
Replace every match. Returns how many were replaced.
Parameters
- replacement: string
Returns number
- Defined in find-replace.ts:67

replaceCurrent

replaceCurrent(replacement: string): boolean
Replace the active match. Returns true when the document changed.
Parameters
- replacement: string
Returns boolean
- Defined in find-replace.ts:65

search

search(query: FindReplaceQuery): FindReplaceResult
Run a search without touching the inputs, the programmatic entry point.
Parameters
- query: FindReplaceQuery
Returns FindReplaceResult
- Defined in find-replace.ts:58