QMChatViewController

An elegant ready-to-go chat view controller for iOS chat applications that use Quickblox communication backend.

#Features

• Ready-to-go chat view controller with a set of cells.
• Automatic cell size calculation.
• UI customization for chat cells.
• Flexibility in improving and extending functionality.
• Easy to connect with Quickblox.
• Optimized and performant.
• Supports portrait and landscape orientations.
• Auto Layout inside.

Screenshots

Requirements

• iOS 8.0+
• ARC
• Xcode 6+
• Quickblox SDK 2.0+
• TTTAttributedLabel
• SDWebImage

Installation

CocoaPods

pod 'QMChatViewController'

Manually

• DragQMChatViewController folder to your project folder and link to the appropriate target.

• Install dependencies.

Dependencies

• TTTAttributedLabel
• SDWebImage
• Quickblox iOS SDK v2.0+

Getting started

An example is included in the repository. Try it out to see how chat view controller works.

Steps to add QMChatViewController to Your app:

1. Create a subclass of QMChatViewController. You could create it both from code and Interface Builder.

2. Open your subclass of QMChatViewController and do the following in viewDidLoad method:

   • Configure chat sender ID and display name:

   self.senderID = 2000;
   self.senderDisplayName = @"user1";

   • Insert messages using corresponding methods:

   [self.chatDataSource addMessages:<array of messages>];

3. Handle message sending.

   - (void)didPressSendButton:(UIButton *)button
   	       withMessageText:(NSString *)text
   			      senderId:(NSUInteger)senderId
    		 senderDisplayName:(NSString *)senderDisplayName
                 		  date:(NSDate *)date {
   	// Add sending message - for example:
       QBChatMessage *message = [QBChatMessage message];
   	message.text = text;
   	message.senderID = senderId;
   
   	QBChatAttachment *attacment = [[QBChatAttachment alloc] init];
   	message.attachments = @[attacment];
   
   	[self.chatDataSource addMessage:message];
   
   	[self finishSendingMessageAnimated:YES];
   
    	// Save message to your cache/memory storage.                     
   	// Send message using Quickblox SDK
   }

4. Return cell view classes specific to chat message:

   - (Class)viewClassForItem:(QBChatMessage *)item {
       // Cell class for message
       if (item.senderID != self.senderID) {
           
           return [QMChatIncomingCell class];
       }
       else {
           
           return [QMChatOutgoingCell class];
       }
   
       return nil;
   }
   

5. Calculate size of cell and minimum width:

   - (CGFloat)collectionView:(QMChatCollectionView *)collectionView minWidthAtIndexPath:(NSIndexPath *)indexPath {
   
       QBChatMessage *item = [self.chatDataSource messageForIndexPath:indexPath];
       
       NSAttributedString *attributedString = item.senderID == self.senderID ?
       [self bottomLabelAttributedStringForItem:item] : [self topLabelAttributedStringForItem:item];
       
       CGSize size = [TTTAttributedLabel sizeThatFitsAttributedString:attributedString
                                                      withConstraints:CGSizeMake(1000, 10000)
                                               limitedToNumberOfLines:1];
       return size.width;
   }

6. Top, bottom and text labels.

   - (NSAttributedString *)attributedStringForItem:(QBChatMessage *)messageItem {
       
       UIColor *textColor = [messageItem senderID] == self.senderID ?
       [UIColor whiteColor] : [UIColor colorWithWhite:0.290 alpha:1.000];
       
       UIFont *font = [UIFont fontWithName:@"Helvetica" size:15];
       NSDictionary *attributes = @{NSForegroundColorAttributeName:textColor,
                                    NSFontAttributeName:font};
       
       NSMutableAttributedString *attrStr =
       [[NSMutableAttributedString alloc] initWithString:messageItem.text
                                              attributes:attributes];
       return attrStr;
   }
   
   - (NSAttributedString *)topLabelAttributedStringForItem:(QBChatMessage *)messageItem {
       
       if (messageItem.senderID == self.senderID) {
           
           return nil;
       }
       
       UIFont *font = [UIFont fontWithName:@"Helvetica" size:14];
       
       UIColor *textColor = [UIColor colorWithRed:0.184 green:0.467 blue:0.733 alpha:1.000];
       
       NSDictionary *attributes = @{NSForegroundColorAttributeName:textColor,
                                    NSFontAttributeName:font};
       
       NSMutableAttributedString *attrStr =
       [[NSMutableAttributedString alloc] initWithString:@"nickname"
                                              attributes:attributes];
       return attrStr;
   }
   
   - (NSAttributedString *)bottomLabelAttributedStringForItem:(QBChatMessage *)messageItem {
       
       UIFont *font = [UIFont fontWithName:@"Helvetica" size:12];
       UIColor *textColor = [messageItem senderID] == self.senderID ?
       
       [UIColor colorWithWhite:1.000 alpha:0.510] : [UIColor colorWithWhite:0.000 alpha:0.490];
       
       NSDictionary *attributes = @{NSForegroundColorAttributeName:textColor,
                                    NSFontAttributeName:font};
       
       NSString *dateStr = @"10:20";
       
       NSMutableAttributedString *attrStr =
       [[NSMutableAttributedString alloc] initWithString:dateStr
                                              attributes:attributes];
       return attrStr;
   }

7. Modifying collection chat cell attributes without changing constraints:

   struct QMChatLayoutModel {
   
   	CGSize avatarSize;
   	CGSize containerSize;
   	UIEdgeInsets containerInsets;
   	CGFloat topLabelHeight;
   	CGFloat bottomLabelHeight;
   	CGSize staticContainerSize;
   	CGFloat maxWidthMarginSpace;
   };
   
   typedef struct QMChatLayoutModel QMChatCellLayoutModel;

   • size of the avatar image view
   • message view container size
   • top label height
   • bottom label height
   • static size of container view
   • margin space between message and screen end

   You can modify this attributes in this method:

   - (QMChatCellLayoutModel)collectionView:(QMChatCollectionView *)collectionView layoutModelAtIndexPath:(NSIndexPath *)indexPath {
   
   	QMChatCellLayoutModel layoutModel = [super collectionView:collectionView layoutModelAtIndexPath:indexPath];
   	//Update attributes here ...
   	return layoutModel;
   }

   So if you want to hide top label or bottom label you just need to set their height to 0.

Attachments

QMChatViewController supports image attachment cell messages. QMChatAttachmentIncomingCell is used for incoming attachments, QMChatAttachmentOutgoingCell is used for outgoing attachments. Both of them have progress label to display loading progress. XIB's are also included.

Chat data source

QMChatViewController contains its data source manager called QMChatDataSource. It has implementation of all methods, which you need to work with QMChatViewController. This class should be used to add, update and delete messages from data source. QMChatDataSource has delegate, which called whenever data source were modified.

For more information on methods and its usage check out our inline doc in QMChatDataSource.h.

Questions & Help

• You could create an issue on GitHub if you are experiencing any problems. We will be happy to help you.
• Or you can ask a 'quickblox' tagged question on StackOverflow http://stackoverflow.com/questions/ask

Documentation

Inline code documentation available.

License

See LICENSE