flutter_app_shortcut

A plugin to implement Android native App shortcut and IOS quick actions


Getting Started

Where to get it?

Go to the plugin official pub.dev page to install


How to use it?

Review this file to get full example usages

Example

Android

Add a new shortcut

FlutterAppShortcut().push(
    ShortcutArg(
        id: 'id_1',
        title: 'Home page',
        iconResourceName: 'ic_android_black',
        androidArg: AndroidArg(
            longLabel: 'Go to Home page',
            uri: 'https://www.google.com',
        )
    );
)

Add a new icon

  • Add icon resource to android/app/src/main/res
  • Set iconResourceName to the same name as the added icon in previous step

IOS

FlutterAppShortcut().push(
    ShortcutArg(
        id: 'id_1',
        title: 'Home page',
        iconResourceName: 'register',
        iosArg: IosArg(subtitle: "My subtitle),
    );
)

Add a new icon

  • Add image set using Xcode
  • Set iconResourceName to the same name as the added icon in previous step



Arguments

ShortcutArg

NameTypeRequirementsDescription
idStringUniqueWhen pushing shortcuts with the same ID, the existing one is updated
titleStringNot emptyApp short cut label (title)
iconResourceNameStringIcon resource name (see below for usage)
androidArgAndroidArgExtra arguments for Android shortcuts
iosArgIosArgExtra arguments for IOS shortcuts

AndroidArg

NameTypeRequirementsDescription
longLabelStringif there is enough space on the device, longLabel replaces title
uriStringUri when click on shortcut

IosArg

NameTypeRequirementsDescription
subtitleStringSubtitle of the shortcut



Limitations

Android

  • Pinned shortcut cannot be removed, only disabled
  • Shortcut after disabled cannot be enabled, however, pinned shortcut can
  • Cannot return icon name when cal getShortcuts
  • Cannot set disabled message (will implement in the future)
  • Cannot use icon from flutter side (will implement in the future)
  • On click short cut does nothing (will implement in the future)

IOS

  • On IOS, enable and disable shortcuts is not available
  • Cannot return icon name when cal getShortcuts
  • Does no support disable, enable icons
  • Cannot use icon from flutter side (will implement in the future)
  • On click short cut does nothing (will implement in the future)

TODO

  • x Reseach + Implement for IOS side

Android

  • Allow add disabled message to disabled shortcuts
  • x Implement get shortcuts
  • Allow icon from flutter side
  • Enable destination on click shortcut
  • Provide accurate errors

IOS

  • x Allow set subtitle
  • x Allow set icon
  • Allow icon from flutter side
  • Enable destination on click shortcut
  • Provide accurate errors

Bugs, Ideas, and Feedback

For bugs please use GitHub Issues. For questions, ideas, and discussions use GitHub Discussions.



License

Copyright 2021 The Flutter App Shortcuts Project Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Libraries

flutter_app_shortcut
short_cut_arg