Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lixiang1994/router
基于URLNavigator抽象的外部URL路由组件 支持任意类型配置 插件机制
https://github.com/lixiang1994/router
ios navigation navigator openurl plugin router routing swift swift5 url
Last synced: about 1 month ago
JSON representation
基于URLNavigator抽象的外部URL路由组件 支持任意类型配置 插件机制
- Host: GitHub
- URL: https://github.com/lixiang1994/router
- Owner: lixiang1994
- License: mit
- Created: 2019-04-12T11:19:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T11:38:42.000Z (8 months ago)
- Last Synced: 2024-04-20T17:52:32.609Z (8 months ago)
- Topics: ios, navigation, navigator, openurl, plugin, router, routing, swift, swift5, url
- Language: Swift
- Homepage:
- Size: 56.6 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Router
[URLNavigator](https://github.com/devxoul/URLNavigator) abstract routing component written in Swift
## Version 2.0 -> [Apis](https://github.com/lixiang1994/Apis)
## [天朝子民](README_CN.md)
## Features
- [x] Support for different processing based on plugin mechanism.
- [x] Configuration is independent and easy to manage.
- [x] Good business scalability.
- [x] Safer page management.
- [x] Support for asynchronous completion of callbacks.
## Installation
Router officially supports CocoaPods only.
**CocoaPods - Podfile**
```ruby
source 'https://github.com/lixiang1994/Specs'
pod 'Router'
```
## Usage
First make sure to import the framework:
```swift
import Router
```
Here are some usage examples. All devices are also available as simulators:
### Create router
```swift
let router = Provider(
[RouterXXXXXXPlugin(),
RouterXXXXXXPlugin(),
RouterXXXXXXPlugin()]
)
```
### RouterType
```swift
enum RouterType: RouterTypeable {
case open_http
case open_https
case open_xxxx
/* ... */
}
extension RouterType {
var pattern: String {
switch self {
case .open_http: return "http://"
case .open_https: return "https://"
case .open_xxxx: return "xxxx://open/xxxx"
/* ... */
}
}
func controller(url: URLConvertible, values: [String: Any]) -> Routerable? {
switch self {
case .open_http, .open_https:
guard let url = url.urlValue else { return nil }
return SFSafariViewController(url: url)
case .open_xxxx:
return XXXXViewController()
/* ... */
}
}
func handle(url: URLConvertible, values: [String : Any], completion: @escaping (Bool) -> Void) {
/* ... */
completion(true)
}
}
extension XXXXViewController: Routerable { }
extension SFSafariViewController: Routerable { }
```
### Custom plugins
```swift
class RouterXXXXPlugin: Plugin {
override func should(open type: RouterType) -> Bool {
/* ... */
return true
}
override func prepare(open type: RouterType, completion: @escaping (Bool) -> Void) {
/* ... */
completion(true)
}
override func will(open type: RouterType, controller: Routerable) {
/* ... */
}
override func did(open type: RouterType, controller: Routerable) {
/* ... */
}
}
```
### Open
```swift
// Open page based on type
router.open(.open_xxxx)
// Open page based on url
router.open("http://xxxxxxxx")
// Result callback
router.open("http://xxxxxxxx") { (result) in
// Success or failure
}
```
## Contributing
If you have the need for a specific feature that you want implemented or if you experienced a bug, please open an issue.
If you extended the functionality of Router yourself and want others to use it too, please submit a pull request.
## License
Router is under MIT license. See the [LICENSE](LICENSE) file for more info.