Skip to content

shortcuts.md

Latest commit

 

History

History
92 lines (64 loc) · 4.04 KB

shortcuts.md

File metadata and controls

92 lines (64 loc) · 4.04 KB
title Define app shortcuts (long-press or right-click menus)
description How to make your app's common tasks available in the Windows Taskbar's context menu.
author MSEdgeTeam
ms.author msedgedevrel
ms.topic article
ms.service microsoft-edge
ms.subservice pwa
ms.date 09/13/2021

Define app shortcuts (long-press or right-click menus)

App shortcuts let users accomplish common tasks more quickly and easily and can increase their engagement with an app.

On mobile devices, shortcuts can usually be accessed by long-pressing an app icon. On Windows, shortcuts are integrated as Jumplists. Jumplists define popup menus that appear when you right-click a tile in the Start menu, or right-click an icon in the taskbar.

Shortcuts on Microsoft Edge, on iOS:

Shortcuts on Microsoft Edge on iOS

A Jumplist (right-click menu) on the Webboard app, on Windows:

A Jumplist on the Webboard app on Windows

Progressive Web Apps (PWAs) can also define common tasks as shortcuts in the web app manifest. See Expose common app actions as shortcuts at MDN > References > Progressive web apps > How to.

Define shortcuts

Defining shortcuts is done by using the shortcuts manifest member. This member is an array that can contain multiple shortcuts. Each shortcut is essentially a URL that gets requested when the shortcut is used and the app is launched.

{
    "shortcuts" : [
        {
            "name": "Today's agenda",
            "url": "/today",
            "description": "List of events planned for today"
        },
        {
            "name": "New event",
            "url": "/create/event"
        },
        {
            "name": "New reminder",
            "url": "/create/reminder"
        }
    ]
}

The following properties can be used:

Property Details
name A string that is displayed to the user on Jumplists or the context menu.
short_name A string that is displayed when insufficient space exists to display the full name of the shortcut.
description A string that describes the purpose of the shortcut. The string can be accessed by assistive technology.
url The URI in the web app that opens when the shortcut is activated.
icons A set of icons that represents the shortcut.

To learn more, see shortcuts at MDN.

Debug shortcuts

You can test that your shortcuts are configured correctly by using the Application panel of DevTools.

To test that your shortcuts are configured correctly:

  1. In Microsoft Edge, go to your app.

  2. To open DevTools, right-click the webpage, and then select Inspect. Or, press Ctrl+Shift+I (Windows, Linux) or Command+Option+I (macOS). DevTools opens.

  3. In DevTools, on the main toolbar, select the Application tab. If that tab isn't visible, click the More tabs (More tabs icon) button, or else the More Tools (More Tools icon) button.

  4. In the Application tool, select Manifest.

  5. Scroll down to reveal the list of shortcuts.

    [!div class="mx-imgBorder"] Shortcuts are listed in the Application panel

To learn more about using the Application panel to debug PWAs, see Debug a Progressive Web App (PWA).

See also