Merge pull request MessageKit#707 from zhongwuzw/fix-bottom-inset

SD10 · web-flow · commit 46bebecb6e98 · 2018-06-01T15:00:42.000-05:00
Fixed MessagesCollectionView's bottom inset when hardware keyboard is…
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,14 @@ The changelog for `MessageKit`. Also see the [releases](https://github.com/Messa
 
 ## Upcoming release
 
+### Fixed
+
+- Fixed `MessagesCollectionView`'s bottom inset when hardware keyboard is connected. Do not adjust `MessagesCollection`'s inset when being popped.
+[#707](https://github.com/MessageKit/MessageKit/pull/707) by [@zhongwuzw](https://github.com/zhongwuzw).
+
+- Fixed `LabelAlignment` initializer which has default internal access control.
+[#705](https://github.com/MessageKit/MessageKit/pull/705) by [@zhongwuzw](https://github.com/zhongwuzw).
+
 ### Added
 
 - Added convenience method to set properties for all `MessageSizeCalculator`s.
diff --git a/Documentation/FAQs.md b/Documentation/FAQs.md
@@ -31,13 +31,13 @@ func configureAvatarView(_ avatarView: AvatarView, for message: MessageType, at
 }
 ```
 
-If you return `CGSize.zero` from the `MessagesLayoutDelegate` method
-`avatarSize(for:MessageType,at:IndexPath,in:MessagesCollectionView)`, the `AvatarView`
-will not be visible for that cell.
+If you also like to remove the space the `AvatarView` occupies you have to change the properties
+`outgoingAvatarSize` or `incomingAvatarSize` of the `CellSizeCalculator` object for the respective message to `CGSize.zero`.
 
 ```Swift
-func avatarSize(for: MessageType, at: IndexPath, in: MessagesCollectionView) -> CGSize {
-    return .zero
+if let layout = messagesCollectionView.collectionViewLayout as? MessagesCollectionViewFlowLayout {
+  layout.textMessageSizeCalculator.outgoingAvatarSize = .zero
+  layout.textMessageSizeCalculator.incomingAvatarSize = .zero
 }
 ```
 
diff --git a/Sources/Controllers/MessagesViewController+Keyboard.swift b/Sources/Controllers/MessagesViewController+Keyboard.swift
@@ -53,22 +53,19 @@ extension MessagesViewController {
     @objc
     private func handleKeyboardDidChangeState(_ notification: Notification) {
         guard let keyboardEndFrame = notification.userInfo?[UIKeyboardFrameEndUserInfoKey] as? CGRect else { return }
-
-        if (keyboardEndFrame.origin.y + keyboardEndFrame.size.height) > UIScreen.main.bounds.height {
-            // Hardware keyboard is found
-            messageCollectionViewBottomInset = view.frame.size.height - keyboardEndFrame.origin.y - iPhoneXBottomInset
-        } else {
-            //Software keyboard is found
-            let afterBottomInset = keyboardEndFrame.height > keyboardOffsetFrame.height ? (keyboardEndFrame.height - iPhoneXBottomInset) : keyboardOffsetFrame.height
-            let differenceOfBottomInset = afterBottomInset - messageCollectionViewBottomInset
-
-            if maintainPositionOnKeyboardFrameChanged && differenceOfBottomInset != 0 {
-                let contentOffset = CGPoint(x: messagesCollectionView.contentOffset.x, y: messagesCollectionView.contentOffset.y + differenceOfBottomInset)
-                messagesCollectionView.setContentOffset(contentOffset, animated: false)
-            }
-
-            messageCollectionViewBottomInset = afterBottomInset
+        
+        guard !isMessagesControllerBeingDismissed else { return }
+        
+        let newBottomInset = view.frame.height - keyboardEndFrame.minY - iPhoneXBottomInset
+        
+        let differenceOfBottomInset = newBottomInset - messageCollectionViewBottomInset
+        
+        if maintainPositionOnKeyboardFrameChanged && differenceOfBottomInset != 0 {
+            let contentOffset = CGPoint(x: messagesCollectionView.contentOffset.x, y: messagesCollectionView.contentOffset.y + differenceOfBottomInset)
+            messagesCollectionView.setContentOffset(contentOffset, animated: false)
         }
+        
+        messageCollectionViewBottomInset = newBottomInset
     }
 
     @objc
diff --git a/Sources/Controllers/MessagesViewController.swift b/Sources/Controllers/MessagesViewController.swift
@@ -60,6 +60,8 @@ UICollectionViewDelegateFlowLayout, UICollectionViewDataSource {
     }
 
     private var isFirstLayout: Bool = true
+    
+    internal var isMessagesControllerBeingDismissed: Bool = false
 
     internal var selectedIndexPathForMenu: IndexPath?
 
@@ -82,6 +84,16 @@ UICollectionViewDelegateFlowLayout, UICollectionViewDataSource {
         addObservers()
     }
     
+    open override func viewDidAppear(_ animated: Bool) {
+        super.viewDidAppear(animated)
+        isMessagesControllerBeingDismissed = false
+    }
+    
+    open override func viewWillDisappear(_ animated: Bool) {
+        super.viewWillDisappear(animated)
+        isMessagesControllerBeingDismissed = true
+    }
+    
     open override func viewDidLayoutSubviews() {
         // Hack to prevent animation of the contentInset after viewDidAppear
         if isFirstLayout {
diff --git a/Sources/Models/LabelAlignment.swift b/Sources/Models/LabelAlignment.swift
@@ -28,6 +28,11 @@ public struct LabelAlignment {
 
     public var textAlignment: NSTextAlignment
     public var textInsets: UIEdgeInsets
+    
+    public init(textAlignment: NSTextAlignment, textInsets: UIEdgeInsets) {
+        self.textAlignment = textAlignment
+        self.textInsets = textInsets
+    }
 
 }
 
diff --git a/VISION.md b/VISION.md
@@ -8,11 +8,11 @@
 - Cultivate an inclusive open source community through respectful discussion.
 
 ### Scope
-MessageKit will only concern itself with the **MessagesViewController**. 
+#### Things we will not support:
+- Views that live outside of the MessagesViewController such as photo pickers and media players.
+- Anything that favors specific networking / caching strategies or specific libraries.
 
-We will **not** support other views such as:  **Photo Pickers** and **Video/Music Players**.
-
-Instead, MessageKit will provide you with hooks to easily handle your different message types and present a view of your choice. We believe this is more flexible, maintainable, and reasonable.
+Instead, MessageKit will provide you with hooks to easily handle these situations as you wish. We believe this is more flexible, maintainable, and reasonable.
 
 ### Technical Considerations
 - **iOS version**: 

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,11 @@ public struct LabelAlignment {`
`28`	`28`
`29`	`29`	`public var textAlignment: NSTextAlignment`
`30`	`30`	`public var textInsets: UIEdgeInsets`
	`31`	`+`
	`32`	`+ public init(textAlignment: NSTextAlignment, textInsets: UIEdgeInsets) {`
	`33`	`+ self.textAlignment = textAlignment`
	`34`	`+ self.textInsets = textInsets`
	`35`	`+ }`
`31`	`36`
`32`	`37`	`}`
`33`	`38`