react-native home screen quick actions

Support for the new Touch 3D home screen quick actions for your React Native apps!

Installing

First cd into your project's directory and grab the latest version of this code:

$ npm install react-native-quick-actions --save

Usage

Linking the Library

In order to use quick actions you must first link the library to your project. There's excellent documentation on how to do this in the React Native Docs. Make sure you do all steps including #3

Lastly, add the following lines to your AppDelegate.m file:

#import "RNQuickActionManager.h"

- (void)application:(UIApplication *)application performActionForShortcutItem:(UIApplicationShortcutItem *)shortcutItem completionHandler:(void (^)(BOOL succeeded)) completionHandler {
  [RNQuickActionManager onQuickActionPress:shortcutItem completionHandler:completionHandler];
}

Adding static quick actions

This part is pretty easy. There are a bunch of tutorials and docs out there that go over all your options, but here is the quick and dirty version:

Add these entries into to your Info.plist file and replace the generic stuff (Action Title, .action, etc):

<key>UIApplicationShortcutItems</key>
<array>
  <dict>
    <key>UIApplicationShortcutItemIconType</key>
    <string>UIApplicationShortcutIconTypeLocation</string>
    <key>UIApplicationShortcutItemTitle</key>
    <string>Action Title</string>
    <key>UIApplicationShortcutItemType</key>
    <string>$(PRODUCT_BUNDLE_IDENTIFIER).action</string>
  </dict>
</array>

A full list of available icons can be found here:

https://developer.apple.com/library/prerelease/ios/documentation/UIKit/Reference/UIApplicationShortcutIcon_Class/index.html#//apple_ref/c/tdef/UIApplicationShortcutIconType

NOTE: A bunch of these icons are iOS 9.1 only so YMMV on 9.0 devices.

Adding dynamic quick actions

In order to add / remove dynamic actions during application lifecycle, you need to require react-native-quick-actions and call either setShortcutItems or clearShortcutItems (useful when user is logging out).

var QuickActions = require('react-native-quick-actions');

// Add few actions
QuickActions.setShortcutItems([
  {
    type: "Orders", // Required
    title: "See your orders", // Optional, if empty, `type` will be used instead
    subtitle: "See orders you've made",
    icon: "Compose", // Pass any of UIApplicationShortcutIconType<name>
    userInfo: {
      url: "app://orders" // provide custom data, like in-app url you want to open
    }
  }
]);

// Clear them all
QuickActions.clearShortcutItems();

In order to specify icon for your shortcut item, either include UIApplicationShortcutIconType<name>, e.g. for UIApplicationShortcutIconTypeCompose go with Compose or define your asset name if you want to use image from a template (e.g. my-custom-icon if that's the name of image in Images.xcassets. Remember not to name your custom icons the same as any system icons otherwise system ones will be loaded instead).

Full list of available icons has been already listed in the previous section.

Listening for quick actions in your javascript code

First, you'll need to make sure DeviceEventEmitter is added to the list of requires for React.

var React = require('react-native');
var {
  //....things you need plus....
  DeviceEventEmitter
} = React;

Use DeviceEventEmitter to listen for quickActionShortcut messages.

var subscription = DeviceEventEmitter.addListener(
  'quickActionShortcut', function(data) {
    console.log(data.title);
    console.log(data.type);
    console.log(data.userInfo);
  });

To get any actions sent when the app is cold-launched using the following code:

var QuickActions = require('react-native-quick-actions');
var action = QuickActions.popInitialAction();
if (action) {
  doSomethingWithTheAction(action); // e.g. LinkingIOS.openURL(..)
}

License

Copyright (c) 2015 Jordan Byron (http://github.com/jordanbyron/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.