swift-tca-loadable

A swift package for handling loadable items using The Composable Architecture.

• Installation
• Basic Usage
• Documenation

Installation

---

Install this package in your project using swift package manager.

let package = Package(
  ...
  dependencies: [
    ...
    .package(url: "https://github.com/m-housh/swift-tca-loadable.git", from: "0.2.0")
  ]
  ...
)

Notes

---

Version 0.3.+ brings breaking changes from the previous versions. Version 0.3.* updates to using the ReducerProtocol from the composable architecture.

Basic Usage

---

This package provides a LoadableView and several types that are used inside of your Reducer implementations.

LoadableView

Below shows an example Reducer and uses the LoadableView.

import ComposableArchitecture
import Loadable
import SwiftUI
 
struct App: Reducer {
  struct State: Equatable {
    @LoadableState var int: Int?
  }

  enum Action: Equatable, LoadableAction {
    case loadable(LoadingAction<Int>)
  }

  @Dependency(\.continuousClock) var clock;
  
  var body: some ReducerOf<Self> {
    Reduce { state, action in
      switch action {
      case .loadable(.load):
        return .load {
          /// sleep to act like data is loading from a remote.
          try await clock.sleep(for: .seconds(2))
          return 42
        }
      case .loadable:
        return .none
      }
    }
    .loadable(state: \.$int)
  }
}

struct ContentView: View {
  let store: StoreOf<App>
  var body: some View {
    VStack {
      LoadableView(store: store.scope(state: \.$int, action: Preview.Action.int)) {
        WithViewStore($0, observe: { $0 }) { viewStore in
          Text("Loaded: \(viewStore.state)")
        }
      Button(action: { ViewStore(store).send(.load) }) {
        Text("Reload")
      }
      .padding(.top)
    }
    .padding()
  }
}

The above uses the default ProgressView‘s when the items are in a notRequested or isLoading state, but you can override each view.

struct ContentView: View {

  let store: StoreOf<App>
    
  var body: some View {
    LoadableView(
      store: store.scope(state: \.$score, action: App.Action.int)
    ) { scoreStore in
      // The view when we have loaded content.
      WithViewStore(scoreStore) { viewStore in
        Text("Your score is: \(viewStore.state)")
      }
    } isLoading: { (isLoadingStore: Store<Int?, App.Action>) in 
      MyCustomIsLoadingView(store: isLoadingStore)
    } notRequested: { (notRequestedStore: Store<Void, App.Action>) in 
      MyCustomNotRequestedView(store: notRequestedStore)
    }
  }
}

Documentation

---

You can view the api documentation on the here.