Get things done quickly with app shortcuts
App shortcuts give quick access to a handful of common actions that users need frequently.
To improve users' productivity and facilitate reengagement with key tasks, the web platform now supports app shortcuts. They allow web developers to provide quick access to a handful of common actions that users need frequently.
This article will teach you how to define app shortcuts. Additionally, you'll learn some associated best practices.
About app shortcuts #
App shortcuts help users quickly start common or recommended tasks within your web app. Easy access to those tasks from anywhere the app icon is displayed will enhance users' productivity as well as increase their engagement with the web app.
The app shortcuts menu is invoked by right-clicking the app icon in the taskbar (Windows) or dock (macOS) on the user's desktop, or touch & holding the app's launcher icon on Android.
The app shortcuts menu is shown only for Progressive Web Apps that are installed on the user's desktop or mobile device. Check out Installation in our "Learn PWA" module to learn about installability requirements.
Each app shortcut expresses a user intent, each of which is associated with a URL within the scope of your web app. The URL is opened when a user activate the app shortcut. Examples of app shortcuts include the following:
- Top-level navigation items (e.g., home, timeline, recent orders)
- Search
- Data entry tasks (e.g., compose an email or tweet, add a receipt)
- Activities (e.g., start a chat with the most popular contacts)
Define app shortcuts in the web app manifest #
App shortcuts are optionally defined in the web app manifest, a JSON file that tells the browser about your web app and how it should behave when installed on the user's desktop or mobile device. More specifically, they are declared in the shortcuts array member. Below is an example of a potential web app manifest.
{
"name": "Player FM",
"start_url": "https://player.fm?utm_source=homescreen",
…
"shortcuts": [
{
"name": "Open Play Later",
"short_name": "Play Later",
"description": "View the list of podcasts you saved for later",
"url": "/play-later?utm_source=homescreen",
"icons": [{ "src": "/icons/play-later.png", "sizes": "192x192" }]
},
{
"name": "View Subscriptions",
"short_name": "Subscriptions",
"description": "View the list of podcasts you listen to",
"url": "/subscriptions?utm_source=homescreen",
"icons": [{ "src": "/icons/subscriptions.png", "sizes": "192x192" }]
}
]
}Each member of the shortcuts array is a dictionary that contains at least a name and a url. Other members are optional.
nameThe human-readable label for the app shortcut when displayed to the user.
short_name(optional)The human-readable label used where space is limited. It is recommended that you provide it, even though it's optional.
description(optional)The human-readable purpose for the app shortcut. It is not used at the time of writing but may be exposed to assistive technology in the future.
urlThe URL opened when a user activates the app shortcut. This URL must exist within the scope of the web app manifest. If it is a relative URL, the base URL will be the URL of the web app manifest.
icons(optional)An array of image resource objects. Each object must include the
srcand asizesproperty. Unlike web app manifest icons, thetypeof image is optional. SVG files are not supported at the time of writing. Use PNG instead.If you want pixel-perfect icons, provide them in increments of 48dp (i.e. 36x36, 48x48, 72x72, 96x96, 144x144, 192x192 pixel icons). Otherwise, it is recommended that you use a single 192x192 pixel icon.
As a quality measure, icons must be at least half of the device's ideal size on Android, which is 48dp. For example, to display on an xxhdpi screen, the icon must be at least 72 by 72 pixels. (This is derived from the formula for converting dp units for pixel units.)
Test your app shortcuts #
To verify that your app shortcuts are set up correctly, use the Manifest pane in the Application panel of DevTools.
This pane provides a human-readable version of many of your manifest's properties, including app shortcuts. It makes it easy to verify that all of the shortcut icons, if provided, are loading properly.
App shortcuts may not be available right away to all users because Progressive Web App updates are capped to once a day. Find out more about how Chrome handles updates to the web app manifest.
Best practices #
Order app shortcuts by priority #
Shortcuts are displayed in the order by which you define them in the manifest. You are encouraged to order app shortcuts by priority because the limit on the number of app shortcuts displayed varies byß platform. Chrome and Edge on Windows for instance limit the number of app shortcuts to 10 while Chrome for Android only display 3. Before Chrome 92 for Android 7, 4 were allowed. Chrome 92 added a shortcut to the site settings, taking one of the available shortcut slots for the app.
Use distinct app shortcut names #
You should not rely on icons to differentiate app shortcuts as they may not always be visible. For instance, macOS doesn't support icons in the dock shortcuts menu. Use distinct names for each app shortcut.
Measure app shortcuts usage #
You should annotate app shortcuts url entries like you would do with start_url for analytics purposes (e.g. url: "/my-shortcut?utm_source=homescreen").
Browser support #
App shortcuts are available on the platforms and versions listed below.
- Chrome, Not supported
- Firefox, Not supported
- Edge, Not supported
- Safari, Not supported
Trusted Web Activity support #
Bubblewrap, the recommended tool to build Android apps that use Trusted Web Activity, reads app shortcuts from the web app manifest and automatically generates the corresponding configuration for the Android app. Note that icons for app shortcuts are required and must be at least 96 by 96 pixels in Bubblewrap.
PWABuilder, a great tool to easily turn a Progressive Web App into a Trusted Web Activity, supports app shortcuts with some caveats.
For developers integrating Trusted Web Activity manually into their Android application, Android app shortcuts can be used to implement the same behaviors.
Sample #
Check out the app shortcuts sample and its source.
Helpful links #
- MDN
- Spec
- App shortcuts sample | App shortcuts sample source
- Blink Component:
UI>Browser>WebAppInstalls