Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clayallsopp/routable-ios
Routable, an in-app native URL router, for iOS
https://github.com/clayallsopp/routable-ios
Last synced: 3 months ago
JSON representation
Routable, an in-app native URL router, for iOS
- Host: GitHub
- URL: https://github.com/clayallsopp/routable-ios
- Owner: clayallsopp
- License: mit
- Created: 2013-04-03T16:48:14.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-30T05:54:35.000Z (almost 6 years ago)
- Last Synced: 2024-07-19T19:08:04.005Z (4 months ago)
- Language: Objective-C
- Size: 71.3 KB
- Stars: 1,803
- Watchers: 63
- Forks: 194
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Routable [](https://travis-ci.org/clayallsopp/routable-ios) [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fclayallsopp%2Froutable-ios?ref=badge_small)
Routable is an in-app native URL router, for iOS. Also available for [Android](https://github.com/usepropeller/routable-android).
## Usage
Set up your app's router and URLs (usually done in `application:didFinishLaunchingWithOptions:`):
```objective-c
[[Routable sharedRouter] map:@"users/:id" toController:[UserController class]];
// Requires an instance of UINavigationController to open UIViewControllers
[[Routable sharedRouter] setNavigationController:aNavigationController];
```
Implement `initWithRouterParams:` in your `UIViewController` subclass:
```objective-c
@implementation UserController
// params will be non-nil
- (id)initWithRouterParams:(NSDictionary *)params {
if ((self = [self initWithNibName:nil bundle:nil])) {
self.userId = [params objectForKey:@"id"];
}
return self;
}
```
Then, anywhere else in your app, open a URL:
```objective-c
NSString *aUrl = @"users/4";
[[Routable sharedRouter] open:aUrl];
```
If you wish to do custom allocation of a controller, you can use `+allocWithRouterParams:`
```objective-c
[[Routable sharedRouter] map:@"users/:id" toController:[StoryboardController class]];
@implementation StoryboardController
+ (id)allocWithRouterParams:(NSDictionary *)params {
UIStoryboard *storyboard = [UIStoryboard storyboardWithName:@"Storyboard" bundle:nil];
StoryboardController *instance = [storyboard instantiateViewControllerWithIdentifier:@"sbController"];
instance.userId = [params objectForKey:@"id"];
return instance;
}
```
Set `ignoresExceptions` to `YES` to NOT throw exceptions (suggested for a Release/Distribution version)
```objective-c
[[Routable sharedRouter] setIgnoresExceptions:YES];
```
## Installation
### [CocoaPods](http://cocoapods.org/)
```ruby
pod 'Routable', '~> 0.1.1'
```
```objective-c
#import
```
If you're not able to use CocoaPods, please install Routable as a [git submodule](http://schacon.github.com/git/user-manual.html#submodules) and add the files to your Xcode project.
## Features
### Anonymous Callbacks
You can invoke anonymous callbacks with Routable:
```objective-c
[[Routable sharedRouter] map:@"invalidate/:id" toCallback:^(NSDictionary *params) {
[Cache invalidate: [params objectForKey:@"id"]]];
}];
[[Routable sharedRouter] open:@"invalidate/5h1b2bs"];
```
### Presentation Options
You can configure if and how a `UIViewController` is presented modally with `UPRouterOptions`:
```objective-c
UPRouterOptions *options = [[UPRouterOptions modal] withPresentationStyle: UIModalPresentationFormSheet];
[self.router map:@"info" toController:[InfoController class]
withOptions:options];
```
`UPRouterOptions` has the following DSL setters:
- `modal`
- `withPresentationStyle:`
- `withTransitionStyle:`
- `forDefaultParams:`
### Open External URLs
Sometimes you want to open a URL outside of your app, like a YouTube URL or open a web URL in the browser. You can use Routable to do that:
```objective-c
[[Routable sharedRouter] openExternal:@"http://www.youtube.com/watch?v=oHg5SJYRHA0"];
```
### Multiple Routers
If you need to use multiple routers, simply create new instances of `Router`:
```objective-c
UPRouter *adminRouter = [Routable newRouter];
[adminRouter map:@"profile" toController: [AdminProfile class]];
UPRouter *userRouter = [Routable newRouter];
[userRouter map:@"profile" toController: [UserProfile class]];
```
## Contact
Clay Allsopp ([http://clayallsopp.com](http://clayallsopp.com))
- [http://twitter.com/clayallsopp](http://twitter.com/clayallsopp)
- [[email protected]]([email protected])
## License
Routable for iOS is available under the MIT license. See the LICENSE file for more info.
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fclayallsopp%2Froutable-ios?ref=badge_large)