Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omaralbeik/Drops
A µFramework for showing alerts like the one used when copying from pasteboard or connecting Apple pencil
https://github.com/omaralbeik/Drops
accessibility alert carthage cocoapods ios swift swift-package swiftui ui-framework uikit voiceover xcode
Last synced: 12 days ago
JSON representation
A µFramework for showing alerts like the one used when copying from pasteboard or connecting Apple pencil
- Host: GitHub
- URL: https://github.com/omaralbeik/Drops
- Owner: omaralbeik
- License: mit
- Created: 2021-04-27T08:52:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-24T06:32:29.000Z (9 months ago)
- Last Synced: 2024-04-26T01:41:34.002Z (7 months ago)
- Topics: accessibility, alert, carthage, cocoapods, ios, swift, swift-package, swiftui, ui-framework, uikit, voiceover, xcode
- Language: Swift
- Homepage: https://omaralbeik.github.io/Drops
- Size: 10.8 MB
- Stars: 894
- Watchers: 9
- Forks: 42
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Drops
- awesome-swiftui-libraries - Drops - A µFramework for showing alerts like the one used when copying from pasteboard or connecting Apple pencil (Toast-and-Popup / Content)
README
# Drops 💧
A µFramework for showing alerts like the one used when copying from pasteboard or connecting Apple pencil.
---
[](https://github.com/omaralbeik/Drops/actions)
[](https://codecov.io/gh/omaralbeik/Drops)
[](https://swiftpackageindex.com/omaralbeik/Drops)
[](https://swiftpackageindex.com/omaralbeik/Drops)
## Features
- iOS 13+
- Can be used in SwiftUI and UIKit applications
- Light/Dark modes
- 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:
```swift
let drop: Drop = "Title Only"
```
```swift
let drop = Drop(title: "Title Only")
```
```swift
let drop = Drop(title: "Title", subtitle: "Subtitle")
```
```swift
let drop = Drop(title: "Title", subtitle: "Subtitle", duration: 5.0)
```
```swift
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"
)
```
2. Show it:
```swift
Drops.show("Title")
```
```swift
Drops.show(drop)
```
###### SwiftUI
```swift
import SwiftUI
import Drops
struct ContentView: View {
var body: some View {
Button("Show Drop") {
Drops.show(drop)
}
}
}
```
###### UIKit
```swift
import UIKit
import Drops
class ViewController: UIViewController {
let drops = Drops(delayBetweenDrops: 1.0)
func showDrop() {
drops.show(drop)
}
}
```
Read the [docs](https://omaralbeik.github.io/Drops) 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.
---
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code.
1. Add the following to your `Package.swift` file:
```swift
dependencies: [
.package(url: "https://github.com/omaralbeik/Drops.git", from: "1.7.0")
]
```
2. Build your project:
```sh
$ swift build
```
### CocoaPods
To integrate Drops into your Xcode project using [CocoaPods](https://cocoapods.org), specify it in your Podfile:
```rb
pod 'Drops', :git => 'https://github.com/omaralbeik/Drops.git', :tag => '1.7.0'
```
### Carthage
To integrate Drops into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), specify it in your Cartfile:
```
github "omaralbeik/Drops" ~> 1.7.0
```
### Manually
Add the [Sources](https://github.com/omaralbeik/Drops/tree/main/Sources) folder to your Xcode project.
---
## Thanks
Special thanks to [SwiftKickMobile team](https://github.com/SwiftKickMobile) for creating [SwiftMessages](https://github.com/SwiftKickMobile/SwiftMessages), this project was heavily inspired by their work.
---
## License
Drops is released under the MIT license. See [LICENSE](https://github.com/omaralbeik/Drops/blob/main/LICENSE) for more information.