Continuum
NotificationCenter based Lightweight UI / AnyObject binder.
final class ViewController: UIViewController {
@IBOutlet weak var label: UILabel!
private let viewModel: ViewModel = ViewModel()
private let center = NotificationCenter()
private let bag = ContinuumBag()
override func viewDidLoad() {
super.viewDidLoad()
center.continuum
.observe(viewModel.text, on: .main, bindTo: label, \.text)
.disposed(by: bag)
viewModel.text.value = "Binding this text to label.text!"
}
}
final class ViewModel {
let text: Variable<String>
init() {
self.text = Variable(value: "")
}
}
Usage
1. Observe object KeyPath and bind it to target KeyPath
NotificationCenter's instance has continuum property. You can access Continuum functions from it.
let center = NotificationCenter()
let observer = center.continuum.observe(viewModel, \.text, on: .main, bindTo: label, \.text)
Above source code means observe viewModel's text propety and bind that value to label's text property on main thread. If property is observed, current value comes immediately.
Notify changes with func post(keyPath:)
If value changed, notify changes like this.
viewModel.text = "Changed"
center.continuum.post(keyPath: \ViewModel.text)
print(label.text) // Changed
2. Observe Constant / Variable and bind it to target KeyPath
Constant / Variable are value wrapper. Variable has getter / setter. Constant has only getter.
let center = NotificationCenter()
let text = Variable<String>(value: "")
let observer = center.continuum.observe(text, on: .main, bindTo: label, \.text)
If property is observed, current value comes immediately.
3. Observe Constant / Variable and bind it to closure
Constant / Variable are value wrapper. Variable has getter / setter. Constant has only getter.
let center = NotificationCenter()
let text = Variable<String>(value: "")
let observer = center.continuum.observe(text, on: .main, onValueChange: { value in
// something to do
})
If property is observed, current value comes immediately.
Notify changes with setter of value at Variable
If Variable's value is changed, func post(name:object:) is automatically executed.
text.value = "Changed"
print(label.text) // Changed
In addition, if Variable's value is changed, related Constant value is automatically changed.
let center = NotificationCenter()
let variable = Variable<String>(value: "")
let constant = Constant<String>(variable: variable)
let observer = center.continuum.observe(constant, on: .main, bindTo: label, \.text)
variable.value = "Changed"
print(label.text) // Changed
Lifecycle of ContinuumObserver
func observe(_:,_:,on:,bindTo:,_:) returns ContinuumObserver. If func cancel() of ContinuumObserver called, observation is cancelled.
let observer = center.continuum.observe(viewModel, \.text, on: .main, bindTo: label, \.text)
observer.cancel()
If adding observer to ContinumeBag, observation is cancelled by lifecycle of ContinumeBag.
var bag = ContinumeBag()
center.continuum
.observe(viewModel, \.text, on: .main, bindTo: label, \.text)
.disposed(by: bag)
bag = ContinumeBag() // previous instance of ContinumeBag is released and observation is cancelled.
Example
Playground
You can try Continuum with Playground. Open Continuum.xcworkspace and run build. You can try like this.
Example Project
To run the example project, clone the repo, and run pod install from the Example directory first. Open ContinuumSample.xcworkspace and run build. You can try a simple counter app like this.
Requirements
- Xcode 9.2 or later
- Swift 4.0.3 or later
- iOS 10.0 or later
Installation
CocoaPods
Continuum is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'Continuum'
Carthage
If you’re using Carthage, simply add Continuum to your Cartfile:
github "marty-suzuki/Continuum"
Author
marty-suzuki, [email protected]
License
Continuum is available under the MIT license. See the LICENSE file for more info.
77 Feb 18, 2022
632 Dec 7, 2022
147 Nov 24, 2022
2 Oct 16, 2022
770 Jan 8, 2023
170 Nov 15, 2022
1.3k Dec 8, 2022
84 Feb 4, 2022
3 Aug 31, 2022
170 Sep 19, 2022
1.1k Dec 26, 2022
981 Dec 29, 2022
6.3k Dec 27, 2022
202 Dec 22, 2022
1 Jan 28, 2022
24 Dec 26, 2022
4 Aug 6, 2022
147 Nov 24, 2022
260 Oct 12, 2022
2k Dec 31, 2022
60 Aug 11, 2022
759 Dec 2, 2022
622 Nov 23, 2022
8 Sep 26, 2022
122 Dec 28, 2022
62 Feb 2, 2022