Streams of values over time
Swift Other
Permalink
Failed to load latest commit information.
.github Create a PR template. [skip ci] May 27, 2017
Carthage/Checkouts Update Nimble carthage checkout Jun 27, 2018
Documentation Fix Signal and SignalProducer link in BasicOperators.md (#631) Apr 6, 2018
Logo Maintain a docset feed alongside docs generation. Apr 15, 2017
ReactiveSwift-UIExamples.playground Remove --no-use-binaries option Jul 7, 2018
ReactiveSwift.playground remove unneeded `? true : false` (#662) Jul 31, 2018
ReactiveSwift.xcodeproj Xcode 10 support (#644) Jun 12, 2018
ReactiveSwift.xcworkspace Swift 4.1 migration (#590) May 14, 2018
Sources Add convenience inits to Action to use a ValidatingProperty as its st… Jul 29, 2018
Tests Add convenience inits to Action to use a ValidatingProperty as its st… Jul 29, 2018
script Update the CI playground validation script. Jan 20, 2018
.gitignore Remove redundant constraints. (#535) Oct 14, 2017
.gitmodules Switch back to Quick/Nimble Sep 3, 2016
.jazzy.yaml Merge pull request #384 from ReactiveCocoa/readme-split May 15, 2017
.swift-version [CI] Use Xcode 9.4 image Jun 16, 2018
.swiftlint.yml Make trailing_comma rule mandatory for SwiftLint. Run swiftlint autoc… Jul 21, 2017
.travis.yml Work around CocoaPods lint error related to `.swift-version` Jun 28, 2018
CHANGELOG.md Add convenience inits to Action to use a ValidatingProperty as its st… Jul 29, 2018
CONTRIBUTING.md Fixed typos. Moved internal docs out of the Documentation folder. Dec 26, 2016
Cartfile Swift 4.1 migration (#590) May 14, 2018
Cartfile.private Xcode 10 support (#644) Jun 12, 2018
Cartfile.resolved Xcode 10 support (#644) Jun 12, 2018
CodeOfConduct.md Replace the placeholder in the code of conduct. Dec 29, 2016
LICENSE.md Update LICENSE.md Feb 7, 2016
Package.resolved [SwiftPM] Update Nimble Jun 13, 2018
Package.swift [SwiftPM] Update Nimble Jun 13, 2018
README.md Merge back the 3.0 release branch. (#559) Nov 24, 2017
ReactiveSwift.podspec 4.0.0 Jul 17, 2018

README.md

ReactiveSwift

Streams of values over time. Tailored for Swift.

Latest ReactiveSwift Documentation Join the ReactiveSwift Slack community.


Carthage compatible CocoaPods compatible SwiftPM compatible GitHub release Swift 4.0 platforms

🎉 Getting Started 🚄 Release Roadmap

What is ReactiveSwift?

ReactiveSwift offers composable, declarative and flexible primitives that are built around the grand concept of streams of values over time.

These primitives can be used to uniformly represent common Cocoa and generic programming patterns that are fundamentally an act of observation, e.g. delegate pattern, callback closures, notifications, control actions, responder chain events, futures/promises and key-value observing (KVO).

Because all of these different mechanisms can be represented in the same way, it’s easy to declaratively compose them together, with less spaghetti code and state to bridge the gap.

Getting Started

  1. Core Reactive Primitives

    An overview of the semantics and example use cases of the ReactiveSwift primitives, including Signal, SignalProducer, Property and Action.

  2. Basic Operators

    An overview of the operators provided to compose and transform streams of values.

  3. ReactiveCocoa

    Building on top of ReactiveSwift, ReactiveCocoa extends Cocoa platform frameworks with reactive bindings and extensions.

    GitHub releaseCarthage compatible CocoaPods compatible

  4. How does ReactiveSwift relate to RxSwift?

    An overview of how ReactiveSwift differs from RxSwift for Swift idiomaticity.

Examples

  1. Interactive Form UI

    ReactiveSwift includes a UI Examples playground, which demonstrates:

    • how to build an interactive form UI with bindings, properties and Actions, with a live view in action.
    • how to use reactive primitives to implement the Model-View-ViewModel architectural pattern, with the View Model being the source of truth for the View.
  2. Online Searching

Advanced Topics

  1. ReactiveCocoa

    Bindings and reactive extensions for Cocoa and Cocoa Touch frameworks are offered separately as ReactiveCocoa.

  2. API Reference

  3. API Contracts

    Contracts of the ReactiveSwift primitives, Best Practices with ReactiveSwift, and Guidelines on implementing custom operators.

  4. Debugging Techniques

Installation

ReactiveSwift supports macOS 10.9+, iOS 8.0+, watchOS 2.0+, tvOS 9.0+ and Linux.

Carthage

If you use Carthage to manage your dependencies, simply add ReactiveSwift to your Cartfile:

github "ReactiveCocoa/ReactiveSwift" ~> 3.0

If you use Carthage to build your dependencies, make sure you have added ReactiveSwift.framework, and Result.framework to the "Linked Frameworks and Libraries" section of your target, and have included them in your Carthage framework copying build phase.

CocoaPods

If you use CocoaPods to manage your dependencies, simply add ReactiveSwift to your Podfile:

pod 'ReactiveSwift', '~> 3.0'

Swift Package Manager

If you use Swift Package Manager, simply add ReactiveSwift as a dependency of your package in Package.swift:

.Package(url: "https://github.com/ReactiveCocoa/ReactiveSwift.git", majorVersion: 3)

Git submodule

  1. Add the ReactiveSwift repository as a submodule of your application’s repository.
  2. Run git submodule update --init --recursive from within the ReactiveCocoa folder.
  3. Drag and drop ReactiveSwift.xcodeproj and Carthage/Checkouts/Result/Result.xcodeproj into your application’s Xcode project or workspace.
  4. On the “General” tab of your application target’s settings, add ReactiveSwift.framework, and Result.framework to the “Embedded Binaries” section.
  5. If your application target does not contain Swift code at all, you should also set the EMBEDDED_CONTENT_CONTAINS_SWIFT build setting to “Yes”.

Playground

We also provide a great Playground, so you can get used to ReactiveCocoa's operators. In order to start using it:

  1. Clone the ReactiveSwift repository.
  2. Retrieve the project dependencies using one of the following terminal commands from the ReactiveSwift project root directory:
    • git submodule update --init --recursive OR, if you have Carthage installed
    • carthage checkout
  3. Open ReactiveSwift.xcworkspace
  4. Build Result-Mac scheme
  5. Build ReactiveSwift-macOS scheme
  6. Finally open the ReactiveSwift.playground
  7. Choose View > Show Debug Area

Have a question?

If you need any help, please visit our GitHub issues or Stack Overflow. Feel free to file an issue if you do not manage to find any solution from the archives.

Release Roadmap

Current Stable Release:
GitHub release

Plan of Record

ABI stability release

ReactiveSwift is expected to declare library ABI stability when Swift rolls out resilence support. Until then, ReactiveSwift would incrementally adopt new language features that help move towards to goal. The ETA is Swift 5.