Omnibox Keyword Integration
Integrate your extension with the browser's omnibox, allowing users to trigger actions or searches directly from the address bar.
Omnibox Keyword Integration is a free Browser Extensions Development (Chrome & Edge) lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Browser Extensions Development (Chrome & Edge) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
What is the Omnibox?
The omnibox is the URL bar at the top of your browser. It's not just for typing website addresses; it also handles searches and can be a powerful entry point for browser extensions!
Integrating with the omnibox allows users to quickly interact with your extension directly from the address bar, without needing to click an icon or open a popup.
Power Up Your Address Bar
Why integrate your extension with the omnibox?
- Quick Access: Users can trigger extension actions with just a few keystrokes.
- Custom Searches: Create shortcuts for specific searches within your extension's data.
- Streamlined Workflow: Perform tasks without interrupting their browsing flow.
Setting Your Omnibox Keyword
To enable omnibox integration, you need to declare it in your extension's manifest.json file.
You'll specify a unique keyword. When a user types this keyword into the omnibox, followed by a space, your extension takes over the input.
Manifest Keyword Example
Here's how to declare an omnibox keyword, for example, 'myext':
{ "manifest_version": 3,
"name": "My Omnibox Extension",
"version": "1.0",
"omnibox": {
"keyword": "myext"
},
"background": {
"service_worker": "background.js"
}
}Capturing User Input
Once your keyword is set, your background service worker needs to listen for user input. The main event for this is chrome.omnibox.onInputChanged.
This event fires every time the user types a character after your keyword, allowing you to provide real-time suggestions.
Displaying Live Suggestions
The onInputChanged listener provides a suggest callback function. You use this to send an array of suggestion objects back to the omnibox.
Each suggestion object needs a content (what gets inserted if selected) and a description (what the user sees in the dropdown).
Dynamic Suggestions in Action
This background.js snippet shows how to listen for input and offer basic suggestions. Try typing 'myext hello' in your browser's omnibox after loading this extension.
// background.js
chrome.omnibox.onInputChanged.addListener(
function(text, suggest) {
let suggestions = [];
if (text.startsWith("hello")) {
suggestions.push({content: "hello world", description: "Says Hello World"});
suggestions.push({content: "hello there", description: "Greets you"});
} else {
suggestions.push({content: "type 'hello'", description: "Try typing 'hello'"});
}
suggest(suggestions);
}
);Acting on User Selection
After the user types their input and optionally selects a suggestion, they press Enter. This triggers the chrome.omnibox.onInputEntered event.
This is where your extension performs the final action based on the user's input, like opening a new tab or executing a script.
Executing Actions
Inside onInputEntered, the text parameter contains the final string the user entered or selected.
A common action is to open a new tab with a specific URL using chrome.tabs.create({url: '...' }), or perform a search based on the input.
Full Omnibox Integration
Here's a more complete example combining both input handling and action execution. This example allows users to search Google directly from the omnibox using 'myext go [query]'.
// background.js
chrome.omnibox.onInputChanged.addListener(
function(text, suggest) {
let suggestions = [];
if (text.startsWith("go ")) {
const query = text.substring(3);
suggestions.push({
content: `https://www.google.com/search?q=${query}`,
description: `Search Google for "${query}"`
});
} else {
suggestions.push({
content: "go [search_term]",
description: "Type 'go' to search Google"
});
}
suggest(suggestions);
}
);
chrome.omnibox.onInputEntered.addListener(
function(text, disposition) {
if (text.startsWith("http://") || text.startsWith("https://")) {
chrome.tabs.create({url: text});
} else if (text.startsWith("go ")) {
const query = text.substring(3);
chrome.tabs.create({url: `https://www.google.com/search?q=${query}`});
} else {
console.log("Omnibox entered:", text);
chrome.tabs.create({url: `https://www.google.com/search?q=${text}`});
}
}
);Omnibox Quick Check
You've learned how to integrate your extension with the browser's omnibox. Let's test your knowledge!
Omnibox Power-Up Recap
Great job! You've learned how to integrate your extension with the browser's omnibox.
- We defined a keyword in
manifest.json. - We used
chrome.omnibox.onInputChangedto provide dynamic suggestions as the user types. - We handled the final action using
chrome.omnibox.onInputEntered, for example, opening a new tab.
This powerful feature allows users to interact with your extension quickly and efficiently right from their address bar!
Frequently asked questions
Is the “Omnibox Keyword Integration” lesson free?
Yes — the full text of “Omnibox Keyword Integration” is free to read here on the web, and the Browser Extensions Development (Chrome & Edge) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Browser Extensions Development (Chrome & Edge) course, upgrade to CoddyKit PRO.
What will I learn in “Omnibox Keyword Integration”?
Integrate your extension with the browser's omnibox, allowing users to trigger actions or searches directly from the address bar. You practise Browser Extensions Development (Chrome & Edge) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Browser Extensions Development (Chrome & Edge)?
No prior experience is required. Browser Extensions Development (Chrome & Edge) on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Omnibox Keyword Integration” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Browser Extensions Development (Chrome & Edge) lesson?
Yes. Every Browser Extensions Development (Chrome & Edge) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Adding Context Menu Items
- Omnibox Keyword Integration
- Responding to Omnibox Input
- Keyboard Shortcuts with the Commands API