Toaster Documentation

You can integrate Toaster into your project using any of the following dependency managers:

Swift Package Manager Add the following to your Package.swift dependencies:

CocoaPods Add this to your Podfile:

Carthage Add this to your Cartfile:

To display a basic toast with text, import Toaster and call .show() on a Toast instance.

import Toaster

Toast(text: "Hello, world!").show()

Since version 2.3.0, you can pass an NSAttributedString to a Toast to support rich text styling like custom background colors or specific text attributes.

Toast(attributedText: NSAttributedString(string: "AttributedString Toast", attributes: [NSAttributedString.Key.backgroundColor: UIColor.yellow]))

VoiceOver support is enabled by default. If you need to disable UIAccessibility support for toasts, configure it via ToastCenter.default.

ToastCenter.default.isSupportAccessibility = false

Toaster provides several ways to dismiss toasts:

• Specific toast: Keep a reference to the Toast instance and call .cancel().
• Current toast: Use ToastCenter.default.currentToast to find and cancel the toast currently being displayed.
• All toasts: Use ToastCenter.default.cancelAll() to clear the entire queue.

// Removing toast with reference
let toast = Toast(text: "Hello")
toast.show()
toast.cancel() // remove toast immediately

// Removing current toast
if let currentToast = ToastCenter.default.currentToast {
    currentToast.cancel()
}

// Removing all toasts
ToastCenter.default.cancelAll()