/RxSwiftUtilities

Helpful classes and extensions for RxSwift

Primary LanguageSwiftMIT LicenseMIT

RxSwiftUtilities

CocoaPods Compatible Carthage Compatible Platform CI codecov

About

Helpful classes and extensions for RxSwift which don't belong in RxSwift core.

Usage

Check out the Documentation, the examples below, or the Example App.

ActivityIndicator

let signingIn = ActivityIndicator()

let signedIn = loginButtonTap.withLatestFrom(usernameAndPassword)
    .flatMapLatest { (username, password) in
        return API.signup(username, password: password)
            .trackActivity(signingIn)
    }
}

signingIn.asDriver()
    .drive(UIApplication.shared.rx.isNetworkActivityIndicatorVisible)
    .disposed(by: disposeBag)

Two-way binding

(textField.rx.text <-> variable)
    .disposed(by: disposeBag)

Example App

This repo contains an Example App with interactive examples.

To use the Example App:

cd ExampleApp
pod install

Open the project located in ExampleApp/ with Xcode and build/run it.

Requirements

  • Xcode 11
  • Swift 5

Installation

CocoaPods

Tested with pod --version: 1.1.1

In your Podfile:

use_frameworks!

target "YOUR_TARGET_NAME" do
  pod "RxSwiftUtilities"
end

Replace YOUR_TARGET_NAME and then, in the same directory, run:

pod install

Swift Package Manager

Tested with xcode version: 11.5

Add the dependency with xcode via Files>Swift Packages>Add Package Dependency...

Or

Create a Package.swift file.

// swift-tools-version:5.1

import PackageDescription

let package = Package(
  name: "RxSwiftUtiliesTestProject",
  dependencies: [
    .package(url: "https://github.com/RxSwiftCommunity/RxSwiftUtilities", from: "5.0.0")
  ],
  targets: [
    .target(name: "RxSwiftUtiliesTestProject", dependencies: ["RxSwiftUtilities"])
  ]
)
$ swift build

Carthage

Tested with carthage version: 0.18

Add this to Cartfile

github "RxSwiftCommunity/RxSwiftUtilities"

In the same directory, run:

carthage update

Link/Embed frameworks as explained here. Besides linking RxSwiftUtilities, you will also need to link RxSwift and RxCocoa.

Contributing

Help is always appreciated!

git clone git@github.com:RxSwiftCommunity/RxSwiftUtilities.git
cd RxSwiftUtilities

Or use your own forked repo.

carthage bootstrap

This is necessary in order to be able to build the framework on its own and run tests. However, if you prefer, you can instead develop it while it's within another project.

Before submitting a PR, please make sure that the tests pass.