Interface IPopulateOmniboxObject

The IPopulateOmniboxObject is an interface that is used by components to interact with the Omnibox and provides a framework for type-ahead suggestions.

Index

Methods

Properties

Methods

clear

  • clear(): void

clearCurrentExpression

  • clearCurrentExpression(): void

closeOmnibox

  • closeOmnibox(): void

insertAt

  • insertAt(at: number, toInsert: string): void

replace

  • replace(searchValue: string, newValue: string): void

  • Replaces the specified searchValue by the newValue in the Omnibox.

    Parameters

    • searchValue: string
    • newValue: string

    Returns void

replaceCurrentExpression

  • replaceCurrentExpression(newValue: string): void

  • Replaces the current expression in the QueryBox (the current cursor position in the omnibox) by the newValue.

    Parameters

    • newValue: string

    Returns void

Properties

allQueryExpressions

allQueryExpressions: IPopulateOmniboxQueryExpression[]

An array IPopulateOmniboxQueryExpression used to describe each part of the content of the Omnibox component.

completeQueryExpression

completeQueryExpression: IPopulateOmniboxQueryExpression

A IPopulateOmniboxQueryExpression object used to describe the complete content of the Querybox component.

currentQueryExpression

currentQueryExpression: IPopulateOmniboxQueryExpression

A IPopulateOmniboxQueryExpression object used to describe the current active content (the current position of the cursor/caret) of the Omnibox component.

cursorPosition

cursorPosition: number

The number representing the current position of the cursor/caret inside the Omnibox component.

Hierarchy

  • IPopulateOmniboxObject