# SPAlert

**Repository Path**: yulin97/SPAlert

## Basic Information

- **Project Name**: SPAlert
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-13
- **Last Updated**: 2022-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SPAlert

<p float="left">
<img src="https://cdn.ivanvorobei.by/github/spalert/done.gif" width="230">
<img src="https://cdn.ivanvorobei.by/github/spalert/heart.gif" width="230">
<img src="https://cdn.ivanvorobei.by/github/spalert/message.gif" width="230">
</p>

**Popup from Apple Music & Feedback in AppStore**. Contains `Done`, `Heart`, `Error` and other. Supports Dark Mode and `SwiftUI`.
I tried to recreate Apple's alerts as much as possible. You can find these alerts in the AppStore after feedback and after you add a song to your library in Apple Music.

For get alert from switch silent mode, check library [SPIndicator](https://github.com/ivanvorobei/SPIndicator).

## Navigate

- [Installation](#installation)
    - [Swift Package Manager](#swift-package-manager)
    - [CocoaPods](#cocoapods)
    - [Manually](#manually)
- [Quick Start](#quick-start)
- [Usage](#usage)
    - [Duration](#duration)
    - [Dismiss](#dismiss)
    - [Layout](#layout)
    - [Haptic](#haptic)
    - [Spinner](#spinner)
    - [Colors](#colors)
    - [Global Appearance](#global-appearance)
- [SwiftUI](#swiftui)
- [Russian Community](#russian-community)

## Installation

Ready for use on iOS 11+.

### Swift Package Manager

The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

Once you have your Swift package set up, adding as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.

```swift
dependencies: [
    .package(url: "https://github.com/ivanvorobei/SPAlert", .upToNextMajor(from: "4.2.0"))
]
```

### CocoaPods:

[CocoaPods](https://cocoapods.org) is a dependency manager. For usage and installation instructions, visit their website. To integrate using CocoaPods, specify it in your `Podfile`:

```ruby
pod 'SPAlert'
```

### Manually

If you prefer not to use any of dependency managers, you can integrate manually. Put `Sources/SPAlert` folder in your Xcode project. Make sure to enable `Copy items if needed` and `Create groups`.

## Quick Start

For best experience, I recommend presenting alerts by calling the class functions `SPAlert`. These functions are updated regularly and show the alerts as Apple way: 

```swift
SPAlert.present(title: "Added to Library", preset: .done)
```

For using a custom image:

```swift 
SPAlert.present(title: "Love", message: "We'll recommend more like this in For You", preset: .custom(UIImage.init(named: "heart")!))
```

For showing a simple text message:

```swift 
SPAlert.present(message: "Something going wrong", haptic: .error)
```

## Usage

### Duration

For change duration of present time, create alert view and call `present` method with custom duration:

```swift
let alertView = SPAlertView(title: "Complete", preset: .done)
alertView.duration = 4
alertView.present()
```

If you don't want to dimiss alert in time, disable `dismissInTime`. After it `duration` property will be ignored.

```swift
alertView.dismissInTime = false
```

In this case you shoud dismiss alert manually.

### Dismiss

If you tap the alert, it will disappear. This can be disabled:

```swift
alertView.dismissByTap = false
```

Also you can manually dismiss all alerts, simple call this:

```swift
SPAlert.dismiss()
```

### Layout

For customise layout and margins, use `layout` property. You can manage margins for each side, icon size and space between image and titles:

```swift
alertView.layout.iconSize = .init(width: 24, height: 24)
alertView.layout.margins.top = 12
alertView.layout.spaceBetweenIconAndTitle = 8
```

### Haptic

For manage haptic, you shoud pass it in present method:

```swift
alertView.present(duration: 1.5, haptic: .success, completion: nil)
```

You can remove duration and completion, its have default values.

### Spinner

I added preset `.spinner`, for use it simple call this:

```swift
let alertView = SPAlertView(title: "Please, wait", preset: .spinner)
alertView.present()
```

By default for this preset `dismissInTime` disabled and need manually dismiss alert. You can do it only for one view or dimiss all alerts:

```swift
// For one alert
alertView.dismiss()

// For all alerts
SPAlert.dismiss()
```

### Colors

For change color of icon, simple set tint color for any preset:

```swift
alertView.iconView?.tintColor = .systemRed

//If you set custom image, don't forget set rendering mode:
UIImage(systemName: "pencil.and.outline")!.withRenderingMode(.alwaysTemplate)
```

### Global Appearance

Also you can change some default values for alerts. For example you can change default duration and corner radius for alert with next code:

```swift
SPAlertView.appearance().duration = 2
SPAlertView.appearance().cornerRadius = 12
```

It will apply for all alerts. I recomend set it in app delegate. But you can change it in runtime.

## SwiftUI

Use like system alert only show message tips:

```swift
Button("Show alert") {
    showAlert = true
}.SPAlert(isPresent: $showAlert, message: "this is message only")
```

or show message, title, image and other configuration:

```swift
Button("Show alert") {
    showAlert = true
}.SPAlert(
    isPresent: $showAlert, 
    title: "Alert title", 
    message: "Alert message",
    duration: 2.0, 
    dismissOnTap: false, 
    present: .custom(UIImage(systemName: "heart")!), 
    haptic: .success, 
    layout: .init(), 
    completion: {
        print("Alert is destory")
    })
```

## Russian Community

Я веду [телеграм-канал](https://sparrowcode.io/telegram), там публикую новости и туториалы.<br>
С проблемой помогут [в чате](https://sparrowcode.io/telegram/chat).

Видео-туториалы выклыдываю на [YouTube](https://ivanvorobei.by/youtube):

[![Tutorials on YouTube](https://cdn.ivanvorobei.by/github/readme/youtube-preview.jpg)](https://ivanvorobei.by/youtube)