Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ustwo/baseviewcontroller-swift
An organizational tool for writing custom view controllers using UIKit.
https://github.com/ustwo/baseviewcontroller-swift
ios swift tvos uikit
Last synced: about 2 months ago
JSON representation
An organizational tool for writing custom view controllers using UIKit.
- Host: GitHub
- URL: https://github.com/ustwo/baseviewcontroller-swift
- Owner: ustwo
- License: mit
- Created: 2016-01-06T09:09:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T11:00:07.000Z (about 5 years ago)
- Last Synced: 2024-10-20T16:02:39.569Z (2 months ago)
- Topics: ios, swift, tvos, uikit
- Language: Ruby
- Homepage:
- Size: 295 KB
- Stars: 8
- Watchers: 9
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/ustwo/baseviewcontroller-swift/blob/master/LICENSE)
[](https://travis-ci.org/ustwo/baseviewcontroller-swift)
[](https://codecov.io/github/ustwo/baseviewcontroller-swift?branch=master)
[](https://ustwo.github.io/baseviewcontroller-swift)
# BaseViewController
The BaseViewController framework provides an organizational tool for writing custom view controllers using `UIKit`. This framework is written using Swift 3.0. It has been developed and used by iOS developers at [ustwo](https://ustwo.com/).
## Dependencies
* [Xcode](https://itunes.apple.com/gb/app/xcode/id497799835?mt=12#)
## Installation
### BaseViewControllerSwift version vs Swift version.
Because of the many Swift versions BaseViewControllerSwift supports, it might be confusing to find the version of BaseViewControllerSwift that you need. Below is a table that shows which version of BaseViewControllerSwift you should use for your Swift version.
| Swift version | BaseViewControllerSwift version |
|---------------|---------------------------------|
| 5.0 | 3.0.0 |
| 3.0 | 2.0.0 |
| 2.1 | 1.0.0 |
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate BaseViewControllerSwift into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.3'
use_frameworks!
pod 'BaseViewControllerSwift', '~> 2.0'
```
Then, run the following command:
```bash
$ pod install
```
### Manually
If you prefer not to use either of the aforementioned dependency managers, you can integrate BaseViewControllerSwift into your project manually. Add the `BaseViewController.swift` file from the `Sources` folder to your Xcode project.
## Usage
Use the `BaseViewController` as a base class for all your custom view controllers. Then override our common setup functions and have them automatically called as part of the initialization.
`BaseViewController` itself is a subclass of `UIViewController`. It contains two empty setup functions that are called by `viewDidLoad()`. These commonly used setup functions are `setupView()` and `setupAccessibility()` and are called in that order.
In addition, `BaseViewController` is also a generic class that takes a `UIView` as a type parameter. During the `loadView()` phase, it instantiates the view and sets it as the controller's view. `BaseViewController` also provides a `underlyingView` property for accessing the view without needing to type cast.
## Examples
Here are some example implementations of using `BaseViewController`. In all of the examples we call `super` on the setup function, but do this as appropriate in your own code.
### Controller Definition
When defining your custom view controller, inherit from `BaseViewController` and specify your custom view. There is no need to instantiate your custom view or add an accessing property. This is all done by `BaseViewController`.
```swift
final class ProfileViewController: BaseViewController {
...
}
```
### setupView
Use the `setupView()` function to add target/actions to controls, set dynamically generated values, etc.
```swift
override func setupView() {
super.setupView()
underlyingView.titleLabel.text = profile.name
underlyingView.finishedButton.addTarget(self, action: #selector(ProfileViewController.finishedButtonPressed(_:)), for: .touchUpInside)
}
```
### setupAccessibility
Use the `setupAccessibility()` function to add dynamically generated accessibility information to the view.
```swift
override func setupAccessibility() {
super.setupAccessibility()
underlyingView.profileImage.accessibilityLabel = NSLocalizedString("Image of", comment: "") + " " + profile.name
}
```
## Maintainers
* Shagun Madhikarmi (@madhikarma)
* Aaron McTavish (@aamctustwo)
## Contact
* [[email protected]](mailto:[email protected])
## License
BaseViewControllerSwift is released under the MIT License. See the LICENSE file.