https://github.com/RxSugar/RxSugar

Simple RxSwift extensions for interacting with Apple APIs
https://github.com/RxSugar/RxSugar

frp ios reactive rxswift rxswift-extensions swift

Last synced: about 2 months ago
JSON representation

Simple RxSwift extensions for interacting with Apple APIs

• Host: GitHub
• URL: https://github.com/RxSugar/RxSugar
• Owner: RxSugar
• License: mit
• Created: 2016-02-03T16:15:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-12T19:01:57.000Z (over 4 years ago)
• Last Synced: 2024-07-27T18:55:11.179Z (2 months ago)
• Topics: frp, ios, reactive, rxswift, rxswift-extensions, swift
• Language: Swift
• Size: 861 KB
• Stars: 79
• Watchers: 5
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
  RxSugar

===

[![Travis CI](https://travis-ci.org/RxSugar/RxSugar.svg?branch=master)](https://travis-ci.org/RxSugar/RxSugar) ![platforms](https://img.shields.io/badge/platforms-iOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20macOS-333333.svg) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![pod](https://img.shields.io/cocoapods/v/RxSugar.svg)](https://cocoapods.org/?q=RxSugar) ![License](https://img.shields.io/badge/license-MIT-blue.svg)

Simple RxSwift extensions for interacting with Apple APIs.

## Operators that improve visualization of data flow

### _observer_ `<~` _observable_

The `<~` subscribes an observer to an observable. 

_Observer_ can be any `ObserverType`, `Variable`, or `(value)->()`closure. 

_Observable_ can be any `ObservableType`, `Variable`, or `ObservableConvertibleType`. 

This operator returns a `Disposable`.

### _disposableCollection_ `++` _disposable_

The `++` appends a `Disposable` to a collection of disposables (`DisposeBag` or `CompositeDisposable`) and returns the collection.

These operators used in combination result in an easy to visualize data flow:

```

static func bindView(view: View, model: Model, selectionHandler:(SearchResult)->()) {

	view.rxs.disposeBag

		++ view.searchResults <~ model.searchResults

		++ model.searchTerm <~ view.searchTerm

		++ selectionHandler <~ view.selectionEvents

}

```

## Foundation / UIKit extensions

RxSugar adds `Sugar` to all NSObjects as a property called rxs. The rxs property contains RxSwift bindings for many common APIs. Here are a few examples:

### NSObject

`object.rxs.disposeBag` - a collection of dispoasables that will be disposed on deinit

### UIButton

`button.rxs.tap` - an `Observable` that sends an event on every `.TouchUpInside` control event.

### UITextField

`textField.rxs.text` - a `ValueBinding` that sends an event on every `.EditingChanged` control event and sets the control's text for every event sent to it.

`textField.rxs.attributedText` - a `ValueBinding` that sends an event on every `.EditingChanged` control event and sets the control's attributedText for every event sent to it.

### UITextView

Same as UITextField, but using the `UITextViewTextDidChangeNotification` to drive events

## Adding your own Sugar

`TargetActionObservable` and `ValueBinding` provide the building blocks for creating your own interface "sugar" similar to the examples above.