URLEmbeddedView
Features
- Simple interface for fetching Open Graph Data
- Be able to display Open Graph Data
- Automatically caching Open Graph Data
- Automatically caching Open Graph Image
- Tap handleable
- Clearable image cache
- Clearable data cache
- Support Swift3.2 (until 0.11.x)
- Supprot Swift4.x (until 0.17.1)
- Support Swift5 (since 0.18.0)
- Support Carthage since 0.11.1
- Support tvOS since 0.16.0
- Custom implementation of OGData cache
Usage
To run the example project, clone the repo, and run carthage update from the Example directory first.
let embeddedView = URLEmbeddedView()
embeddedView.loadURL(urlString)
Layouts
- Default
- No Image
- No response
Customization
embeddedView.textProvider[.Title].font = .boldSystemFontOfSize(18)
embeddedView.textProvider[.Title].fontColor = .lightGrayColor()
embeddedView.textProvider[.Title].numberOfLines = 2
//You can use ".Title", ".Description", ".Domain" and ".NoDataTitle"
Data and Image Cache
You can get Open Graph Data with OGDataProvider.
OGDataProvider.shared.fetchOGData(urlString: String, completion: ((OpenGraph.Data, Error?) -> Void)? = nil) -> String?
OGDataProvider.shared.deleteOGData(urlString: String, completion: ((Error?) -> Void)? = nil)
OGDataProvider.shared.deleteOGData(_ ogData: OpenGraph.Data, completion: ((Error?) -> Void)? = nil)
You can configure time interval for next updating of OGData. Default is 10 days.
OGDataProvider.shared.updateInterval = 10.days
You can get UIImage with OGImageProvider.
OGImageProvider.shared.loadImage(urlString: String, completion: ((UIImage?, Error?) -> Void)? = nil) -> NSURLSessionDataTask?
OGImageProvider.shared.clearMemoryCache()
OGImageProvider.shared.clearAllCache()
Custom Data Cache implementation
Default cache feature is using Core Data. If you want to use other cache features, please implement cache manager with OGDataCacheManagerProtocol. For example, URLEmbeddedView has OGDataNoCacheManager that feature is not using cache. If you want to use that feature, you can use like this.
OGDataProvider.shared.cacheManager = OGDataNoCacheManager()
You can implement custom cache feature and use it like this.
class MemoryCacheManager: OGDataCacheManagerProtocol {
// implementation of required methods
}
OGDataProvider.shared.cacheManager = MemoryCacheManager()
OpenGraph.Data Properties
public let imageUrl: URL?
public let pageDescription: String?
public let pageTitle: String?
public let pageType: String?
public let siteName: String?
public let sourceUrl: URL?
public let url: URL?
OpenGraphDataDownloader
You can only use download feature of OGData with OpenGraphDataDownloader like this.
let urlString = ...
OpenGraphDataDownloader.shared.fetchOGData(urlString: urlString) { result in
switch result {
case let .success(data, isExpired):
// do something
case let .failure(error, isExpired):
// do something
}
}
If you use OGDataProvider with OGDataNoCacheManager, it is almost same process.
OGDataProvider.shared.cacheManager = OGDataNoCacheManager()
let urlString = ...
OGDataProvider.shared.fetchOGData(urlString: urlString) { ogData, error in
// do something
}
Installation
CocoaPods
URLEmbeddedView is available through CocoaPods. To install it, simply add the following line to your Podfile:
# Uncomment the next line to define a global platform for your project
# platform :ios, '8.0'
target 'Your Project Name' do
# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
use_frameworks!
# Pods for URLEmbeddedViewSample
pod "URLEmbeddedView"
end
Carthage
If you’re using Carthage, simply add NoticeObserveKit to your Cartfile:
github "marty-suzuki/URLEmbeddedView"
Use in Objective-C
#import <URLEmbeddedView/URLEmbeddedView-Swift.h>
- (void)viewDidLoad {
[super viewDidLoad];
URLEmbeddedView *embeddedView = [[URLEmbeddedView alloc] init];
[self.view addSubView:embeddedView];
[embeddedView loadURL:@"https://github.com/" completion:nil];
}
- (void)setUpdateInterval {
[OGDataProvider sharedInstance].updateInterval = [NSNumber days:10];
}
- (void)fetchOpenGraphData {
[[OGDataProvider sharedInstance] fetchOGDataWithUrlString:self.textView.text
completion:^(OpenGraphData *data, NSError *error) {
NSLog(@"OpenGraphData = %@", data);
}];
}
Here is Objective-C sample.
Special Thanks
- CryptoSwift is a greate Crypto related functions and helpers for Swift. (Created by @krzyzanowskim)
Requirements
- Xcode 10.2 or greater
- iOS 8.0 or greater
- tvOS 10.0 or greater
- UIKit
- CoreData
- CoreGraphics
Other
- MisterFusion - Swift DSL for AutoLayout
- NoticeObserveKit (type-safe NotificationCenter wrapper) is used in this sample.
- Android version is here. (Created by @kaelaela)
Author
Taiki Suzuki, [email protected]
License
URLEmbeddedView is available under the MIT license. See the LICENSE file for more info.
![Value of type '[(_, CGFloat?)]' has no member 'compactMap'](https://avatars.githubusercontent.com/u/5967340?v=4)
93 Dec 6, 2022
887 Dec 22, 2022
45 Dec 28, 2021
173 Jan 2, 2023
1.6k Jan 9, 2023
643 Dec 20, 2022
20 Dec 23, 2022
65 Dec 24, 2022
9 Nov 30, 2022
489 Sep 9, 2022
1 Jan 6, 2022
0 Jun 22, 2022
138 Dec 15, 2022
5.3k Jan 5, 2023
875 Oct 5, 2022
74 Dec 14, 2022
36k Jan 5, 2023
1.2k Nov 29, 2022
646 Dec 27, 2022
700 Dec 16, 2022