Streams of values over time
Swift Other
Latest commit 97326d3 Sep 25, 2017 @ikesyo ikesyo committed with NachoSoto [gardening] Utilize `Lifetime.make()`
Permalink
Failed to load latest commit information.
.github Create a PR template. [skip ci] May 27, 2017
Carthage/Checkouts Update Nimble to 7.0.1 for Xcode 9 compatibility Jun 7, 2017
Documentation Scheduler Protocol is now called just 'Scheduler' Aug 16, 2017
Logo Maintain a docset feed alongside docs generation. Apr 15, 2017
ReactiveSwift-UIExamples.playground Add a missing import in a UI playground source. Sep 24, 2017
ReactiveSwift.playground Fix links in ReactiveSwift.playground Jul 6, 2017
ReactiveSwift.xcodeproj Disable code coverage for the macOS target. Sep 16, 2017
ReactiveSwift.xcworkspace Move the ActionProperty into a separated playground. Dec 26, 2016
Sources [gardening] Utilize `Lifetime.make()` Sep 25, 2017
Tests 2.1.0-alpha.1 Sep 15, 2017
script Disable playground in Xcode 9 for now. Jul 8, 2017
.gitignore Update .gitignore May 11, 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 Update `.swift-version` to 3.1. Mar 30, 2017
.swiftlint.yml Make trailing_comma rule mandatory for SwiftLint. Run swiftlint autoc… Jul 21, 2017
.travis.yml Use latest 4.0-DEVELOPMENT-SNAPSHOT Aug 9, 2017
CHANGELOG.md 2.1.0-alpha.2 Sep 16, 2017
CONTRIBUTING.md Fixed typos. Moved internal docs out of the Documentation folder. Dec 26, 2016
Cartfile Update Result to 3.2.1 for Swift 3.1 compatibility on Linux Mar 4, 2017
Cartfile.private Update Nimble to 7.0.1 for Xcode 9 compatibility Jun 7, 2017
Cartfile.resolved Update Nimble to 7.0.1 for Xcode 9 compatibility Jun 7, 2017
CodeOfConduct.md Replace the placeholder in the code of conduct. Dec 29, 2016
LICENSE.md Update LICENSE.md Feb 7, 2016
Package.pins Update Nimble to 7.0.1 for Xcode 9 compatibility Jun 7, 2017
Package.resolved Make tests compatible with Swift 4 Jun 8, 2017
Package.swift Parse more truthy values when checking swift test environment Jun 14, 2017
README.md Mention ReactiveCollections. [skip ci] Jul 30, 2017
ReactiveSwift.podspec 2.1.0-alpha.2 Sep 16, 2017

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 3.0.x platforms

☕️ Looking for Cocoa extensions? 🎉 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. 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" ~> 2.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', '~> 2.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: 2)

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

Swift 3.2 and Swift 4.0 compatibility

While the development would be Swift 3.2 and Swift 4.0 aware, ReactiveSwift 2.0 would not declare official support until Swift 3.2 and Swift 4.0 launch.

The official release for Swift 3.2 and Swift 4.0 is expected to be a minor 2.x release with full API compatibility.

Plan of Record

ReactiveCollections

Collection support in ReactiveSwift is currently being iterated in ReactiveCollections. Contributions are welcomed.

ReactiveSwift 3.0

ReactiveSwift 3.0 is expected to declare library ABI stability as it adopts generics features arriving in a later Swift 4 release, e.g. conditional conformance. There is no ETA for now.