Interface IDisplayState

React search component state

interface IDisplayState {
    caseSensitive: boolean;
    currentIndex: null | number;
    errorMessage: string;
    filters: IFilters;
    filtersOpen: boolean;
    forceFocus: boolean;
    query: null | RegExp;
    replaceEntryVisible: boolean;
    replaceInputFocused: boolean;
    replaceText: string;
    searchInputFocused: boolean;
    searchText: string;
    totalMatches: number;
    useRegex: boolean;
}

Properties

caseSensitive currentIndex errorMessage filters filtersOpen forceFocus query replaceEntryVisible replaceInputFocused replaceText searchInputFocused searchText totalMatches useRegex

Properties

caseSensitive

caseSensitive: boolean

Should the search be case sensitive?

currentIndex

currentIndex: null | number

The index of the currently selected match

errorMessage

errorMessage: string

An error message (used for bad regex syntax)

filters

filters: IFilters

What should we include when we search?

filtersOpen

filtersOpen: boolean

Is the filters view open?

forceFocus

forceFocus: boolean

Should the focus forced into the input on the next render?

query

query: null | RegExp

The query constructed from the text and the case/regex flags

replaceEntryVisible

replaceEntryVisible: boolean

Whether or not the replace entry row is visible

replaceInputFocused

replaceInputFocused: boolean

Whether or not the replace input is currently focused

replaceText

replaceText: string

The text in the replace entry

searchInputFocused

searchInputFocused: boolean

Whether or not the search input is currently focused

searchText

searchText: string

The text in the search entry

totalMatches

totalMatches: number

The total number of matches found in the document

useRegex

useRegex: boolean

Should the search string be treated as a RegExp?

Settings

Member Visibility

Theme

On This Page

caseSensitivecurrentIndexerrorMessagefiltersfiltersOpenforceFocusqueryreplaceEntryVisiblereplaceInputFocusedreplaceTextsearchInputFocusedsearchTexttotalMatchesuseRegex