v1.0

Author: xnth97

.gitignore

@@ -2,4 +2,5 @@
 .swiftpm/
 Example/AccessoryKit.xcodeproj/xcuserdata/
 Example/AccessoryKit.xcworkspace/xcuserdata
-Example/Pods/Pods.xcodeproj/xcuserdata
+Example/Pods/Pods.xcodeproj/xcuserdata
+.build

README.md

@@ -14,6 +14,7 @@ A customizable, expandable, and easy-to-use input accessory view component for i
 
 The main features are:
 
+* Responsively uses `UITextInputAssistantItem` on iPad and `UITextInputView` on iPhone.
 * Scrollable input accessory view with blurry background and customizable buttons.
 * Supports Auto Layout and Safe Area.
 * Supports dark mode.
@@ -24,8 +25,8 @@ The main features are:
 
 ### Requirements
 
-* iOS 13.0+
-* Swift 5.3+
+* iOS 14.0+
+* Swift 5.5+
 
 ### Installation
 
@@ -44,48 +45,29 @@ To run the example project, clone the repo, and run `pod install` from the Examp
 ```swift
 // Create view model array of key buttons
 let keyButtons: [KeyboardAccessoryButton] = [
-    // Create button with built-in type and tap handler block
-    KeyboardAccessoryButton(type: .undo) { [weak self] in
+    // Create button with built-in type and tap handler block that will be placed on 
+    // the leading side of keyboard on iPad
+    KeyboardAccessoryButton(type: .undo, position: .leading) { [weak self] in
         self?.undo()
     },
-    // Create button with UIImage
-    KeyboardAccessoryButton(image: UIImage(named: "img"), tapHandler: {}),
+    // Create button with UIImage that will be collapsed in an overflow menu on iPad
+    KeyboardAccessoryButton(image: UIImage(named: "img"), position: .overflow),
     // Create button with title
-    KeyboardAccessoryButton(title: "Button", tapHandler: {}),
+    KeyboardAccessoryButton(title: "Button",
     // Create button with UIMenu
     KeyboardAccessoryButton(type: .link, menu: createInsertMenu()),
 ]
 
-// Initialize `KeyboardAccessoryView`
-let accessoryView = KeyboardAccessoryView(
-    frame: CGRect(x: 0, y: 0, width: view.frame.width, height: 0),
+// Initialize and retain `KeyboardAccessoryManager`
+self.accessoryManager = KeyboardAccessoryView(
     keyButtons: keyButtons,
     showDismissKeyboardKey: true,
     delegate: self)
 
-// Assign the accessory view instance to `UITextView`
-textView.inputAccessoryView = accessoryView
-
-// Set tint color for the whole view
-accessoryView.tintColor = .systemPink
-// ...or at a given index
-accessoryView.setTintColor(.systemGreen, at: 5)
-
-// Set enabled at a given index
-accessoryView.setEnabled(false, at: 1)
+// Configures the `UITextView` with `KeyboardAccessoryManager`
+self.accessoryManager.configure(textView: textView)
 ```
 
-## TODO
-
-- [x] Support text title
-- [ ] Expose more APIs for customization
-- [x] Tint color
-- [ ] Tweak UI
-- [x] Use SF Symbol
-- [x] UIMenu support
-- [ ] UIAction support
-- [x] SPM support
-
 ## License
 
 AccessoryKit is available under the MIT license. See the [LICENSE](LICENSE) file for more info.

Sources/AccessoryKit/KeyboardAccessoryManager.swift

@@ -26,6 +26,15 @@ public class KeyboardAccessoryManager {
 
     // MARK: - Initializer
 
+    /// Initializes an instance of `KeyboardAccessoryManager`.
+    /// - Parameters:
+    ///   - keyButtons: An array of `KeyboardAccessoryButton` model to construct the keys.
+    ///   - keyWidth: The width of each key inside input accessory view.
+    ///   - keyHeight: The height of each key inside input accessory view.
+    ///   - keyCornerRadius: The corner radius of each key inside input accessory view.
+    ///   - keyMargin: The margin between keys inside input accessory view.
+    ///   - showDismissKeyboardKey: If show the dismiss keyboard key on the right of scrollable area.
+    ///   - delegate: Delegate object that implements `KeyboardAccessoryViewDelegate`.
     public init(keyButtons: [KeyboardAccessoryButton] = [],
                 keyWidth: CGFloat = KeyboardAccessoryView.defaultKeyWidth,
                 keyHeight: CGFloat = KeyboardAccessoryView.defaultKeyHeight,
@@ -44,6 +53,10 @@ public class KeyboardAccessoryManager {
 
     // MARK: - Public APIs
 
+    /// Configures a `UITextView` with accessory manager instance. Uses `UITextInputView` on iPhone
+    /// (a toolbar above virtual keyboard) and `UITextInputAssistantItem` on iPad (embedded inside
+    /// the floating keyboard toolbar).
+    /// - Parameter textView: The text view instance to be configured.
     public func configure(textView: UITextView) {
         if Self.isIPad {
             configure(inputAssistantItem: textView.inputAssistantItem)
@@ -52,6 +65,8 @@ public class KeyboardAccessoryManager {
         }
     }
 
+    /// Creates an instance of toolbar view that can be assigned to the text view's `inputAccessoryView`.
+    /// - Returns: The keyboard accessory view instance.
     public func makeInputView() -> KeyboardAccessoryView {
         return KeyboardAccessoryView(
             keyWidth: keyWidth,
@@ -63,6 +78,8 @@ public class KeyboardAccessoryManager {
             delegate: delegate)
     }
 
+    /// Configures the `UITextInputAssistantItem` with given accessory manager.
+    /// - Parameter inputAssistantItem: The `UITextInputAssistantItem` to be configured.
     public func configure(inputAssistantItem: UITextInputAssistantItem) {
         var leadingButtons: [UIBarButtonItem] = []
         var trailingButtons: [UIBarButtonItem] = []