SearchProvider | @jupyterlab (original) (raw)

Type Parameters

• T extends Widget = Widget

Hierarchy (View Summary)

• SearchProvider
  • GenericSearchProvider
  • NotebookSearchProvider

Implements

• ISearchProvider

Index

Constructors

constructor

• new SearchProvider<T extends Widget = Widget>(widget: T): SearchProvider<T>

• Type Parameters

  • T extends Widget = Widget

Returns SearchProvider<T>

Properties

Protected_filtersChanged

Protected_stateChanged

Protectedwidget

widget: T

Accessors

currentMatchIndex

• get currentMatchIndex(): null | number

• Returns null | number

filtersChanged

• get filtersChanged(): ISignal<this, void>

• Returns ISignal<this, void>

isDisposed

• get isDisposed(): boolean

• Returns boolean

AbstractisReadOnly

• get isReadOnly(): boolean

• Returns boolean

matchesCount

• get matchesCount(): null | number

• Returns null | number

stateChanged

• get stateChanged(): ISignal<this, void>

• Returns ISignal<this, void>

Methods

AbstractclearHighlight

• clearHighlight(): Promise<void>

• Returns Promise<void>

dispose

• dispose(): void

• Returns void

AbstractendQuery

• endQuery(): Promise<void>

• Returns Promise<void>

getFilters

• getFilters(): { [key: string]: IFilter }

• Returns { [key: string]: IFilter }

The filters.

Notes

TODO For now it only supports boolean filters (represented with checkboxes)

getInitialQuery

• getInitialQuery(): string

• Returns string

Initial value used to populate the search box.

AbstracthighlightNext

• highlightNext(): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The next match if available

AbstracthighlightPrevious

• highlightPrevious(): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The previous match if available.

AbstractreplaceAllMatches

• replaceAllMatches(newText: string, options?: IReplaceOptions): Promise<boolean>

• Returns Promise<boolean>

A promise that resolves with a boolean indicating whether a replace occurred.

AbstractreplaceCurrentMatch

• replaceCurrentMatch(
  newText: string,
  loop?: boolean,
  options?: IReplaceOptions,
  ): Promise<boolean>

• Parameters

  • newText: string
  • Optionalloop: boolean
  • Optionaloptions: IReplaceOptions

Returns Promise<boolean>

A promise that resolves with a boolean indicating whether a replace occurred.

AbstractstartQuery

• startQuery(query: RegExp, filters: IFilters): Promise<void>

• Returns Promise<void>

StaticpreserveCase

• preserveCase(oldText: string, newText: string): string

• Parameters

  • oldText: string
  • newText: string

Returns string