Skip to content

Latest commit

 

History

History
164 lines (116 loc) · 3.76 KB

README.md

File metadata and controls

164 lines (116 loc) · 3.76 KB

Drops 💧

A µFramework for showing alerts like the one used when copying from pasteboard or connecting Apple pencil.

Demo


CI codecov

Features

  • iOS 13+
  • Can be used in SwiftUI and UIKit applications
  • Light/Dark modes
  • Custom colors for title, subtitle and icon
  • Interactive dismissal
  • Queue to show consecutive drops
  • Support dynamic font sizing
  • Support announcing title and subtitle via VoiceOver
  • Show from top or bottom of screen

Usage

  1. Create a drop:
let drop: Drop = "Title Only"
let drop = Drop(title: "Title Only")
let drop = Drop(title: "Title", subtitle: "Subtitle")
let drop = Drop(title: "Title", subtitle: "Subtitle", duration: 5.0)
let drop = Drop(
    title: "Title",
    subtitle: "Subtitle",
    icon: UIImage(systemName: "star.fill"),
    action: .init {
        print("Drop tapped")
        Drops.hideCurrent()
    },
    position: .bottom,
    duration: 5.0,
    accessibility: "Alert: Title, Subtitle",
    titleColor: .blue
)
  1. Show it:
Drops.show("Title")
Drops.show(drop)
SwiftUI
import SwiftUI
import Drops

struct ContentView: View {
    var body: some View {
        Button("Show Drop") {
            Drops.show(drop)
        }
    }
}
UIKit
import UIKit
import Drops

class ViewController: UIViewController {
    let drops = Drops(delayBetweenDrops: 1.0)

    func showDrop() {
        drops.show(drop)
    }
}

Read the docs for more usage options.


Example Projects

  • Run the SwiftUIExample target to see how Drops works in SwiftUI applications.
  • Run the UIKitExample target to see how Drops works in UIKit applications.

Example


Installation

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code.

  1. Add the following to your Package.swift file:
dependencies: [
    .package(url: "https://github.com/omaralbeik/Drops.git", from: "1.7.0")
]
  1. Build your project:
$ swift build

CocoaPods

To integrate Drops into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'Drops', :git => 'https://github.com/omaralbeik/Drops.git', :tag => '1.7.0'

Carthage

To integrate Drops into your Xcode project using Carthage, specify it in your Cartfile:

github "omaralbeik/Drops" ~> 1.7.0

Manually

Add the Sources folder to your Xcode project.


Thanks

Special thanks to SwiftKickMobile team for creating SwiftMessages, this project was heavily inspired by their work.


License

Drops is released under the MIT license. See LICENSE for more information.