README.md

App Actions

capacitor-app-actions

Capacitor iOS and Android Plugin for App Actions

Maintainers

Maintainer	GitHub	Social
Nitish Sachar	uioporqwerty	LinkedIn

Installation

npm install capacitor-app-actions
npx cap sync

Configuration

Android:

No additional configuration required.

iOS:

Add the following to AppDelegate.swift. This snippet allows the plugin to recognize when an app action has been selected so that you can respond to those events.

func application(_ application: UIApplication,
                   performActionFor shortcutItem: UIApplicationShortcutItem,
                   completionHandler: @escaping (Bool) -> Void)
{
    NotificationCenter.default.post(name: NSNotification.Name("appActionReceived"), object: nil, userInfo: ["actionId" : shortcutItem.type])
}

Usage

Typically app actions are added at application startup, but you can add them where appropriate:

import { AppActions } from 'capacitor-app-actions'

await Capacitor.Plugins.AppActions.set({ "actions": [ 
    { id: "order", title: "Order", subtitle: "Place an Order", icon: "star.fill" }, 
    { id: "locations", title: "Find location", subtitle: "Find nearby location", icon: "star.fill"}
  ]});

Listen to an event triggered by an existing app action:

AppActions.addListener("order", (info) => {
    // Do your in app work. Navigate to the appropriate page or trigger other in app actions.
  });

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Nitish Sachar 🚧 💻

This project follows the all-contributors specification. Contributions of any kind welcome!