Update readme. Add docs.

Author: ivanvorobei

Example iOS/App/AppDelegate.swift

@@ -27,14 +27,7 @@ class AppDelegate: SPAppWindowDelegate {
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
         let rootController = PresetsController().wrapToNavigationController(prefersLargeTitles: false)
-        makeKeyAndVisible(rootController)
+        makeKeyAndVisible(rootController, tint: .systemBlue)
         return true
-        
-        let alertView = SPAlertView(title: "Complete", preset: .done)
-        alertView.present(duration: 1.5, haptic: .success, completion: nil)
-        
-        alertView.layout.iconSize = .init(width: 24, height: 24)
-        alertView.layout.margins.top = 12
-        alertView.layout.spaceBetweenIconAndTitle = 8
     }
 }

Example iOS/Controllers/PresetsController.swift

@@ -1,3 +1,24 @@
+// The MIT License (MIT)
+// Copyright © 2020 Ivan Vorobei ([email protected])
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 import UIKit
 import SparrowKit
 import SPDiffable
@@ -39,7 +60,7 @@ class PresetsController: SPDiffableTableController {
             .init(barButtonSystemItem: .flexibleSpace, target: nil, action: nil),
             .init(systemItem: .play, primaryAction: .init(handler: { [weak self] (action) in
                 guard let preset = self?.currentPreset else { return }
-                SPAlert.present(title: preset.title, message: preset.message, preset: preset.preset, completion: nil)
+                SPAlert.present(title: preset.title, message: preset.message, preset: preset.preset, haptic: preset.haptic, completion: nil)
             }), menu: nil),
             .init(barButtonSystemItem: .flexibleSpace, target: nil, action: nil),
         ]
@@ -53,25 +74,29 @@ class PresetsController: SPDiffableTableController {
                 name: "Done",
                 title: "Added to Library",
                 message: nil,
-                preset: .done
+                preset: .done,
+                haptic: .success
             ),
             AlertPreset(
                 name: "Error",
                 title: "Oops",
                 message: "Please try again later",
-                preset: .error
+                preset: .error,
+                haptic: .error
             ),
             AlertPreset(
                 name: "Heart",
                 title: "Love",
                 message: "We'll recommend more like this for you",
-                preset: .heart
+                preset: .heart,
+                haptic: .success
             ),
             AlertPreset(
                 name: "Custom Image",
                 title: "Custom Image",
                 message: "Passed UIImage object for preset with style custom.",
-                preset: .custom(UIImage.init(systemName: "pencil.and.outline")!)
+                preset: .custom(UIImage.init(systemName: "pencil.and.outline")!),
+                haptic: .success
             ),
         ]
     }

Example iOS/Models/AlertPreset.swift

@@ -1,11 +1,36 @@
+// The MIT License (MIT)
+// Copyright © 2020 Ivan Vorobei ([email protected])
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 import UIKit
 
+/**
+ Example wrapper model.
+ */
 struct AlertPreset {
 
     var name: String
     var title: String
     var message: String?
     var preset: SPAlertIconPreset
+    var haptic: SPAlertHaptic
 
     var id: String {
         return name

README.md

@@ -163,4 +163,4 @@ Simplifies working with animated changes in table and collections. Apple's diffa
 
 В телеграм-канале [Код Воробья](https://ivanvorobei.by/sparrowcode/telegram) пишу о iOS разработке. Видео-туториалы выклыдываю на [YouTube](https://ivanvorobei.by/youtube):
 
-[![Tutorials on YouTube](https://cdn.ivanvorobei.by/github/readme/youtube-preview.jpg)](https://sparrowcode.by/youtube)
+[![Tutorials on YouTube](https://cdn.ivanvorobei.by/github/readme/youtube-preview.jpg)](https://ivanvorobei.by/youtube)

Sources/SPAlert/Models/SPAlertIconAnimatable.swift

@@ -21,7 +21,13 @@
 
 import UIKit
 
+/**
+ Protocol for animatable views.
+ */
 public protocol SPAlertIconAnimatable {
 
+    /**
+     Shoud call when need start animation.
+     */
     func animate()
 }

Sources/SPAlert/Models/SPAlertLayout.swift

@@ -21,10 +21,24 @@
 
 import UIKit
 
+/**
+ Layout model for alert view.
+ */
 open class SPAlertLayout {
 
+    /**
+     Icon size.
+     */
     var iconSize: CGSize
+    
+    /**
+     Alert margings for each side.
+     */
     var margins: UIEdgeInsets
+    
+    /**
+     Space between icon and title if both available.
+     */
     var spaceBetweenIconAndTitle: CGFloat
 
     init(iconSize: CGSize, margins: UIEdgeInsets, spaceBetweenIconAndTitle: CGFloat) {

Sources/SPAlert/SPAlert.swift

@@ -21,20 +21,33 @@
 
 import UIKit
 
-/*
- TODO:
- 1. Will add dimiss mode with hide all previus alerts.
- And method with competion for it call manually.
- 
- 2. Colorise for icon.
+/**
+ Acess level. Here you get ready-use methods.
+ Recomended use it.
  */
 public enum SPAlert {
 
-    public static func present(title: String, message: String? = nil, preset: SPAlertIconPreset, completion: (() -> Void)? = nil) {
+    /**
+     Present alert with preset and haptic.
+     
+     - parameter title: Title text in alert.
+     - parameter message: Subtitle text in alert. Optional.
+     - parameter preset: Icon ready-use style or custom image.
+     - parameter haptic: Haptic response with present. Default is `.success`.
+     - parameter completion: Will call with dismiss alert.
+     */
+    public static func present(title: String, message: String? = nil, preset: SPAlertIconPreset, haptic: SPAlertHaptic = .success, completion: (() -> Void)? = nil) {
         let alertView = SPAlertView(title: title, message: message, preset: preset)
-        alertView.present(completion: completion)
+        alertView.present(haptic: haptic, completion: completion)
     }
 
+    /**
+     Show only message, without title and icon.
+     
+     - parameter message: Title text.
+     - parameter haptic: Haptic response with present. Default is `.success`.
+     - parameter completion: Will call with dismiss alert.
+     */
     public static func present(message: String, haptic: SPAlertHaptic, completion: (() -> Void)? = nil) {
         let alertView = SPAlertView(message: message)
         alertView.present(haptic: haptic, completion: completion)

Sources/SPAlert/SPAlertIconPreset.swift

@@ -21,6 +21,10 @@
 
 import UIKit
 
+/**
+ Represent icon wrapper.
+ Included default styles and can be custom image.
+ */
 public enum SPAlertIconPreset: CaseIterable {
 
     case done
@@ -36,6 +40,7 @@ public enum SPAlertIconPreset: CaseIterable {
     }
 }
 
+// Get view by preset.
 public extension SPAlertIconPreset {
 
     func createView() -> UIView {
@@ -51,6 +56,7 @@ public extension SPAlertIconPreset {
     }
 }
 
+// Get layout by preset.
 public extension SPAlertLayout {
 
     convenience init() {

Sources/SPAlert/SPAlertView.swift

@@ -21,15 +21,27 @@
 
 import UIKit
 
+/**
+ Main view. Can be customisable if need.
+ 
+ For change duration, check method `present` and pass duration and other specific property if need customise.
+ 
+ Here available set window on which shoud be present.
+ If you have some windows, you shoud configure it. Check property `presentWindow`.
+ 
+ For disable dismiss by tap, check property `.dismissByTap`.
+ 
+ Recomended call `SPAlert` and choose style func.
+ */
 open class SPAlertView: UIView {
 
     // MARK: - Views
 
-    private var titleLabel: UILabel?
+    open var titleLabel: UILabel?
 
-    private var subtitleLabel: UILabel?
+    open var subtitleLabel: UILabel?
 
-    private var iconView: UIView?
+    open var iconView: UIView?
 
     private lazy var backgroundView: UIVisualEffectView = {
         let view: UIVisualEffectView = {
@@ -106,7 +118,7 @@ open class SPAlertView: UIView {
         addSubview(view)
     }
 
-    func commonInit() {
+    private func commonInit() {
         preservesSuperviewLayoutMargins = false
         insetsLayoutMarginsFromSafeArea = false
         layer.masksToBounds = true

Sources/SPAlert/Services/SPAlertHaptic.swift

@@ -21,6 +21,9 @@
 
 import UIKit
 
+/**
+ Wrapper of haptic styles.
+ */
 public enum SPAlertHaptic {
 
     case success