chrome.omnibox

Description

多功能框 API 允许您使用 Google Chrome 的地址栏（也称为多功能框）注册关键字。

Manifest Keys

必须在清单中声明以下键才能使用此 API。 omnibox

51

当用户输入您的扩展程序的关键字时，用户开始仅与您的扩展程序交互。每次击键都会发送到您的扩展程序，您可以提供建议作为回应。

这些建议可以通过多种方式进行丰富的格式化。当用户接受建议时，您的扩展程序会收到通知并可以采取行动。

# Manifest

您必须在清单中包含一个多功能框omnibox关键字keyword字段才能使用多功能框 API。您还应该指定一个 16x16 像素的图标，该图标会在建议用户进入关键字模式时显示在地址栏中。

例如：

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": {
    "16": "16-full-color.png"
  },
  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  }
}

注意：Chrome 会自动创建 16x16 像素图标的灰度版本。您应该提供全彩色版本，以便它也可以用于其他需要颜色的情况。例如，上下文菜单 API（context menus API） 也使用 16x16 像素的图标，但它以彩色显示。

# Examples

您可以在示例页面上找到此 API 的示例sample page。

Summary

Types

DefaultSuggestResult

一个建议的结果。

PROPERTIES

  • description

    string

    显示在 URL 下拉列表中的文本。可以包含用于样式的 XML 样式标记。支持的标签是“url”（用于文字 URL）、“match”（用于突出显示与用户查询匹配的文本）和“dim”（用于暗淡的帮助文本）。样式可以嵌套，例如。昏暗的比赛。

DescriptionStyleType

Chrome 44+

样式类型。

TYPE

"url", "match", or "dim"

OnInputEnteredDisposition

Chrome 44+

多功能框查询的窗口配置。这是显示结果的推荐上下文。例如，如果多功能框命令要导航到某个 URL，则“newForegroundTab”的处置意味着导航应在新的选定选项卡中进行。

TYPE

"currentTab", "newForegroundTab", or "newBackgroundTab"

SuggestResult

一个建议的结果。

PROPERTIES

  • content

    string

    放入 URL 栏中的文本，并在用户选择此条目时发送到扩展程序。

  • deletable

    boolean optional

    Chrome 63+

    用户是否可以删除建议结果。

  • description

    string

    显示在 URL 下拉列表中的文本。可以包含用于样式的 XML 样式标记。支持的标签是“url”（用于文字 URL）、“match”（用于突出显示与用户查询匹配的文本）和“dim”（用于暗淡的帮助文本）。样式可以嵌套，例如。昏暗的比赛。您必须转义五个预定义实体以将它们显示为文本：stackoverflow.com/a/1091953/89484

Methods

setDefaultSuggestion

chrome.omnibox.setDefaultSuggestion( suggestion: DefaultSuggestResult, )

设置默认建议的描述和样式。默认建议是显示在 URL 栏下方第一个建议行中的文本。

PARAMETERS

Events

onDeleteSuggestion 

chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

Chrome 63+

用户已删除建议的结果。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    (text: string) => void

    • text

      string

onInputCancelled 

chrome.omnibox.onInputCancelled.addListener(
  callback: function,
)

用户在没有接受输入的情况下结束了关键字输入会话。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    () => void

onInputChanged 

chrome.omnibox.onInputChanged.addListener(
  callback: function,
)

用户已更改输入到多功能框中的内容。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    (text: string, suggest: function) => void

    • text

      string

    • suggest

      function

      The suggest parameter looks like:

      (suggestResults: SuggestResult[]) => void

onInputEntered 

chrome.omnibox.onInputEntered.addListener(
  callback: function,
)

用户已接受输入到多功能框中的内容。

PARAMETERS

onInputStarted 

chrome.omnibox.onInputStarted.addListener(
  callback: function,
)

用户已通过键入扩展程序的关键字开始关键字输入会话。这保证在每个输入会话中只发送一次，并且在任何 onInputChanged 事件之前发送。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    () => void

By.一粒技术服务

results matching ""

    No results matching ""