Skip to content
Reactive Programming in Swift
Swift Objective-C Other
Branch: master
Clone or download
Latest commit 9b31a15 Sep 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Original Slack URL brought back to life 🧟‍♂️💀 Feb 13, 2018
Documentation Add Hooks documentation, remove unexpected logs (#1988) Jun 3, 2019
Platform Reduce fileprivate usage Jul 2, 2019
Preprocessor Fix preprocessor path. Apr 15, 2019
Rx.playground Fix warnings in playground, add swiftlint disabling and reduce type-c… May 15, 2019
Rx.xcodeproj Removed support to UIWebView Sep 23, 2019
Rx.xcworkspace Polish for RxRelay podspec. Apr 29, 2019
RxBlocking Merge branch 'develop' into feature/map Jul 8, 2019
RxCocoa Removed support to UIWebView Sep 23, 2019
RxExample Reduce fileprivate usage Jul 2, 2019
RxRelay Release 5.0.1. Apr 30, 2019
RxSwift Use @available(_:_:renamed:) instead of @available(_:_:message:) to l… Sep 13, 2019
RxTest Reduce fileprivate usage Jul 2, 2019
Sources Run all-tests script Sep 23, 2019
Tests Removed support to UIWebView Sep 23, 2019
assets Adds proper attribution to Rx Logo and license (at least I think it d… May 19, 2015
scripts Allow warnings during RxCocoa podfile verification Jun 23, 2019
.gitignore Add .idea to gitignore May 29, 2019
.jazzy.yml Run jazzy script Sep 23, 2019
.swiftlint.yml Add swiftlint build phase Jan 30, 2019
.travis.yml Update Travis for RxRelay Apr 10, 2019
CHANGELOG.md Release 5.0.1. Apr 30, 2019
CODE_OF_CONDUCT.md Fixes contact info. May 21, 2016
CONTRIBUTING.md Contribution guide improvements & link from README Nov 26, 2017
Dangerfile Updating Danger. Apr 26, 2019
Gemfile Danger base setup Jun 3, 2016
Gemfile.lock Updating Danger. Apr 26, 2019
LICENSE.md Standardizes header format. Dec 29, 2015
Package.swift Improves local docker testing. Apr 28, 2019
README.md Fix a tiny mistake Jul 6, 2019
RxBlocking.podspec Release 5.0.1. Apr 30, 2019
RxCocoa.podspec Release 5.0.1. Apr 30, 2019
RxRelay.podspec Release 5.0.1. Apr 30, 2019
RxSwift.podspec Release 5.0.1. Apr 30, 2019
RxTest.podspec Release 5.0.1. Apr 30, 2019
default.profraw Release 4.0.0-beta.0 Sep 17, 2017

README.md

Miss Electric Eel 2016 RxSwift: ReactiveX for Swift

Travis CI platforms pod Carthage compatible Swift Package Manager compatible

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/macOS 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
... understand the structure

RxSwift comprises five separate components depending on eachother in the following way:

┌──────────────┐    ┌──────────────┐
│   RxCocoa    ├────▶   RxRelay    │
└───────┬──────┘    └──────┬───────┘
        │                  │        
┌───────▼──────────────────▼───────┐
│             RxSwift              │
└───────▲──────────────────▲───────┘
        │                  │        
┌───────┴──────┐    ┌──────┴───────┐
│    RxTest    │    │  RxBlocking  │
└──────────────┘    └──────────────┘
  • RxSwift: The core of RxSwift, providing the Rx standard as (mostly) defined by ReactiveX. It has no other dependencies.
  • RxCocoa: Provides Cocoa-specific capabilities for general iOS/macOS/watchOS & tvOS app development, such as Binders, Traits, and much more. It depends on both RxSwift and RxRelay.
  • RxRelay: Provides PublishRelay and BehaviorRelay, two simple wrappers around Subjects. It depends on RxSwift.
  • RxTest and RxBlocking: Provides testing capabilities for Rx-based systems. It depends on RxSwift.
... 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.orEmpty
    .throttle(.milliseconds(300), scheduler: MainScheduler.instance)
    .distinctUntilChanged()
    .flatMapLatest { query -> Observable<[Repository]> in
        if query.isEmpty {
            return .just([])
        }
        return searchGitHub(query)
            .catchErrorJustReturn([])
    }
    .observeOn(MainScheduler.instance)
... then bind the results to your tableview
searchResults
    .bind(to: tableView.rx.items(cellIdentifier: "Cell")) {
        (index, repository: Repository, cell) in
        cell.textLabel?.text = repository.name
        cell.detailTextLabel?.text = repository.url
    }
    .disposed(by: disposeBag)

Requirements

  • Xcode 10.2
  • Swift 5.0

For Xcode 10.1 and below, use RxSwift 4.5.

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', '~> 5'
    pod 'RxCocoa', '~> 5'
end

# RxTest and RxBlocking make the most sense in the context of unit/integration tests
target 'YOUR_TESTING_TARGET' do
    pod 'RxBlocking', '~> 5'
    pod 'RxTest', '~> 5'
end

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

$ pod install

Carthage

Officially supported: Carthage 0.33 and up.

Add this to Cartfile

github "ReactiveX/RxSwift" ~> 5.0
$ carthage update

Carthage as a Static Library

Carthage defaults to building RxSwift as a Dynamic Library.

If you wish to build RxSwift as a Static Library using Carthage you may use the script below to manually modify the framework type before building with Carthage:

carthage update RxSwift --platform iOS --no-build
sed -i -e 's/MACH_O_TYPE = mh_dylib/MACH_O_TYPE = staticlib/g' Carthage/Checkouts/RxSwift/Rx.xcodeproj/project.pbxproj
carthage build RxSwift --platform iOS

Swift Package Manager

Create a Package.swift file.

// swift-tools-version:5.0

import PackageDescription

let package = Package(
  name: "RxTestProject",
  dependencies: [
    .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "5.0.0")
  ],
  targets: [
    .target(name: "RxTestProject", dependencies: ["RxSwift", "RxCocoa"])
  ]
)
$ swift build

To build or test a module with RxTest dependency, set TEST=1.

$ TEST=1 swift test

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

You can’t perform that action at this time.