This repository has been archived by the owner on Feb 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Body label is now UITextView (this adds link support)
- The author field is now emptied if not set - Image is clipped to bounds - added read
- Loading branch information
1 parent
4fec72f
commit 0db10f0
Showing
5 changed files
with
125 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2017 Luca Mozzarelli | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# LMArticleViewController | ||
![License](https://img.shields.io/cocoapods/l/LMArticleViewController.svg?style=flat) | ||
![Platform](https://img.shields.io/cocoapods/p/LMArticleViewController.svg?style=flat) | ||
![Version](https://img.shields.io/cocoapods/v/LMArticleViewController.svg?style=flat) | ||
|
||
This framework allows you to create Apple News-inspired UIViewControllers with ease. | ||
|
||
It is heavily inspired by [MRArticleViewController], in fact the core is a simple translation of it. However I added some features I thought could be useful. | ||
|
||
## Features | ||
The layout is shown in the images above, here's some extra features. | ||
#### Animations | ||
- [x] The navigation bar shrinks when you scroll down. | ||
- [x] The image view stretches when the scrollview bounces ( just like Facebook's Instant Articles). | ||
|
||
#### Appereance | ||
- [x] You can set custom fonts for all the text. | ||
- [x] Supports `NSAttributedString` in the body. | ||
- [x] Supports automatic background color and automatic light/dark text color. | ||
|
||
|
||
## Installation | ||
LMArticleViewController is available through CocoaPods. Simply add the following line to your Podfile. | ||
|
||
```ruby | ||
pod 'LMArticleViewController' | ||
``` | ||
|
||
## Usage | ||
You can either subclass `LMArticleViewController` and set the contents in the `viewDidLoad:` method or instantiate an LMArticleViewController object, set its properties and present it. | ||
|
||
#### Case A: Subclass | ||
```Objective-C | ||
- (void)viewDidLoad { | ||
|
||
// Set custom fonts | ||
// Size doesn't matter here, the super class overrides with default values | ||
[self setHeadlineFont:[UIFont fontWithName:@"Nexa Bold" size:1]]; | ||
[self setAuthorFont:[UIFont fontWithName:@"Roboto-Regular" size:1]]; | ||
[self setDateFont:[UIFont fontWithName:@"Roboto-Regular" size:1]]; | ||
|
||
// Set contents | ||
self.headline = self.dataDictionary[k_TITLE]; | ||
self.image = self.dataDictionary[k_IMAGE]; | ||
self.author = self.dataDictionary[k_AUTHOR]; | ||
self.attributedBody = self.dataDictionary[k_BODY]; | ||
self.date = self.dataDictionary[k_DATE]; | ||
|
||
// IMPORTANT! Setup must happen before [super viewDidLoad]!! | ||
[super viewDidLoad]; | ||
|
||
} | ||
``` | ||
#### Case B: Init and push | ||
```Objective-C | ||
- (void)openArticleWithContents:(NSDictionary *)dataDictionary { | ||
|
||
LMArticleViewController* articleViewController = [[LMArticleViewController alloc]init]; | ||
|
||
[articleViewController setBodyFont:[UIFont fontWithName:@"Roboto-Medium" size:1]]; | ||
|
||
articleViewController.headline = dataDictionary[k_TITLE]; | ||
articleViewController.image = dataDictionary[k_IMAGE]; | ||
articleViewController.author = dataDictionary[k_AUTHOR]; | ||
articleViewController.attributedBody = dataDictionary[k_BODY]; | ||
articleViewController.date = dataDictionary[k_DATE]; | ||
|
||
[self.navigationController pushViewController:articleViewController animated:YES]; | ||
} | ||
``` | ||
|
||
|
||
## To-Do List | ||
- [ ] Adjust image view size and proportions. | ||
- [ ] Use [ColorArt] instead of [Chamaleon] (?) | ||
|
||
|
||
[MRArticleViewController]: https://github.com/mrigdon/MRArticleViewController | ||
[ColorArt]: https://github.com/vinhnx/ColorArt | ||
[Chamaleon]: https://github.com/ViccAlexander/Chameleon |