Yes, I know, three posts today about the Management API. Anyway, I have created an Awesome extension that allows you to use your URL Bar (The Omnibox) to find an launch apps by their name.
It is pretty cool, just type 'go TAB or SPACE app name' in your URL bar and that is it. It will search through your installed extensions and let you launch it very quickly.
The remarkable thing is that this extension took 20 minutes to create, and I will try and show you how in this post.
Like all extensions, the first thing that we do is define a manifest.
{ "name": "Omni Launch", "description": "Launches apps, the quick way!", "version": "0.0.0.2", "background_page": "background.html", "permissions" : ["management"], "omnibox": { "keyword" : "go" }, "icons" : { "16" : "go.png" } }
The important thing here is the 'omnibox' attribute which lets you define a keyword that will allow the user to activate your extension.
Chrome does a lot of magic now, firstly it takes your 16 pixel icon and when ever the user types 'go' into the address bar this icon will be shown next to the action (although it will be in grey-scale). If you load this extension now, as is, you will see what I mean.
Now lets add some functionality to the background.html file. This is the brains of our extension. The way the extension works is a progressive filter. If I type 'go t' it will find all apps that contain 't', if I type 'tw' it will find all apps that have a 'tw' in their name. It is pretty basic stuff.
The first thing that we will do is hook-up the a function that handles the keypresses in the omnibar for our keyword. There is a simple API called
var inputChanged = function(text, suggestionsCallback) { if(text == "") { return; }<span class="keyword">var</span> suggestions = []; <span class="keyword">var</span> textlc = text.toLowerCase(); <span class="keyword">var</span> re = <span class="keyword">new</span> RegExp(<span class="string"><span class="delimiter">"</span><span class="content">(</span><span class="delimiter">"</span></span>+text+<span class="string"><span class="delimiter">"</span><span class="content">)</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">ig</span><span class="delimiter">"</span></span>); <span class="keyword">for</span>(<span class="keyword">var</span> a <span class="keyword">in</span> apps) { <span class="keyword">var</span> app = apps[a]; <span class="keyword">var</span> name = app.name.toLowerCase(); <span class="keyword">var</span> idx = name.indexOf(textlc); <span class="keyword">if</span>(idx > -<span class="integer">1</span>) { <span class="keyword">var</span> content = app.name; <span class="keyword">var</span> description = (app.description == <span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>) ? <span class="string"><span class="delimiter">"</span><span class="content"> </span><span class="delimiter">"</span></span> : app.description; <span class="keyword">var</span> matchStyle = chrome.omnibox.styleMatch(idx, text.length); suggestions.push( { <span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>: content, <span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span> : content + <span class="string"><span class="delimiter">"</span><span class="content"> - </span><span class="delimiter">"</span></span> + description, <span class="key"><span class="delimiter">"</span><span class="content">descriptionStyles</span><span class="delimiter">"</span></span> : [ matchStyle ] } ); } } suggestionsCallback(suggestions);
};
And hook-up the handler:
chrome.omnibox.onInputChanged.addListener(inputChanged);
The code is pretty straight forward, but it does do some special bits. For a start, we only want to be able to launch apps, so we need to maintain a simple list of all apps (done via chrome.management.getAll(getAllCallback);); once that is out of the way, we have the handler hooked up (onInputChanged) that detects when the users is changing their input against our keyword. The code iterates across all known apps and checks to see if their name contains the search term. If it does we add it to an array of suggestions. We also style the suggestion a little using 'chrome.omnibox.styleMatch' to highlight the exact text that matched in the suggestion. At the end of the handler we call the method (suggestionsCallback) passed in to our handler with a list of the apps that we are suggesting to the user.
And that is the basics done for adding suggestions into the Omnibox, it isn't an amazing amount of use at the moment because if you select one of the suggestions it doesn't do anything. We want it to launch the app Dammit! :)
Luckily, launching apps and find the selected item is really really easy.
So here goes:
var inputEntered = function(text) { var appsList = [];if(text == "") { return; }
for(var a in apps) { var app = apps[a];
<span class="keyword">if</span>(app.name.toLowerCase() == text.toLowerCase()) { chrome.management.launchApp(app.id); <span class="keyword">return</span>; }
} };
And hook up a handler that is triggered when the user makes a selection.
chrome.omnibox.onInputEntered.addListener(inputEntered);
This code is pretty basic, all we do is loop through each of the installed apps looking for the first one that matches the same name as the name of the app selected in the suggestions list and launch it using the 'chrome.management.lauchApp' API.
And we are all done. If you want to see this code in action it is available on Github/PaulKinlan/OmniLaunch. Fork away and tell me what you build.
I lead the Chrome Developer Relations team at Google.
We want people to have the best experience possible on the web without having to install a native app or produce content in a walled garden.
Our team tries to make it easier for developers to build on the web by supporting every Chrome release, creating great content to support developers on web.dev, contributing to MDN, helping to improve browser compatibility, and some of the best developer tools like Lighthouse, Workbox, Squoosh to name just a few.
I love to learn about what you are building, and how I can help with Chrome or Web development in general, so if you want to chat with me directly, please feel free to book a consultation.
I'm trialing a newsletter, you can subscribe below (thank you!)