Swiftpack.co - Package - ReactiveX/RxSwift

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
... 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(0.3, 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

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

Tested with pod --version: 1.3.1

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'RxSwift',    '~> 4.0'
    pod 'RxCocoa',    '~> 4.0'
end

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

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

$ pod install

Carthage

Tested with carthage version: 0.26.2

Add this to Cartfile

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

Swift Package Manager

Tested with swift build --version: Swift 4.0.0-dev (swiftpm-13126)

Create a Package.swift file.

// swift-tools-version:4.0

import PackageDescription

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

To build or test a module with RxTest dependency, set TEST=1. (RxSwift >= 3.4.2)

$ 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

Github

link
Stars: 11774
Help us keep the lights on

Dependencies

Used By

Total:

Releases

4.0.0 - Oct 17, 2017

  • Adds global Hooks and implements error handling hook.
  • Deprecates asSharedSequence extensions on ObservableType.
  • Publicly exposes controlProperty.

Anomalies

  • Changes Observable extensions to ObservableType extensions.
  • Changes UITableView.didUpdateFocusInContextWithAnimationCoordinator extension argument to UITableViewFocusUpdateContext.
  • Changes access modifier of DelegateProxy.setForwardToDelegate to open.

4.0.0-rc.0 - Oct 8, 2017

  • Deprecates image(transitionType:) in favor of image.
  • Changes return type of ignoreElements to Completable. #1436
  • Removes warning of sequence completion from Binder. #1431
  • Deprecates Variable in favor of BehaviorRelay.

4.0.0-beta.1 - Oct 1, 2017

  • Adds attributedText to UITextField. #1249
  • Adds attributedText to UITextView. #1249
  • Deprecates shareReplayLatestWhileConnected and shareReplay in favor of share(replay:scope:). #1430
  • Changes publish, replay, replayAll to clear state in case of sequence termination to be more consistent with other Rx implementations and enable retries. #1430
  • Replaces share with default implementation of share(replay:scope:). #1430
  • Adds HasDelegate and HasDataSource protocols.
  • Updates package version to v4 format. #1418

Anomalies

  • Adds deprecated warnings to API parts that were missing it. #1427
  • Improves memory handling in isScheduleRequiredKey. #1428
  • Removes pre-release identifier from bundle version to enable TestFlight submissions. #1424
  • Removes code coverage to enable TestFlight submissions. #1423
  • Fixes Xcode warnings. #1421

4.0.0-beta.0 - Sep 18, 2017

  • Adds materialize() operator for RxBlocking's BlockingObservable. #1383
  • Adds first operator to ObservableType.
  • Deprecates UIBindingObserver in favor of Binder. #1411
  • Adds another specialization of SharedSequence called Signal.
  • Refactors DelegateProxy to be type safe.
  • Changes nested SharedSequence strategy to use inner sharing strategy for result.

Anomalies

  • Call controlTextDidChange(…) as an optional method. #1406
  • Fixed issue with NSControl.rx.value regarding multiple observers. #1399
  • Removes useless extensions from PrimitiveSequence. #1248

4.0.0-alpha.1 - Aug 20, 2017

  • Merges 3.6.1 changes.
  • Adds UIScrollView.willEndDragging extension. #1365
  • Adds enumerated operator (deprecates skipWhileWithIndex, takeWhileWithIndex, flatMapWithIndex, mapWithIndex).

Anomalies

  • Fixes gesture recognizer extensions crash. #1382
  • Adds onSubscribed parameter to SharedSequence extensions.