Reactive Programming in Swift
Swift Objective-C Other
Latest commit 2969fbe Aug 27, 2016 @kzaher kzaher Fixes for issue template.
Permalink
Failed to load latest commit information.
Documentation Updates documentation for 3.0.0.alpha.1 Aug 21, 2016
Preprocessor Fixes for Swift 3.0 Jul 23, 2016
Rx.playground Updates documentation for 3.0.0.alpha.1 Aug 21, 2016
Rx.xcodeproj Fixes RxCocoa compilation issues. Aug 18, 2016
Rx.xcworkspace Changes order of pre-release tests. Aug 20, 2016
RxBlocking Improves version detection. Aug 21, 2016
RxCocoa Fixes deprecated warnings. Aug 21, 2016
RxExample Improves deprecation messages for table and collection views. #841 Aug 21, 2016
RxSwift Updates documentation for 3.0.0.alpha.1 Aug 21, 2016
RxTests Updates documentation for 3.0.0.alpha.1 Aug 21, 2016
Sources Adds test to Linux tests. May 31, 2016
Tests Updates documentation for 3.0.0.alpha.1 Aug 21, 2016
assets Adds proper attribution to Rx Logo and license (at least I think it d… May 19, 2015
scripts Improves version detection. Aug 21, 2016
.gitignore RxSwift compiles first time on Linux. Dec 26, 2015
.jazzy.yml Add a .jazzy.yml file and scripts that create and update it Jun 8, 2016
.travis.yml Adds printing of environment info. Jul 10, 2016
CHANGELOG.md Adds 3.0.0.alpha.1 changes to CHANGELOG. Aug 21, 2016
CODE_OF_CONDUCT.md Fixes contact info. May 21, 2016
CONTRIBUTING.md Improves CONTRIBUTING.md Jun 26, 2016
Dangerfile Adds `swift-3.0` as valid branch in Dangerfile. Jul 10, 2016
Gemfile Danger base setup Jun 3, 2016
Gemfile.lock Danger base setup Jun 3, 2016
ISSUE_TEMPLATE.md Fixes for issue template. Aug 27, 2016
LICENSE.md Standardizes header format. Dec 29, 2015
Package.swift Update for Xcode 8 beta 5 Aug 9, 2016
README.md Updates README.md with Swift 2.3 version. Aug 27, 2016
RxBlocking.podspec Release 3.0.0.alpha.1 Aug 21, 2016
RxCocoa.podspec Release 3.0.0.alpha.1 Aug 21, 2016
RxSwift.podspec Release 3.0.0.alpha.1 Aug 21, 2016
RxTests.podspec Release 3.0.0.alpha.1 Aug 21, 2016

README.md

Miss Electric Eel 2016 RxSwift: ReactiveX for Swift

Travis CI platforms pod Carthage compatible

About Rx

⚠️ This readme describes RxSwift 3.0 version that requires Swift 3.0⚠️

⚠️ If you are looking for Swift 2.3 compatible version, please take a look at RxSwift ~> 2.0 versions and swift-2.3 branch ⚠️

Rx is a generic abstraction of computation expressed through Observable<Element> interface.

This is a Swift version of Rx.

It tries to port as many concepts from the original version as possible, but some concepts were adapted for more pleasant and performant integration with iOS/OSX environment.

Cross platform documentation can be found on ReactiveX.io.

Like the original Rx, its intention is to enable easy composition of asynchronous operations and event/data streams.

KVO observing, async operations and streams are all unified under abstraction of sequence. This is the reason why Rx is so simple, elegant and powerful.

I came here because I want to ...

... understand
... install
... hack around
... interact
... compare
... find compatible
... see the broader vision
  • Does this exist for Android? RxJava
  • Where is all of this going, what is the future, what about reactive architectures, how do you design entire apps this way? Cycle.js - this is javascript, but RxJS is javascript version of Rx.

Usage

Here's an example In Action
Define search for GitHub repositories ...
let searchResults = searchBar.rx.text
    .throttle(0.3, scheduler: MainScheduler.instance)
    .distinctUntilChanged()
    .flatMapLatest { query -> Observable<[Repository]> in
        if query.isEmpty {
            return Observable.just([])
        }

        return searchGitHub(query)
            .catchErrorJustReturn([])
    }
    .observeOn(MainScheduler.instance)
... then bind the results to your tableview
searchResults
    .bindTo(tableView.rx.items(cellIdentifier: "Cell")) {
        (index, repository: Repository, cell) in
        cell.textLabel?.text = repository.name
        cell.detailTextLabel?.text = repository.url
    }
    .addDisposableTo(disposeBag)

Requirements

  • Xcode 8.0 beta 6 (8S201h)
  • Swift 3.0

  • iOS 8.0+

  • Mac OS X 10.10+
  • tvOS 9.0+
  • watchOS 2.0+

Installation

Rx doesn't contain any external dependencies.

These are currently the supported options:

Manual

Open Rx.xcworkspace, choose RxExample and hit run. This method will build everything and run the sample app

CocoaPods

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'RxSwift',    '~> 3.0.0.alpha.1'
    pod 'RxCocoa',    '~> 3.0.0.alpha.1'
end

# RxTests and RxBlocking make the most sense in the context of unit/integration tests
target 'YOUR_TESTING_TARGET' do
    pod 'RxBlocking', '~> 3.0.0.alpha.1'
    pod 'RxTests',    '~> 3.0.0.alpha.1'
end

Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:

⚠️ If you want to use CocoaPods with Xcode 8.0 beta and Swift 3.0, you might need to add the following lines to your podfile: ⚠️

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['SWIFT_VERSION'] = '3.0'
      config.build_settings['MACOSX_DEPLOYMENT_TARGET'] = '10.10'
    end
  end
end
$ pod install

Carthage

Add this to Cartfile

github "ReactiveX/RxSwift" "3.0.0.alpha.1"
$ carthage update

Manually using git submodules

  • Add RxSwift as a submodule
$ git submodule add git@github.com:ReactiveX/RxSwift.git
  • Drag Rx.xcodeproj into Project Navigator
  • Go to Project > Targets > Build Phases > Link Binary With Libraries, click + and select RxSwift-[Platform] and RxCocoa-[Platform] targets

References