Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xtro/swiftmvi
A lightweight MVI framework for Swift
https://github.com/xtro/swiftmvi
clean-architecture combine concurrency concurrent-programming framework intent mvi mvi-architecture state swift swift-package-manager swift-packages swift5 swiftui unidirectional-data-flow
Last synced: 5 days ago
JSON representation
A lightweight MVI framework for Swift
- Host: GitHub
- URL: https://github.com/xtro/swiftmvi
- Owner: xtro
- License: mit
- Created: 2022-12-25T09:24:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-09T19:03:24.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T22:05:53.995Z (9 months ago)
- Topics: clean-architecture, combine, concurrency, concurrent-programming, framework, intent, mvi, mvi-architecture, state, swift, swift-package-manager, swift-packages, swift5, swiftui, unidirectional-data-flow
- Language: Swift
- Homepage:
- Size: 596 KB
- Stars: 22
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# SwiftMVI
[](https://github.com/xtro/SwiftMVI/actions/workflows/swift.yml)  [](https://github.com/apple/swift-package-manager)  
**SwiftMVI** is an open-source library of conformables and extensions for swift, which provides an ability to build an MVI architecture with independent ``UseCases`` in SwiftUI.
## Overview
**SwiftMVI** provides the following features:
- Lightweight & scalable: Wide range of possible implementations from a single reducer to complex feature with child modules.
- Customizable workflows: You can build many variations by conform to ``Reducibles`` and ``Reducers``.
- A simple but very effective API bind parts together, including your existing combine publishers.
- Usable view protocols to implement your own feature driven view.
The main goal is a set of protocols for archiving structured data-flow with minimal effort.
But if you familiar with MVI architecture, there are some important differences compared to other MVI implementations:
- a State can be reference or value type. The reducers mutating the actual state via `Processing`, using `state()` methods, and a reducer always returns Void, if you must to handle an effect use `effect()` method.
- On the view side, you can choose between`ObservableObject` or `statePublisher` for updating.
- Your existing Combine publishers can be connected using `bind` method to a ``Feature``, and a ``Feature`` can behave as a `Publisher`, when your feature comforms to `EventReducer`.
## Installation
You can use Swift Package Manager to integrate the library by adding the following dependency in your Package.swift file or by adding directly within Xcode:
```swift
.package(url: "https://github.com/xtro/SwiftMVI.git", .upToNextMajor(from: "0.2.0"))
```
## Usage
- [Example application](https://github.com/xtro/SwiftMVI-Examples)
- [Getting Started](Documentation/SwiftMVI.docc/Getting_Started.md)
- [Parts of SwiftMVI](Documentation/SwiftMVI.docc/Parts.md)
### Example
Feature:
```swift
class CounterFeature: ReducibleState, IntentReducer, Processing {
var state: Int
var statePublisher: StatePublisher
init(state: Int = 0) {
self.state = state
self.statePublisher = .init(state)
}
enum Intent {
case increment
case decrement
}
func reduce(intent: Intent) {
switch intent {
case .increment:
state {
$0 + 1
}
case .decrement:
state {
$0 - 1
}
}
}
}
```
View:
```swift
struct CounterView: FeatureView {
let feature: CounterFeature
func body(_ newState: Int) -> some View {
VStack {
HStack {
Button("−") { feature(.decrement) }
Text("\(newState)")
Button("+") { feature(.increment) }
}
}
}
}
```
## Sponsors
SwiftMVI is an MIT-licensed open-source project with its ongoing development made possible entirely by the support of awesome backers. If you'd like to join them, please consider sponsoring this development.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
This library is released under the [MIT](https://choosealicense.com/licenses/mit/) license. See LICENSE for details.