The Button DeepLink SDK is a splendid route-matching, block-based way to handle your deep links. Rather than decide how to format your URLs, parse them, pass data, and navigate to specific content or perform actions, this library and a few lines of code will get you on your way.
Try the DeepLinkSDK
sample project by running the following command:
pod try "DeepLinkSDK"
DeepLinkSDK is available through CocoaPods. To install the library, simply add the following line to your Podfile:
pod "DeepLinkSDK"
Add deep link support to your app in 5 minutes or less following these simple steps.
Note: As of 0.2.0
, in all registered routes, paths are considered to begin at the first forward slash. A route component before the first forward slash will be considered the host.
1. Make sure you have a URL scheme registered for your app in your Info.plist
**2. Create an instance of `DPLDeepLinkRouter` in your app delegate**
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
self.router = [[DPLDeepLinkRouter alloc] init];
return YES;
}
**3. Register a route handler**
self.router[@"/log/:message"] = ^(DPLDeepLink *link) {
NSLog(@"%@", link.routeParameters[@"message"]);
};
**4. Pass incoming URLs to the router**
- (BOOL)application:(UIApplication *)application
openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication
annotation:(id)annotation {
[self.router handleURL:url withCompletion:NULL];
return YES;
}
Learn more about the DeepLinkSDK by reading our Integration Guide.
URLs coming into your app will be in a similar format to the following:
<scheme>://<host>/<path-component>/<path-component>
When registering routes, it's important to note that the first forward slash in your registered route determines the start of the path to be matched. A route component before the first forward slash will be considered to be the host.
Say you have an incoming URL of twitter://timeline
// Matches the URL.
router[@"timeline"] = ^{ … }
// Does not match the URL.
router[@"/timeline"] = ^{ … }
In another example, a URL of twitter://dpl.com/timeline
// Matches the URL.
router[@"/timeline"] = ^{ … }
// Does not match the URL.
router[@"timeline"] = ^{ … }
To run the example project, run pod try DeepLinkSDK
in your terminal. You can also clone the repo, and run pod install
from the project root. If you don't have CocoaPods, begin by follow this guide.
There are two demo apps, SenderDemo
, and ReceiverDemo
. ReceiverDemo
has some registered routes that will handle specific deep links. SenderDemo
has a couple actions that will deep link out to ReceiverDemo
for fulfillment.
Run theSenderDemo
build scheme first, then stop the simulator and switch the build scheme to ReceiverDemo
and run again. Now you can switch back to the SenderDemo
app in the simulator and tap on one of the actions.
DeepLinkSDK is available under the MIT license. See the LICENSE file for more info.
We'd love to see your ideas for improving this library. The best way to contribute is by submitting a pull request. We'll do our best to respond to you as soon as possible. You can also submit a new Github issue if you find bugs or have questions.
Please make sure to follow our general coding style and add test coverage for new features!