Swiftpack.co -  Package - sanzaru/SimpleToast
Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
sanzaru/SimpleToast
SimpleToast is a simple, lightweight and easy to use library to show toasts / pop-ups inside your iOS application in SwiftUI.
.package(url: "https://github.com/sanzaru/SimpleToast.git", from: "0.1.0")

SimpleToast for SwiftUI

Build Status

SimpleToast is a simple, lightweight and easy to use library to show toasts / popup notifications inside your iOS or MacOS application in SwiftUI.

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

⚠️ Note: The current version is still in an early stage. There can be breaking changes in version updates.

Table of contents

Features:

  • Custom toast content support: You can show whatever you want inside the toast.
  • Timeout functionality: You decide if and when the toast should disappear.
  • Callback functionality: Run code when the toast disappeared.
  • Multiple animations

Installation

Swift Package Manager

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

Manual installation

Simply drag the SimpleToast.swift file into your project.

Demo

Simple toast

Screenshots

Simple toast Complex toast
Simple toast Simple toast

Usage:

Simply attach the toast to a view and show it via binding with a 5 sec. delay:

import SwiftUI
import SimpleToast

struct ToastTestView: View {
    @State var showToast: Bool = false

    private let toastOptions = SimpleToastOptions(
        delay: 5
    )

    VStack(spacing: 20) {
        Button(
            action: {
                withAnimation {
                    self.showToast.toggle()
                }
            },
            label: { Text("Show toast") }
        )
    }
    .simpleToast(isShowing: $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)
    }
}

Note: The toast respects the frame of the view it is attached to. Make sure the view has enough room to render the toast. Preferably the view should be attached to the most outer view or the navigation view, if available.

To run custom code after the toast did disappear you just simply have to pass a function to the completion parameter:

import SwiftUI
import SimpleToast

struct ToastTestView: View {
    @State var showToast: Bool = false

    private let toastOptions = SimpleToastOptions(
        delay: 5
    )

    VStack(spacing: 20) {
        Button(
            action: {
                withAnimation {
                    self.showToast.toggle()
                }
            },
            label: { Text("Show toast") }
        )
    }
    .simpleToast(isShowing: $showToast, options: toastOptions, completion: 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")
    }
}

Options

The toast can be configured via an optional SimpleToastOptions object. If nil is given default values are taken. See table below for more information.

 
📌 All parameters inside the options are optional.  

Option Description Default
alignment Defines the alignment of the toast. See https://developer.apple.com/documentation/swiftui/alignment for more information. .top
hideAfter Defines when the toast disappears. If nil is given the toast won't disappear. nil
showBackdrop Defines if the toast is rendered over a backdrop. true
backdropColor Defines the backdrop color Color.white.opacity(0.9)
animation Defines the animation type. See https://developer.apple.com/documentation/swiftui/animation for more information. .linear
modifierType Defines the type of toast animation. Possible values(.slide, .fade) .fade

The struct has the following signature:

public struct SimpleToastOptions {
    var alignment: Alignment = .top
    var hideAfter: TimeInterval? = nil
    var showBackdrop: Bool? = true
    var backdropColor: Color = Color.white.opacity(0.9)
    var animation: Animation = .linear
    var modifierType: SimpleToastModifierType = .fade
}

Changelog

v 0.1.0

- First minor release
- Updated drag gesture for better touch handling
- Better options name

v0.0.9

- Better animations and transitions
- Better UI integration
- Fixed slide modifier

v0.0.8

- Better slide modifier
- New option names - !! breaking change to previous versions !!

v0.0.7

- Fixed access level problems

v0.0.6

- New toast animation (slide). Modifier type can now be configured via options
- Drag gesture added, to swipe the toast away
- Customizable backdrop color
- Updated readme

v0.0.5

- Added functionality for completion callback
- Minor code fixes
- Updated readme

v0.0.4

- Minor code fixes

v0.0.3

- Minor code fixes

v0.0.2

- Minor code fixes

v0.0.1

- Updated readme

GitHub

link
Stars: 16
Last commit: 5 weeks ago

Release Notes

0.1.0
5 weeks ago
  • First minor release
  • Better gesture handling

⚠️ There was a breaking change (renamed option) in the SimpleToastOption struct.

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco