PreferencesSearchbarWidget

Hierarchy

ReactWidget
- PreferencesSearchbarWidget

Implements

StatefulWidget

Index

Constructors

constructor

Constructors

constructor

new PreferencesSearchbarWidget(options?: IOptions): PreferencesSearchbarWidget

Inherited from ReactWidget.constructor
- Defined in packages/core/lib/browser/widgets/react-widget.d.ts:21
Parameters
- Optional options: IOptions
Returns PreferencesSearchbarWidget

Properties

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onFilterChanged

onFilterChanged: Event<string> = ...

Protected Readonly onFilterStringChangedEmitter

onFilterStringChangedEmitter: Emitter<string> = ...

Protected Readonly onRender

onRender: DisposableCollection

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected resultsCount

resultsCount: number = 0

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected search

search: DebouncedFunc<(value: string) => void> = ...

Protected searchbarRef

searchbarRef: RefObject<HTMLInputElement> = ...

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Static Readonly ID

ID: "settings.header" = 'settings.header'

Static Readonly LABEL

LABEL: "Settings Header" = 'Settings Header'

Static Readonly SEARCHBAR_ID

SEARCHBAR_ID: "preference-searchbar" = 'preference-searchbar'

Methods

Protected addClipboardListener

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

Inherited from ReactWidget.addClipboardListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:83
Type parameters
- K: "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 ReactWidget.addEventListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:81
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

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

Inherited from ReactWidget.addKeyListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:82
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
- 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 ReactWidget.addUpdateListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:80
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

clearFlag

clearFlag(flag: Flag): void

Inherited from ReactWidget.clearFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:85
Parameters
- flag: Flag
Returns void

Protected clearSearchResults

clearSearchResults(e: MouseEvent<Element, MouseEvent>): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:67
Clears the search input and all search results.

Parameters
- e: MouseEvent<Element, MouseEvent>
  
  on-click mouse event.
Returns void

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from ReactWidget.disableScrollBarFocus
- Defined in packages/core/lib/browser/widgets/widget.d.ts:78
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from ReactWidget.dispose
- Defined in packages/core/lib/browser/widgets/widget.d.ts:71
Returns void

focus

focus(): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:57
Returns void

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from ReactWidget.getScrollContainer
- Defined in packages/core/lib/browser/widgets/widget.d.ts:77
Returns MaybePromise<HTMLElement>

Protected getSearchTerm

getSearchTerm(): string

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:125
Returns string

Protected handleSearch

handleSearch(e: ChangeEvent<HTMLInputElement>): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:48
Parameters
- e: ChangeEvent<HTMLInputElement>
Returns void

Protected init

init(): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:41
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Inherited from ReactWidget.onAfterAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:76
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from ReactWidget.onAfterDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:74
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from ReactWidget.onBeforeAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:73
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from ReactWidget.onBeforeDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:75
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from ReactWidget.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Inherited from ReactWidget.onUpdateRequest
- Defined in packages/core/lib/browser/widgets/react-widget.d.ts:23
Parameters
- msg: Message
Returns void

render

render(): ReactNode

Overrides ReactWidget.render
- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:140
Returns ReactNode

Protected renderClearAllOption

renderClearAllOption(): ReactNode

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:109
Renders a clear all button.

Returns ReactNode

Protected renderOptionContainer

renderOptionContainer(): ReactNode

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:79
Renders all search bar options.

Returns ReactNode

Protected renderResultsCountOption

renderResultsCountOption(): ReactNode

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:88
Renders a badge displaying search results count.

Returns ReactNode

restoreState

restoreState(oldState: PreferencesSearchbarState): void

Implementation of StatefulWidget.restoreState
- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:175
Parameters
- oldState: PreferencesSearchbarState
Returns void

Protected searchTermExists

searchTermExists(): boolean

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:121
Determines whether the search input currently has a value.

Returns boolean

true, if the search input currently has a value; false, otherwise.

setFlag

setFlag(flag: Flag): void

Inherited from ReactWidget.setFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:84
Parameters
- flag: Flag
Returns void

storeState

storeState(): PreferencesSearchbarState

Implementation of StatefulWidget.storeState
- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:169
Returns PreferencesSearchbarState

updateResultsCount

updateResultsCount(count: number): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:164
Updates the search result count.

Parameters
- count: number
  
  the result count.
Returns void

updateSearchTerm

updateSearchTerm(searchTerm: string): void

- Defined in packages/preferences/src/browser/views/preference-searchbar-widget.tsx:130
Parameters
- searchTerm: string
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: IOptions

Returns PreferencesSearchbarWidget

Properties

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onFilterChanged

Protected Readonly onFilterStringChangedEmitter

Protected Readonly onRender

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected resultsCount

Protected Optional scrollBar

Protected Optional scrollOptions

Protected search

Protected searchbarRef

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Static Readonly ID

Static Readonly LABEL

Static Readonly SEARCHBAR_ID

Methods

Protected addClipboardListener

Type parameters

K: "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type parameters

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type parameters

Parameters

element: HTMLElement

keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]

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

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void

Protected addUpdateListener

Type parameters

Parameters

element: HTMLElement

type: K

Optional useCapture: boolean

Returns void

clearFlag

Parameters

flag: Flag

Returns void

Protected clearSearchResults

Parameters

e: MouseEvent<Element, MouseEvent>

Returns void

Protected disableScrollBarFocus

Parameters

scrollContainer: HTMLElement

Returns void