Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Latest commit

 

History

History
 
 

quick_actions

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

quick_actions

This Flutter plugin allows you to manage and interact with the application's home screen quick actions.

Quick actions refer to the eponymous concept on iOS and to the App Shortcuts APIs on Android.

Android iOS
Support SDK 16+* 9.0+

Usage

Initialize the library early in your application's lifecycle by providing a callback, which will then be called whenever the user launches the app via a quick action.

final QuickActions quickActions = const QuickActions();
quickActions.initialize((shortcutType) {
  if (shortcutType == 'action_main') {
    print('The user tapped on the "Main view" action.');
  }
  // More handling code...
});

Finally, manage the app's quick actions, for instance:

quickActions.setShortcutItems(<ShortcutItem>[
  const ShortcutItem(type: 'action_main', localizedTitle: 'Main view', icon: 'icon_main'),
  const ShortcutItem(type: 'action_help', localizedTitle: 'Help', icon: 'icon_help')
]);

Please note, that the type argument should be unique within your application (among all the registered shortcut items). The optional icon should be the name of the native resource (xcassets on iOS or drawable on Android) that the app will display for the quick action.

Android

* The plugin will compile and run on SDK 16+, but will be a no-op below SDK 25 (Android 7.1).