search/com.monkopedia.kodemirror.search

Package-level declarations

Types

HighlightSelectionMatchConfig

data class HighlightSelectionMatchConfig(val minSelectionLength: Int = 1, val maxMatches: Int = 100, val wholeWords: Boolean = false)

Configuration for selection match highlighting.

class RegExpCursor(text: Text, query: String, options: Set<RegexOption> = emptySet(), from: DocPos = DocPos.ZERO, to: DocPos = text.endPos) : Iterator<SearchMatch>

A cursor that iterates over regex matches in a Text document.

class SearchCursor(text: Text, query: String, from: DocPos = DocPos.ZERO, to: DocPos = text.endPos, normalize: (String) -> String = { it }) : Iterator<SearchMatch>

A cursor that iterates over string matches in a Text document.

data class SearchMatch(val from: DocPos, val to: DocPos)

A match found by a search cursor.

data class SearchQuery(val search: String = "", val caseSensitive: Boolean = false, val literal: Boolean = false, val regexp: Boolean = false, val replace: String = "", val wholeWord: Boolean = false, val test: (from: DocPos, to: DocPos, state: EditorState) -> Boolean? = null)

Represents a search query with options for how to match.

Properties

closeSearchPanel

val closeSearchPanel: (EditorSession) -> Boolean

Close the search panel.

val findNext: (EditorSession) -> Boolean

Move the selection to the next match.

val findPrevious: (EditorSession) -> Boolean

Move the selection to the previous match.

val gotoLine: (EditorSession) -> Boolean

Command that opens the go-to-line dialog.

openSearchPanel

val openSearchPanel: (EditorSession) -> Boolean

Open the search panel. Lazily installs the search extension if needed.

val replaceAll: (EditorSession) -> Boolean

Replace all matches in the document.

val replaceNext: (EditorSession) -> Boolean

Replace the current match (if any) and move to the next one.

val searchKeymap: List<KeyBinding>

Default search keymap bindings.

searchPanelOpenField

val searchPanelOpenField: StateField<Boolean>

State field tracking whether the search panel is open.

searchQueryField

val searchQueryField: StateField<SearchQuery>

State field tracking the current search query.

val selectMatches: (EditorSession) -> Boolean

Select all matches as a multi-selection.

selectSelectionMatches

val selectSelectionMatches: (EditorSession) -> Boolean

Select all instances of the currently selected text.

val setSearchQuery: StateEffectType<SearchQuery>

Effect to set the current search query.

toggleSearchPanel

val toggleSearchPanel: StateEffectType<Boolean>

Effect to toggle the search panel open/closed.

Functions

fun getSearchQuery(state: EditorState): SearchQuery

Get the current search query from an editor state.

highlightSelectionMatches

fun highlightSelectionMatches(config: HighlightSelectionMatchConfig = HighlightSelectionMatchConfig()): Extension

Extension that highlights all occurrences of the currently selected text.

fun search(panelModifier: BoxScope.() -> Modifier? = null): Extension

Create an extension that provides search functionality.

searchPanelOpen

fun searchPanelOpen(state: EditorState): Boolean

Whether the search panel is currently open.