Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sanzaru/SimpleToast

SimpleToast is a simple, lightweight, flexible and easy to use library to show toasts / popup notifications inside iOS or MacOS applications in SwiftUI. Because of the flexibility to show any content it is also possible to use the library for showing simple modals.
https://github.com/sanzaru/SimpleToast

ios macos notification popup swift swift-package swift5 swiftui toast toast-notifications

Last synced: about 2 months ago
JSON representation

SimpleToast is a simple, lightweight, flexible and easy to use library to show toasts / popup notifications inside iOS or MacOS applications in SwiftUI. Because of the flexibility to show any content it is also possible to use the library for showing simple modals.

Awesome Lists containing this project

README 

        
# SimpleToast for SwiftUI



[![Build Status](https://travis-ci.com/sanzaru/SimpleToast.svg?branch=develop)](https://travis-ci.com/sanzaru/SimpleToast)

[![](https://tinyurl.com/3e9pprjv)](https://swiftpackageindex.com/sanzaru/SimpleToast)

[![](https://tinyurl.com/mtkte8as)](https://swiftpackageindex.com/sanzaru/SimpleToast)



SimpleToast is a simple, lightweight, flexible and easy to use library to show toasts / popup notifications inside iOS or macOS applications in SwiftUI. Because of the flexibility to show any content it is also possible to use the library for showing simple modals.



You decide the content, the library takes care about the rest.



> **⚠ī¸ Note:** The current version is still in development. There can and will be breaking changes in version updates until version 1.0.



## Features:



* Custom toast content support: You can show whatever you want inside the toast.

* Custom positioning: Place the toast where you want it to be.

* Timeout functionality: You decide if and when the toast should disappear.

* Callback functionality: Run code when the toast disappeared.

* Multiple, customizable animations



## 🚨 Breaking changes:

> **0.6.0:**

> * The options struct is modified and the parameters `showBackdrop` and `backdropColor` are replaced by a single optional Color definition `backdrop`. See [Options](#options) for more information



## Demo



| Modifier | Demo |

| -------- | ---- |

| *.slide* |  |

| *.fade* |  |

| *.scale* |  |

| *.skew* |  |



## Installation



### Swift Package Manager

```swift

dependencies: [

    .package(url: "https://github.com/sanzaru/SimpleToast.git", from: "0.0.1")

]

```



### Cocoapods



Add the following line to your Podfile:



```

pod 'SwiftUI-SimpleToast', :git => 'https://github.com/sanzaru/SimpleToast.git'

```



and run



```

pod install

```



or



```

pod update

```



## Usage:



There are different ways of attaching a toast notification to your view. The usage is very similar to well know SwiftUI view modifiers (e.g. alert or sheet). If you are familiar with these, using SimpleToast should be quiet easy.



> **Note:** The toast always appears at the edges to the view it is attached to. Make sure the view has enough space to render the toast. Preferably the toast should be attached to the most outer view or the navigation view, if available.



### Attach via boolean

You can attach the toast to a view and show it via binding to a boolean:



```swift

import SwiftUI

import SimpleToast



struct ToastTestView: View {

    @State var showToast: Bool = false



    private let toastOptions = SimpleToastOptions(

        hideAfter: 5

    )



    VStack(spacing: 20) {

        Button("Show toast") {

            withAnimation {

                showToast.toggle()

            }

        }

    }

    .simpleToast(isPresented: $showToast, options: toastOptions) {

        Label("This is some simple toast message.", systemImage: "exclamationmark.triangle")

        .padding()

        .background(Color.red.opacity(0.8))

        .foregroundColor(Color.white)

        .cornerRadius(10)

        .padding(.top)

    }

}

```



### Attach via optional object



You can trigger the toast via an instance to an optional object, which conforms to the protocol Identifiable. If the value is not nil the toast will be shown.



The following example is based on the previous one and also shows the toast, but this time based on a value on an item.



```swift

import SwiftUI

import SimpleToast



struct ToastTestView: View {

    @State var showToast: DummyItem? = nil



    private struct DummyItem: Identifiable {

        var foo: String = "Bar"

    }



    private let toastOptions = SimpleToastOptions(

        hideAfter: 5

    )



    VStack(spacing: 20) {

        Button("Show toast") {

            withAnimation {

                // Toggle the item

                showToast = showToast == nil ? DummyItem() : nil

            }

        }

    }

    .simpleToast(item: $showToast, options: toastOptions) {

        HStack {

            Image(systemName: "exclamationmark.triangle")

            Text("This is some simple toast message.")

        }

        .padding()

        .background(Color.red.opacity(0.8))

        .foregroundColor(Color.white)

        .cornerRadius(10)

    }

}

```



>  


> ℹī¸ This functionality is similar to the one of the SwiftUI [sheet(item:onDismiss:content:)](https://developer.apple.com/documentation/swiftui/view/sheet(item:ondismiss:content:))

> 
 



### Run code after dismissal



To run custom code after the toast disappeared you just have to pass a function to the `onDismiss` parameter:

```swift

import SwiftUI

import SimpleToast



struct ToastTestView: View {

    @State var showToast: Bool = false



    private let toastOptions = SimpleToastOptions(

        hideAfter: 5

    )



    VStack(spacing: 20) {

        Button("Show toast") {

            withAnimation {

                showToast.toggle()

            }

        }

    }

    .simpleToast(isShowing: $showToast, options: toastOptions, onDismiss: onToastComplete) {

        HStack {

            Image(systemName: "exclamationmark.triangle")

            Text("This is some simple toast message.")

        }

        .padding()

        .background(Color.red.opacity(0.8))

        .foregroundColor(Color.white)

        .cornerRadius(10)

    }



    // This will be called on toast completion

    func onToastComplete() -> Void {

        print("The toast did disappear")

    }

}

```



### Usage with edgesIgnoringSafeArea(_:edges:) / ignoresSafeArea(_:edges:)



If the view you're attaching the toast to is ignoring a safe area, make sure to apply the SimpleToast modifier **after** the modifier for ignoring the safe area:



```swift

VStack {

    Text("Some view")

}

.ignoresSafeArea(.all)

.simpleToast(

    ...

```



## Options



The toast can be configured via an optional SimpleToastOptions object. You can simply pass an empty object to configure the toast with default values.



>  


> 📌 All parameters inside the options are optional. If not set, the default value will be taken.

> 
 



| Option | Type | Description | Default |

| -------- | ---- | ------------- | -------- |

| **alignment** | [Alignment](https://developer.apple.com/documentation/swiftui/alignment) | Defines the alignment of the toast. | .top |

| **hideAfter** | [TimeInterval?](https://developer.apple.com/documentation/foundation/timeinterval) | Defines when the toast disappears. If nil is given the toast won't disappear. | nil |

| **backdrop** | [Color?](https://developer.apple.com/documentation/swiftui/color) | Defines the backdrop color | nil |

| **animation** | [Animation](https://developer.apple.com/documentation/swiftui/animation) | Defines the animation type. | .linear |

| **modifierType** | [ModifierType](#Demo) | Defines the type of toast animation. Possible values: .slide, .fade | .fade |

| **dismissOnTap** | [Bool?](https://developer.apple.com/documentation/swift/bool) | Defines if the toast closes on tap. Possible values: true, false | true |