mirror of
https://github.com/MessageKit/MessageKit.git
synced 2026-02-06 19:03:19 +00:00
Wu Zhong
278 lines
14 KiB
Swift
278 lines
14 KiB
Swift
/*
|
|
MIT License
|
|
|
|
Copyright (c) 2017-2018 MessageKit
|
|
|
|
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 Foundation
|
|
import AVFoundation
|
|
|
|
/// A protocol used by the `MessagesCollectionViewFlowLayout` object to determine
|
|
/// the size and layout of a `MessageCollectionViewCell` and its contents.
|
|
public protocol MessagesLayoutDelegate: AnyObject {
|
|
|
|
// MARK: - All Messages
|
|
|
|
/// Specifies the padding around the `MessageContainerView` in a `MessageCollectionViewCell`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is determined by the messages `Sender`:
|
|
///
|
|
/// Current Sender: `UIEdgeInsets(top: 0, left: 30, bottom: 0, right: 4)`
|
|
///
|
|
/// All other Senders: `UIEdgeInsets(top: 0, left: 4, bottom: 0, right: 30)`
|
|
func messagePadding(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIEdgeInsets
|
|
|
|
/// Specifies the vertical and horizontal alignment for the `AvatarView` in a `MessageCollectionViewCell`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is an `AvatarPosition` with
|
|
/// `Horizontal.natural` and `Vertical.messageBottom`.
|
|
func avatarPosition(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> AvatarPosition
|
|
|
|
/// Specifies the horizontal alignment of a `MessageCollectionViewCell`'s top label.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is determined by the messages `Sender`:
|
|
///
|
|
/// Current Sender: .messageTrailing(.zero)
|
|
///
|
|
/// All other senders: .messageLeading(.zero)
|
|
func cellTopLabelAlignment(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LabelAlignment
|
|
|
|
/// Specifies the horizontal alignment of a `MessageCollectionViewCell`'s bottom label.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is determined by the messages `Sender`:
|
|
///
|
|
/// Current Sender: .messageLeading(.zero)
|
|
///
|
|
/// All other senders: .messageTrailing(.zero)
|
|
func cellBottomLabelAlignment(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LabelAlignment
|
|
|
|
/// Specifies the size of the `AvatarView` in a `MessageCollectionViewCell`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is a size of `30 x 30`.
|
|
func avatarSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize
|
|
|
|
/// Specifies the size to use for a `MessageHeaderView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed for this header.
|
|
/// - indexPath: The `IndexPath` of the header.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this header will be displayed.
|
|
///
|
|
/// The default value returned by this method is the width of the `MessagesCollectionView` and a height of 12.
|
|
func headerViewSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize
|
|
|
|
/// Specifies the size to use for a `MessageFooterView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed for this footer.
|
|
/// - indexPath: The `IndexPath` of the footer.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this footer will be displayed.
|
|
///
|
|
/// The default value returned by this method is a size of `GGSize.zero`.
|
|
func footerViewSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize
|
|
|
|
// MARK: - Text Messages
|
|
|
|
/// Specifies the insets for the text rect of the `MessageLabel` in a `TextMessageCell`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: A `MessageType` with a `MessageData` case of `.text` or `.attributedText` to which these insets will apply.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is determined by the messages `Sender`:
|
|
///
|
|
/// Current Sender: `UIEdgeInsets(top: 7, left: 14, bottom: 7, right: 18)`
|
|
///
|
|
/// All other Senders: `UIEdgeInsets(top: 7, left: 18, bottom: 7, right: 14)`
|
|
func messageLabelInset(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIEdgeInsets
|
|
|
|
// MARK: - Media Messages
|
|
|
|
/// Specifies the width for a `MessageContainerView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - maxWidth: The max available width for the `MessageContainerView` respecting the cell's other content.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is the `maxWidth`.
|
|
func widthForMedia(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat
|
|
|
|
/// Specifies the height for a `MessageContainerView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - maxWidth: The max available width for the `MessageContainerView` respecting the cell's other content.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method uses `AVMakeRect(aspectRatio:insideRect:)` with a bounding
|
|
/// rect using the `maxWidth` and `.greatestFiniteMagnitude` for the height.
|
|
func heightForMedia(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat
|
|
|
|
// MARK: - Location Messages
|
|
|
|
/// Specifies the width for a `MessageContainerView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - maxWidth: The max available width for the `MessageContainerView` respecting the cell's other content.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
///
|
|
/// The default value returned by this method is the `maxWidth`.
|
|
func widthForLocation(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat
|
|
|
|
/// Specifies the height for a `MessageContainerView`.
|
|
///
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` that will be displayed by this cell.
|
|
/// - indexPath: The `IndexPath` of the cell.
|
|
/// - maxWidth: The max available width for the `MessageContainerView` respecting the cell's other content.
|
|
/// - messagesCollectionView: The `MessagesCollectionView` in which this cell will be displayed.
|
|
func heightForLocation(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat
|
|
|
|
/// Specifies whether the layout attributes for a given `MessageType`
|
|
/// should be cached by the `MessagesCollectionViewFlowLayout`.
|
|
/// - Parameters:
|
|
/// - message: The `MessageType` whose attributes to cache.
|
|
///
|
|
/// The default value returned by this method is `false`.
|
|
func shouldCacheLayoutAttributes(for message: MessageType) -> Bool
|
|
|
|
}
|
|
|
|
public extension MessagesLayoutDelegate {
|
|
|
|
// MARK: - All Messages Defaults
|
|
|
|
func messagePadding(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIEdgeInsets {
|
|
guard let dataSource = messagesCollectionView.messagesDataSource else {
|
|
fatalError(MessageKitError.nilMessagesDataSource)
|
|
}
|
|
if dataSource.isFromCurrentSender(message: message) {
|
|
return UIEdgeInsets(top: 0, left: 30, bottom: 0, right: 4)
|
|
} else {
|
|
return UIEdgeInsets(top: 0, left: 4, bottom: 0, right: 30)
|
|
}
|
|
}
|
|
|
|
func cellTopLabelAlignment(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LabelAlignment {
|
|
guard let dataSource = messagesCollectionView.messagesDataSource else {
|
|
fatalError(MessageKitError.nilMessagesDataSource)
|
|
}
|
|
return dataSource.isFromCurrentSender(message: message) ? .messageTrailing(.zero) : .messageLeading(.zero)
|
|
}
|
|
|
|
func cellBottomLabelAlignment(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> LabelAlignment {
|
|
guard let dataSource = messagesCollectionView.messagesDataSource else {
|
|
fatalError(MessageKitError.nilMessagesDataSource)
|
|
}
|
|
return dataSource.isFromCurrentSender(message: message) ? .messageLeading(.zero) : .messageTrailing(.zero)
|
|
}
|
|
|
|
func avatarSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize {
|
|
return CGSize(width: 30, height: 30)
|
|
}
|
|
|
|
func avatarPosition(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> AvatarPosition {
|
|
return AvatarPosition(horizontal: .natural, vertical: .messageBottom)
|
|
}
|
|
|
|
func headerViewSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize {
|
|
guard let displayDelegate = messagesCollectionView.messagesDisplayDelegate else {
|
|
fatalError(MessageKitError.nilMessagesDisplayDelegate)
|
|
}
|
|
let shouldDisplay = displayDelegate.shouldDisplayHeader(for: message, at: indexPath, in: messagesCollectionView)
|
|
return shouldDisplay ? CGSize(width: messagesCollectionView.bounds.width, height: 12) : .zero
|
|
}
|
|
|
|
func footerViewSize(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> CGSize {
|
|
return .zero
|
|
}
|
|
|
|
func shouldCacheLayoutAttributes(for message: MessageType) -> Bool {
|
|
return false
|
|
}
|
|
|
|
// MARK: - Text Messages Defaults
|
|
|
|
func messageLabelInset(for message: MessageType, at indexPath: IndexPath, in messagesCollectionView: MessagesCollectionView) -> UIEdgeInsets {
|
|
guard let dataSource = messagesCollectionView.messagesDataSource else {
|
|
fatalError(MessageKitError.nilMessagesDataSource)
|
|
}
|
|
if dataSource.isFromCurrentSender(message: message) {
|
|
return UIEdgeInsets(top: 7, left: 14, bottom: 7, right: 18)
|
|
} else {
|
|
return UIEdgeInsets(top: 7, left: 18, bottom: 7, right: 14)
|
|
}
|
|
}
|
|
|
|
// MARK: - Media Messages Defaults
|
|
|
|
func widthForMedia(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat {
|
|
return maxWidth
|
|
}
|
|
|
|
func heightForMedia(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat {
|
|
switch message.data {
|
|
case .photo(let image), .video(_, let image):
|
|
let boundingRect = CGRect(origin: .zero, size: CGSize(width: maxWidth, height: .greatestFiniteMagnitude))
|
|
return AVMakeRect(aspectRatio: image.size, insideRect: boundingRect).height
|
|
default:
|
|
return 0
|
|
}
|
|
}
|
|
|
|
// MARK: - Location Messages Defaults
|
|
|
|
func widthForLocation(message: MessageType, at indexPath: IndexPath, with maxWidth: CGFloat, in messagesCollectionView: MessagesCollectionView) -> CGFloat {
|
|
return maxWidth
|
|
}
|
|
}
|