Interface UI

The UI aptitude gives access to the Olive helps search bar

Hierarchy

UI

Index

Methods

Methods

listenGlobalSearch

listenGlobalSearch(cb: (val: string) => void): Promise<Cancellable>

- Defined in ui/index.ts:20
Creates a stream receiving updates whenever the user enters a search in the Olive Helps Global Search.

Parameters
- cb: (val: string) => void
  
  The callback function called when an update to the global searchbar occurs.
  - - (val: string): void
    - Parameters
      - val: string
      Returns void
Returns Promise<Cancellable>

listenSearchbar

listenSearchbar(cb: (val: string) => void): Promise<Cancellable>

- Defined in ui/index.ts:13
Creates a stream receiving updates whenever the user enters a search in the Olive Helps Searchbar.

Parameters
- cb: (val: string) => void
  
  The callback function called when an update to the searchbar occurs.
  - - (val: string): void
    - Parameters
      - val: string
      Returns void
Returns Promise<Cancellable>

loopOpenHandler

loopOpenHandler(callback: () => void): void

- Defined in ui/index.ts:27
Registers a handler function for the Olive Helps Loop Open Button

Parameters
- callback: () => void
  
  Function called when Loop Open Button is pressed in Olive Helps
  - - (): void
    - Returns void
Returns void

Generated using TypeDoc