Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andylindebros/swiftreduxtoaster
https://github.com/andylindebros/swiftreduxtoaster
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andylindebros/swiftreduxtoaster
- Owner: andylindebros
- License: mit
- Created: 2023-07-12T19:59:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T16:49:05.000Z (11 months ago)
- Last Synced: 2024-02-21T17:47:44.743Z (11 months ago)
- Language: Swift
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftReduxToaster
SwiftReduxToaster provides a notification view for a Swift redux app
## Installation
### Swift Package
Add the Swift package to your dependencies
``` Swift
dependencies: [
.package(url: "https://github.com/andylindebros/SwiftReduxToaster.git", .upToNextMajor(from: "0.0.0"))
]
```
## MVVM Implementation
```Swift
@MainActor struct ToasterExampleApp: App {
let viewModel: MVVMWrapper(state: ToasterState(activeNavigationId: UUID()))
var body: some Scene {
WindowGroup {
ZStack {
Button(action: {
viewModel.dispatch(ToasterAction.add(ToasterModel(type: .success, title: "Awesome!")))
}) {
Text("Trigger notification")
}
ToasterView(
state: viewModel.state,
dispatch: { action in
guard let action = action as? ToasterAction else { return }
viewModel.dispatch(action)
},
navigationId: viewModel.state.activeNavigationId ?? UUID()
) { model, task in
DefaultToast(model: model, task: task, onClose: {
viewModel.dispatch(ToasterAction.dismiss(model))
})
}
}
}
}
}
```
## Redux Implementation
1. Add the state of the SwiftReduxToaster to the AppState
```Swift
struct AppState: Codable {
private(set) var toaster: ToasterState
@MainActor static func createStore(
initState: AppState
) -> Store {
Store(reducer: AppState.reducer, state: initState, middleware: [Middleware]())
}
@MainActor static func reducer(action: Action, state: AppState) -> AppState {
AppState(toaster: ToasterState.reducer(action: action, state: state.toaster))
}
}
```
1. Implement the toaster in your UI
``` Swift
@MainActor struct ToasterExampleApp: App {
let store = AppState.createStore(initState: AppState.initState)
var body: some Scene {
WindowGroup {
ZStack {
Button(action: {
store.dispatch(ToasterAction.add(ToasterModel(
type: .success,
title: "Success toast",
message: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
)))
}) {
Text("Trigger notificaiton")
}
SwiftReduxToaster.ToasterView(
state: store.state.toaster,
dispatch: { action in
guard let action = action as? Action else { return }
store.dispatch(action)
},
navigationId: navigationId
) { model, task in
DefaultToast(
model: model,
task: task,
onClose: {
dispatch(ToasterAction.dismiss(model))
}
)
}
}
}
}
}
```
## Options
You can customize the notification by changing the properties of the ToasterModel
```Swift
struct ToasterModel{
var id: UUID // The id of the notification
let type: ToasterType // success, info, warning, error
let title: String // The title of the notification
let message: String? // the message of the notification
let target: Target // Limitation of views that should show the notification (Useful if you have multiple view implementations). Default: .all
let timeoutInterval: Int // Dismiss after number of seconds. Default is 7. Disable it by setting it to zero
let isDismissable: Bool // Defines if the user can dismiss it or not. Default: true
let url: URL? // Pass a url that can be use in future actions. Useful when working with deep links
}
store.dispatch(ToasterAction.add(ToasterModel(
type: .warning,
target: .all,
title: "Warning!",
message: "No internet connection available",
timeoutInterval: 0,
isDismissable: false
)))
```
## Custom view
You can create and implement your own view for the toaster. Just replace `DefaultToast` with your custom view.
```Swift
ToasterView(
state: store.state.toaster,
dispatch: { action in
guard let action = action as? Action else { return }
store.dispatch(action)
},
navigationId: navigationId
) { model, _ in
HStack {
Text(model.title)
Button(action: {
store.disaptch(ToasterAction.dismiss(model))
}) {
Text("Dismiss")
}
}
}
```