Close Menu

Toast

Introduction

Welcome to the documentation for Toast, a versatile library for displaying customizable toast messages in your iOS apps. This documentation will guide you through the installation and usage of Toast in your projects.

Installation

To start using Toast in your iOS projects, follow the steps below:

Prerequisites

  • Xcode and Swift
  • Minimum deployment target of iOS 10.0 or later

CocoaPods Installation

To install Toast using CocoaPods, simply add the following line to your Podfile:

// Podfile

platform :ios, '10.0'
target 'YourTargetName' do
  pod 'Toast-Swift'
end

Then, run pod install command in your project directory.

Manual Installation

  1. Download the latest version of the Toast library from GitHub.
  2. Drag and drop the Toast.swift file into your Xcode project.
  3. Ensure that the file is added to the correct target(s) in your project settings.

Usage

To display toast messages in your iOS app using Toast, you can follow these steps:

Importing Toast

  1. Add the following import statement at the top of your Swift file:
import Toast

Showing a Toast

  1. Create an instance of UIView to display the toast message:
let toastView = UIView(frame: CGRect(x: 0, y: 0, width: 200, height: 50))
toastView.backgroundColor = UIColor.black.withAlphaComponent(0.6)
toastView.layer.cornerRadius = 10
  
let toastLabel = UILabel(frame: CGRect(x: 0, y: 0, width: 200, height: 50))
toastLabel.text = "Your Toast Message"
toastLabel.textAlignment = .center
toastLabel.textColor = .white

toastView.addSubview(toastLabel)
  1. Show the toast message using the makeToast(_:duration:position:) method:
if let keyWindow = UIApplication.shared.keyWindow {
    keyWindow.makeToast(toastView,
                        duration: TimeInterval(2),
                        position: .center)
}

The above code creates a custom toast view and displays it at the center of the screen for a duration of 2 seconds.

Additional Configuration

The Toast library offers various customization options. Here are a few commonly used methods:

  • makeToast(_:duration:position:title:image:style:completion:) – Shows a toast message with a title and image.
  • setToastThemeColor(_:) – Sets a global theme color for the toast.
  • setToastStyle(_:) – Configures the default style for toast messages.
  • setToastPosition(_:) – Defines the default position for toast messages.

Conclusion

Toast is a powerful and user-friendly library that enables you to display customizable toast messages in your iOS applications. By following this documentation, you should now be able to easily incorporate Toast into your projects and display toast messages with ease.