Repository files navigation

Streams of values over time. Tailored for Swift.

🎉Getting Started 🚄Release Roadmap

ReactiveSwift offers composable, declarative and flexible primitives that are built around the grand concept ofstreams 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 andkey-value observing (KVO).

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

1. Core Reactive Primitives

   An overview of the semantics and example use cases of the ReactiveSwift primitives, includingSignal,SignalProducer,Property andAction.

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.

   

4. How does ReactiveSwift relate to RxSwift?

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

1. Interactive Form UI

   ReactiveSwift includes aUI Examples playground, which demonstrates:

   • how to build an interactive form UI with bindings, properties andActions, 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

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

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

If you useCarthage to manage your dependencies, simply addReactiveSwift to yourCartfile:

github "ReactiveCocoa/ReactiveSwift" ~> 5.0

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

If you useCocoaPods to manage your dependencies, simply addReactiveSwift to yourPodfile:

pod 'ReactiveSwift', '~> 5.0'

If you use Swift Package Manager, simply add ReactiveSwift as a dependencyof your package inPackage.swift:

.package(url: "https://github.com/ReactiveCocoa/ReactiveSwift.git", from: "5.0.0")

1. Add the ReactiveSwift repository as asubmodule of yourapplication’s repository.
2. Rungit submodule update --init --recursive from within the ReactiveCocoa folder.
3. Drag and dropReactiveSwift.xcodeproj into your application’s Xcodeproject or workspace.
4. On the “General” tab of your application target’s settings, addReactiveSwift.framework to the “Embedded Binaries” section.
5. If your application target does not contain Swift code at all, you should alsoset theEMBEDDED_CONTENT_CONTAINS_SWIFT build setting to “Yes”.

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 --recursiveOR, if you haveCarthage installed
   • carthage checkout
3. OpenReactiveSwift.xcworkspace
4. BuildReactiveSwift-macOS scheme
5. Finally open theReactiveSwift.playground
6. ChooseView > Show Debug Area

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

Current Stable 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.