https://github.com/abdullahselek/forcetouchactions
Objective-C wrapper for iOS Home Screen Quick Actions
https://github.com/abdullahselek/forcetouchactions
3d-touch force-touch ios
Last synced: 4 months ago
JSON representation
Objective-C wrapper for iOS Home Screen Quick Actions
- Host: GitHub
- URL: https://github.com/abdullahselek/forcetouchactions
- Owner: abdullahselek
- License: mit
- Created: 2016-08-19T20:24:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-08T16:03:37.000Z (over 9 years ago)
- Last Synced: 2025-07-03T02:02:05.946Z (12 months ago)
- Topics: 3d-touch, force-touch, ios
- Language: Objective-C
- Size: 1.16 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/abdullahselek/ForceTouchActions.svg)
[](https://img.shields.io/cocoapods/v/ForceTouchActions.svg)
[](https://coveralls.io/github/abdullahselek/ForceTouchActions?branch=master)
# ForceTouchActions
Objective-C wrapper for iOS Home Screen Quick Actions
ForceTouchActions wrapper creates dynamic quick actions. You can add localizable shortcuts dynamically in runtime and handle them with type.
# Requirements
iOS 9.0+
# CocoaPods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
```objc
$ gem install cocoapods
```
To integrate ForceTouchActions into your Xcode project using CocoaPods, specify it in your Podfile:
```objc
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '' do
pod 'ForceTouchActions', '0.2'
end
```
Then, run the following command:
```objc
$ pod install
```
## Usage
```objc
#import
```
### Create shortcuts and add an array of shortcuts
```objc
FTShortcut *shortcutFavorite = [[FTShortcut alloc] initWithType:UIApplicationShortcutIconTypeFavorite
title:@"Add Favorite"
subtitle:@"Favorite"];
FTShortcut *shortcutCompose = [[FTShortcut alloc] initWithType:UIApplicationShortcutIconTypeCompose
title:@"Compose Mail"
subtitle:@"Mail"
iconName:@"apple_black.png"];
NSArray *shortcuts = @[shortcutFavorite, shortcutCompose];
```
### Initiate ForceTouchActions with parameters to install the shortcuts
```objc
UIViewController *rootViewController = self.window.rootViewController;
NSString *bundleIdentifier = [NSBundle mainBundle].bundleIdentifier;
self.forceTouchActions = [[FTActions alloc] initWithApplication:[UIApplication sharedApplication]
delegate:rootViewController
bundleIdentifier:bundleIdentifier
shortcuts:shortcuts
launchOptions:launchOptions];
```
### Add more shortcuts
```objc
- (void)applicationDidEnterBackground:(UIApplication *)application
{
FTShortcut *shortcutLocation = [[FTShortcut alloc] initWithType:UIApplicationShortcutIconTypeLocation
title:@"Location"
subtitle:nil];
[self.forceTouchActions addShortcut:shortcutLocation application:application];
}
```
### Handle action shortcuts on AppDelegate
```objc
- (void)application:(UIApplication *)application performActionForShortcutItem:(UIApplicationShortcutItem *)shortcutItem completionHandler:(void (^)(BOOL))completionHandler
{
if (!self.forceTouchActions)
{
completionHandler(NO);
return;
}
UIViewController *rootViewController = self.window.rootViewController;
if (!rootViewController)
{
completionHandler(NO);
return;
}
completionHandler([self.forceTouchActions handleWithDelegate:rootViewController shortcutItem:shortcutItem]);
}
```
### Add FTActionsSupport protocol to your viewcontroller
```objc
@interface ViewController : UIViewController
```
### handle in
```objc
- (void)prepareForTouchActionWithItem:(UIApplicationShortcutItem *)shortcutItem
```
# License
MIT License
Copyright (c) 2016 Abdullah Selek
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.