@mobigaurav/react-native-quick-actions


A comprehensive React Native library for implementing home-screen quick actions on both iOS and Android platforms.

> Provides home-screen long-press quick actions (iOS 3D Touch / Android App Shortcuts). Not App Intents/Siri Shortcuts.

✨ Features

- 🎯 iOS 3D Touch / Force Touch shortcuts - Native iOS app shortcuts
- 🤖 Android App Shortcuts (API 25+) - Modern Android shortcuts
- 🔄 Dynamic shortcuts - Update shortcuts at runtime
- 🎨 Custom icons support - SF Symbols (iOS) & Drawable resources (Android)
- 🔗 Deep linking integration - Navigate directly to specific screens
- 📱 Cross-platform - Single API for both platforms
- 🔧 TypeScript support - Full type definitions included
- ⚡ Production ready - Battle-tested in enterprise applications

📦 Installation

``bash
npm install @mobigaurav/react-native-quick-actions


or


yarn add @mobigaurav/react-native-quick-actions
`

> Note: This library requires React Native 0.60+ and uses auto-linking.

$3

1. Add to Podfile (if using manual linking):
`ruby
pod 'RNAppShortcuts', :path => '../node_modules/@mobigaurav/react-native-quick-actions'
`

2. Update AppDelegate.m:
`objc
#import

- (void)application:(UIApplication )application performActionForShortcutItem:(UIApplicationShortcutItem )shortcutItem completionHandler:(void (^)(BOOL))completionHandler {
[RNAppShortcuts handleShortcutItem:shortcutItem];
completionHandler(YES);
}
`

3. Run pod install:
`bash
cd ios && pod install
`

$3

1. Add package to MainApplication.java (if using manual linking):
`java
import com.appshortcuts.RNAppShortcutsPackage;

@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage(),
new RNAppShortcutsPackage() // Add this line
);
}
`

2. Handle shortcuts in MainActivity.java:
`java
import com.appshortcuts.RNAppShortcutsModule;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
RNAppShortcutsModule.handleShortcut(getIntent());
}

@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
RNAppShortcutsModule.handleShortcut(intent);
}
`

💡 Advanced Usage

$3

`javascript
// Update shortcuts based on user authentication
const updateShortcuts = (isLoggedIn, userDevices) => {
const shortcuts = [];

if (isLoggedIn) {
shortcuts.push({
id: 'profile',
title: 'My Profile',
icon: 'person.circle',
data: { screen: 'Profile' }
});

// Add device-specific shortcuts
userDevices.slice(0, 2).forEach(device => {
shortcuts.push({
id: device_${device.id},
title: device.name,
subtitle: Control ${device.type},
icon: 'gear',
data: { screen: 'DeviceControl', deviceId: device.id }
});
});
} else {
shortcuts.push({
id: 'login',
title: 'Sign In',
icon: 'person.badge.key',
data: { screen: 'Login' }
});
}

AppShortcuts.setShortcuts(shortcuts);
};
`

$3

`javascript
try {
await AppShortcuts.setShortcuts(shortcuts);
console.log('Shortcuts updated successfully');
} catch (error) {
console.error('Failed to update shortcuts:', error);
}
`

🚀 Quick Start

`javascript
import AppShortcuts from '@mobigaurav/react-native-quick-actions';

// 1. Set up shortcuts
AppShortcuts.setShortcuts([
{
id: 'compose',
title: 'Compose Message',
subtitle: 'Start a new conversation',
icon: 'plus.message', // iOS: SF Symbol, Android: drawable
data: { screen: 'Compose', action: 'new' }
},
{
id: 'search',
title: 'Search',
subtitle: 'Find messages and contacts',
icon: 'magnifyingglass',
data: { screen: 'Search' }
}
]);

// 2. Listen for shortcut activation
AppShortcuts.onShortcutPressed((shortcut) => {
console.log('Shortcut activated:', shortcut);

// Navigate based on shortcut data
switch (shortcut.data.screen) {
case 'Compose':
navigation.navigate('ComposeScreen');
break;
case 'Search':
navigation.navigate('SearchScreen');
break;
}
});

// 3. Handle app launch via shortcut
AppShortcuts.getInitialShortcut().then((shortcut) => {
if (shortcut) {
console.log('App launched via shortcut:', shortcut);
// Handle initial navigation
handleShortcutNavigation(shortcut);
}
});
`

📚 API Reference

$3

| Method | Description | Returns |
|--------|-------------|----------|
| setShortcuts(shortcuts) | Set dynamic shortcuts for the app | Promise |
| clearShortcuts() | Remove all dynamic shortcuts | Promise |
| onShortcutPressed(callback) | Listen for shortcut press events | EventSubscription |
| getInitialShortcut() | Get shortcut that launched the app | Promise |
| isSupported() | Check if shortcuts are supported | boolean |

$3

`javascript
// Set up listener
const subscription = AppShortcuts.onShortcutPressed((shortcut) => {
// Handle shortcut
});

// Clean up listener
subscription.remove();
`

🔧 TypeScript Support

`typescript
interface Shortcut {
id: string; // Unique identifier
title: string; // Display title
subtitle?: string; // Optional subtitle
icon?: string; // Icon name/resource
data?: { [key: string]: any }; // Custom data payload
}

interface EventSubscription {
remove(): void;
}
`

📱 Platform Support

| Platform | Version | Features |
|----------|---------|----------|
| iOS | 9.0+ | 3D Touch, Force Touch, Long Press |
| Android | 7.1+ (API 25+) | App Shortcuts, Pinned Shortcuts |

$3

- iOS: Use SF Symbol names (e.g., plus.circle, gear, bell.fill)
- Android: Use drawable resource names (e.g., ic_add, ic_settings)

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. 🐛 Report bugs - Open an issue with details
2. 💡 Suggest features - Share your ideas
3. 🔧 Submit PRs - Fix bugs or add features
4. 📖 Improve docs - Help others understand

$3

`bash
git clone https://github.com/mobigaurav/react-native-quick-actions.git
cd react-native-quick-actions
npm install
``

📄 License

MIT © Gaurav Kumar

🙏 Acknowledgments

- Originally developed for enterprise use
- Inspired by the React Native community's need for native shortcuts
- Thanks to all contributors and users!

📞 Support

- 📧 Email: mobigaurav@gmail.com
- 🐛 Issues: GitHub Issues
- 💬 Discussions: GitHub Discussions

---

Made with ❤️ for the React Native community