Omnibox入力への応答
Omniboxからのユーザー入力を処理し、候補を提示するとともに、入力されたテキストに基づいてカスタムロジックを実行します。
「Omnibox入力への応答」はCoddyKit上の無料Browser Extensions Development (Chrome & Edge)レッスンです。 これはレッスン3/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはBrowser Extensions Development (Chrome & Edge)学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Browser Extensions Development (Chrome & Edge)コースには全4レッスンが含まれています。
このレッスンの一部はまだ翻訳されておらず、英語で表示されています。
Responding to Omnibox Input
Welcome to the lesson on making your extension smart! We've learned how to set up an omnibox keyword. Now, let's make it respond to user input.
The omnibox (address bar) is a powerful place. Your extension can listen for what users type after your keyword and react in two main ways:
- Provide suggestions: Guide the user as they type.
- Execute actions: Perform tasks when they press Enter.
The Omnibox API
To interact with the omnibox, we use the chrome.omnibox API. This API lives in your extension's background script (service worker).
Remember to declare the "omnibox" permission in your manifest.json file for your extension to use this API.
Listening for Input Changes
As a user types after your omnibox keyword, your extension can provide dynamic suggestions. This is handled by the chrome.omnibox.onInputChanged event.
- It fires every time the user's input changes.
- You receive the current
textthe user has typed. - You get a
suggestcallback function to send suggestions back to the omnibox.
Structuring Your Suggestions
The suggest callback expects an array of suggestion objects. Each object needs an "content" field, which is the actual text that will be inserted if the user selects the suggestion.
You can also add a "description" field for richer suggestions:
content: The text to use if the suggestion is selected.description: (Optional) Rich HTML text displayed next to the suggestion.
Code: Dynamic Suggestions
Let's create a background script that suggests a prefix based on the user's input. Make sure your manifest.json has "omnibox": { "keyword": "go" } and the "omnibox" permission.
chrome.omnibox.onInputChanged.addListener(
(text, suggest) => {
const suggestions = [
{ content: text + " search", description: "Search for: " + text },
{ content: text + " docs", description: "Docs for: " + text }
];
suggest(suggestions);
}
);Executing Actions on Enter
Once the user types their input and presses the Enter key, the chrome.omnibox.onInputEntered event is triggered. This is where you perform the main action of your extension.
- It provides the final
textentered by the user. - It also gives a
disposition, indicating how the user wants the action to be handled (e.g., new tab, current tab).
Code: Opening a New Tab
Here's how to open a new tab with a search query based on the user's input. This code would typically be in the same background script as onInputChanged.
chrome.omnibox.onInputEntered.addListener(
(text, disposition) => {
const searchUrl = `https://www.google.com/search?q=${encodeURIComponent(text)}`;
if (disposition === 'newForegroundTab') {
chrome.tabs.create({ url: searchUrl });
} else if (disposition === 'newBackgroundTab') {
chrome.tabs.create({ url: searchUrl, active: false });
} else {
// currentTab
chrome.tabs.update({ url: searchUrl });
}
}
);Setting a Default Suggestion
You can provide a default suggestion that appears even before the user types anything. This is useful for guiding users or showing a common action.
Use chrome.omnibox.setDefaultSuggestion() with a description to set this initial hint.
chrome.omnibox.setDefaultSuggestion({
description: 'Type a query to search Google'
});Rich Suggestions with Descriptions
For even more helpful suggestions, you can use HTML within the description field. This allows you to highlight parts of the text, use different colors, or make it more readable.
- Use
<match>tags to highlight matching text. - Use
<dim>tags for less important text. - Remember to escape special characters like
<and>if they are part of your literal text.
Quick Check: Omnibox Events
Consider an extension that uses the omnibox keyword 'wiki'. Which event listener is primarily responsible for updating suggestions as the user types 'wiki cats'?
Recap: Responding to Omnibox Input
You've learned how to make your extension truly interactive with the omnibox!
- We use
chrome.omnibox.onInputChangedto provide dynamic suggestions as the user types. - Suggestions are an array of objects with
contentand optionaldescriptionfields. chrome.omnibox.onInputEnteredallows your extension to execute a specific action when the user presses Enter.- You can also set a
setDefaultSuggestionfor initial guidance.
This powerful API lets users interact with your extension directly from the browser's address bar, making common tasks quicker and more efficient.
よくある質問
「Omnibox入力への応答」レッスンは無料ですか？
はい。「Omnibox入力への応答」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Browser Extensions Development (Chrome & Edge)コースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Browser Extensions Development (Chrome & Edge)コースには全4レッスンが含まれています。
「Omnibox入力への応答」で何を学びますか？
Omniboxからのユーザー入力を処理し、候補を提示するとともに、入力されたテキストに基づいてカスタムロジックを実行します。 ブラウザで直接実行するハンズオンコードでBrowser Extensions Development (Chrome & Edge)を演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
Browser Extensions Development (Chrome & Edge)を始めるのに経験は必要ですか？
事前経験は必要ありません。CoddyKitのBrowser Extensions Development (Chrome & Edge)は初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン3/4です。
「Omnibox入力への応答」レッスンにはどのくらい時間がかかりますか？
ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このBrowser Extensions Development (Chrome & Edge)レッスンでコードを書いて実行できますか？
はい。すべてのBrowser Extensions Development (Chrome & Edge)レッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。