@openfin/search-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Information about a search provider.

Hierarchy

Index

Properties

Properties

Optional commandCode

commandCode: string

A keycode that can be used to interact with this Search Provider.

Optional description

description: string

A short description of the Search Provider.

Optional hint

hint: string

A breadcrumb that a UI could display.

Optional icon

icon: string

An icon that a UI can display for the Search Provider.

Optional identity

identity: Identity

The OpenFin identity that registered this search provider.

Optional inputPlaceholder

inputPlaceholder: string

The placeholder string to be displayed in a UI when targeting this specific Search Provider.

name

name: string

A unique ID used to identify the search provider.

Optional scoreOrder

scoreOrder: ScoreOrder

The order to sort the score in. The default is ascending.

experimental

title

title: string

A UI friendly title for the search provider.

Legend

  • Property
  • Method

Generated using TypeDoc