Class: SearchState

PSPDFKit.SearchState

The current state of the search indicators inside the web view.

You can update the search state using PSPDFKit.Instance#setSearchState.

Extends

  • Immutable.Record

Members



Members

focusedResultIndex: number

The currently focused result. -1 if no item is focused yet.

Type:
  • number
Default Value:
  • -1

isFocused: boolean

Indicates that the search input has focus.

Type:
  • boolean

isLoading: boolean

Indicates that we're currently loading search requests.

Type:
  • boolean

(readonly) minSearchQueryLength: number

Current minimum search query length. When using the UI or the API function PSPDFKit.Instance#search, any query shorter than this number will not be performed.

In Server mode, this value is retrieved from the server at load time.

The default value is 1 (not configurable) in Standalone mode, and 3 in Server mode (configurable in the server).

Type:
  • number

The latest search results. These will be rendered as highlights in the page view.

Type:

term: string

The current search term. Changing this term will not start a search. Please use PSPDFKit.Instance#startUISearch for that purpose.

Type:
  • string