Skip to content

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.

License

Notifications You must be signed in to change notification settings

sanzaru/SimpleToast

Repository files navigation

SimpleToast for SwiftUI

Swift

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.

Important

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

Caution

🚨 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 for more information

Demo

Modifier Demo
.slide
.fade
.scale
.skew

Installation

Swift Package Manager

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

Cocoapods

Caution

CocoaPods support will be dropped with version 1.0. Prior to that, support will be minimal. Using SPM is highly recommended.

Add the following line to your Podfile:

pod 'SwiftUI-SimpleToast', '~> 0.6.2'

and run

pod install

or

pod update

Usage

📚 For more information on how to use SimpleToast, see the documentation on usage.

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 Defines the alignment of the toast. .top
hideAfter TimeInterval? Defines when the toast disappears. If nil is given the toast won't disappear. nil
backdrop Color? Defines the backdrop color nil
animation Animation Defines the animation type. .linear
modifierType ModifierType Defines the type of toast animation. Possible values: .slide, .fade .fade
dismissOnTap Bool? Defines if the toast closes on tap. Possible values: true, false true
disableDragGesture Bool Defines if the toast reacts to drag gestures. Possible values: true, false false

About

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.

Topics

Resources

License

Stars

Watchers

Forks