SearchBox | Theia TypeDoc

The search box widget.

Hierarchy

BaseWidget
- SearchBox

Index

Constructors

constructor

Accessors

Constructors

constructor

new SearchBox(props: SearchBoxProps, debounce: SearchBoxDebounce): SearchBox

Overrides BaseWidget.constructor
- Defined in packages/core/src/browser/tree/search-box.ts:70
Parameters
- props: SearchBoxProps
- debounce: SearchBoxDebounce
Returns SearchBox

Properties

Protected _isFiltering

_isFiltering: boolean = false

Protected Readonly closeEmitter

closeEmitter: Emitter<void> = ...

Protected Readonly debounce

debounce: SearchBoxDebounce

Protected Readonly filter

filter: undefined | HTMLElement

Protected Readonly filterToggleEmitter

filterToggleEmitter: Emitter<boolean> = ...

Protected Readonly input

input: HTMLSpanElement

Protected Readonly nextEmitter

nextEmitter: Emitter<void> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

Readonly onScrollUp

onScrollUp: Event<void> = ...

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

Protected Readonly previousEmitter

previousEmitter: Emitter<void> = ...

Protected Readonly props

props: SearchBoxProps

Protected Optional scrollBar

scrollBar?: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions?: Options

Protected Readonly textChangeEmitter

textChangeEmitter: Emitter<undefined | string> = ...

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Static Protected MAX_CONTENT_LENGTH

MAX_CONTENT_LENGTH: number = 15

Static Protected SPECIAL_KEYS

SPECIAL_KEYS: Key[] = ...

Accessors

isFiltering

get isFiltering(): boolean

- Defined in packages/core/src/browser/tree/search-box.ts:110
Returns boolean

keyCodePredicate

get keyCodePredicate(): KeyCode.Predicate

- Defined in packages/core/src/browser/tree/search-box.ts:114
Returns KeyCode.Predicate

onClose

get onClose(): Event<void>

- Defined in packages/core/src/browser/tree/search-box.ts:98
Returns Event<void>

onFilterToggled

get onFilterToggled(): Event<boolean>

- Defined in packages/core/src/browser/tree/search-box.ts:106
Returns Event<boolean>

onNext

get onNext(): Event<void>

- Defined in packages/core/src/browser/tree/search-box.ts:94
Returns Event<void>

onPrevious

get onPrevious(): Event<void>

- Defined in packages/core/src/browser/tree/search-box.ts:90
Returns Event<void>

onTextChange

get onTextChange(): Event<undefined | string>

- Defined in packages/core/src/browser/tree/search-box.ts:102
Returns Event<undefined | string>

Methods

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:215
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from BaseWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:204
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes, action: ((event: KeyboardEvent) => boolean | void | Object), ...additionalEventTypes: K[]): void

Inherited from BaseWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:208
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes
- action: ((event: KeyboardEvent) => boolean | void | Object)
  - - (event: KeyboardEvent): boolean | void | Object
    - Parameters
      - event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:197
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

Protected canHandle

canHandle(keyCode: undefined | KeyCode): boolean

- Defined in packages/core/src/browser/tree/search-box.ts:197
Parameters
- keyCode: undefined | KeyCode
Returns boolean

clearFlag

clearFlag(flag: Flag): void

Inherited from BaseWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:226
Parameters
- flag: Flag
Returns void

Protected createContent

createContent(): { close: undefined | HTMLElement; container: HTMLElement; filter: undefined | HTMLElement; input: HTMLSpanElement; next: undefined | HTMLElement; previous: undefined | HTMLElement }

- Defined in packages/core/src/browser/tree/search-box.ts:231
Returns { close: undefined | HTMLElement; container: HTMLElement; filter: undefined | HTMLElement; input: HTMLSpanElement; next: undefined | HTMLElement; previous: undefined | HTMLElement }
- close: undefined | HTMLElement
- container: HTMLElement
- filter: undefined | HTMLElement
- input: HTMLSpanElement
- next: undefined | HTMLElement
- previous: undefined | HTMLElement

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:179
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from BaseWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:122
Returns void

Protected doFireFilterToggle

doFireFilterToggle(toggleTo?: boolean): void

- Defined in packages/core/src/browser/tree/search-box.ts:138
Parameters
- toggleTo: boolean = !this._isFiltering
Returns void

Protected fireClose

fireClose(): void

- Defined in packages/core/src/browser/tree/search-box.ts:126
Returns void

Protected fireFilterToggle

fireFilterToggle(): void

- Defined in packages/core/src/browser/tree/search-box.ts:134
Returns void

Protected fireNext

fireNext(): void

- Defined in packages/core/src/browser/tree/search-box.ts:122
Returns void

Protected firePrevious

firePrevious(): void

- Defined in packages/core/src/browser/tree/search-box.ts:118
Returns void

Protected fireTextChange

fireTextChange(input: undefined | string): void

- Defined in packages/core/src/browser/tree/search-box.ts:130
Parameters
- input: undefined | string
Returns void

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/src/browser/widgets/widget.ts:175
Returns MaybePromise<HTMLElement>

Protected getTrimmedContent

getTrimmedContent(data: string): string

- Defined in packages/core/src/browser/tree/search-box.ts:190
Parameters
- data: string
Returns string

handle

handle(event: KeyboardEvent): void

- Defined in packages/core/src/browser/tree/search-box.ts:151
Parameters
- event: KeyboardEvent
Returns void

Protected handleArrowDown

handleArrowDown(): void

- Defined in packages/core/src/browser/tree/search-box.ts:168
Returns void

Protected handleArrowUp

handleArrowUp(): void

- Defined in packages/core/src/browser/tree/search-box.ts:164
Returns void

Protected handleKey

handleKey(keyCode: KeyCode): void

- Defined in packages/core/src/browser/tree/search-box.ts:179
Parameters
- keyCode: KeyCode
Returns void

Protected isCtrlBackspace

isCtrlBackspace(keyCode: KeyCode): boolean

- Defined in packages/core/src/browser/tree/search-box.ts:214
Parameters
- keyCode: KeyCode
Returns boolean

Protected onAfterAttach

onAfterAttach(msg: Message): void

Overrides BaseWidget.onAfterAttach
- Defined in packages/core/src/browser/tree/search-box.ts:308
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:142
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from BaseWidget.onBeforeAttach
- Defined in packages/core/src/browser/widgets/widget.ts:135
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:149
Parameters
- msg: Message
Returns void

onBeforeHide

onBeforeHide(): void

Overrides BaseWidget.onBeforeHide
- Defined in packages/core/src/browser/tree/search-box.ts:172
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:130
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Inherited from BaseWidget.onUpdateRequest
- Defined in packages/core/src/browser/widgets/widget.ts:190
Parameters
- msg: Message
Returns void

setFlag

setFlag(flag: Flag): void

Inherited from BaseWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:219
Parameters
- flag: Flag
Returns void

updateHighlightInfo

updateHighlightInfo(info: HighlightInfo): void

- Defined in packages/core/src/browser/tree/search-box.ts:221
Parameters
- info: HighlightInfo
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: SearchBoxProps

debounce: SearchBoxDebounce

Returns SearchBox

Properties

Protected _isFiltering

Protected Readonly closeEmitter

Protected Readonly debounce

Protected Readonly filter

Protected Readonly filterToggleEmitter

Protected Readonly input

Protected Readonly nextEmitter

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Readonly previousEmitter

Protected Readonly props

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly textChangeEmitter

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Static Protected MAX_CONTENT_LENGTH

Static Protected SPECIAL_KEYS

Accessors

isFiltering

Returns boolean

keyCodePredicate

Returns KeyCode.Predicate

onClose

Returns Event<void>

onFilterToggled

Returns Event<boolean>

onNext

Returns Event<void>

onPrevious

Returns Event<void>

onTextChange

Returns Event<undefined | string>

Methods

Protected addClipboardListener

Type Parameters

K extends "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes

action: ((event: KeyboardEvent) => boolean | void | Object)

Parameters

event: KeyboardEvent

Returns boolean | void | Object