/JSQMessagesViewController

An elegant messages UI library for iOS

Primary LanguageObjective-COtherNOASSERTION

JSQMessagesViewController banner

Build Status Version Status license MIT codecov.io Platform

Screenshot0    Screenshot1   

Screenshot2    Screenshot3

More screenshots available at CocoaControls

Features

See the website for the list of features.

Dependencies

Requirements

  • iOS 7.0+
  • ARC

Installation

CocoaPods (recommended)

# For latest release in cocoapods
pod 'JSQMessagesViewController'  

# Latest on develop
pod 'JSQMessagesViewController', :git => 'https://github.com/jessesquires/JSQMessagesViewController.git', :branch => 'develop'

# For version 5.3.2
pod 'JSQMessagesViewController', :git => 'https://github.com/jessesquires/JSQMessagesViewController', :branch => 'version_5.3.2_patch'

Getting Started

#import <JSQMessagesViewController/JSQMessages.h>    // import all the things

Read the blog post about the 6.0 release!

  • Demo Project

    • There's a sweet demo project: JSQMessages.xcworkspace.
    • Run pod install first.
    • Firebase also has a sweet demo project, and it's in Swift!

  • Message Model

    • Your message model objects should conform to the JSQMessageData protocol.
    • However, you may use the provided JSQMessage class.

  • Media Attachment Model

    • Your media attachment model objects should conform to the JSQMessageMediaData protocol.
    • However, you may use the provided classes: JSQPhotoMediaItem, JSQLocationMediaItem, JSQVideoMediaItem.
    • Creating your own custom media items is easy! Simply follow the pattern used by the built-in media types.
    • Also see JSQMessagesMediaViewBubbleImageMasker for masking your custom media views as message bubbles.

  • Avatar Model

    • Your avatar model objects should conform to the JSQMessageAvatarImageDataSource protocol.
    • However, you may use the provided JSQMessagesAvatarImage class.
    • Also see JSQMessagesAvatarImageFactory for easily generating custom avatars.

  • Message Bubble Model

    • Your message bubble model objects should conform to the JSQMessageBubbleImageDataSource protocol.
    • However, you may use the provided JSQMessagesBubbleImage class.
    • Also see JSQMessagesBubbleImageFactory and UIImage+JSQMessages.h for easily generating custom bubbles.

  • View Controller

    • Subclass JSQMessagesViewController.
    • Implement the required methods in the JSQMessagesCollectionViewDataSource protocol.
    • Implement the required methods in the JSQMessagesCollectionViewDelegateFlowLayout protocol.
    • Set your senderId and senderDisplayName. These properties correspond to the methods found in JSQMessageData and determine which messages are incoming or outgoing.

  • Customizing

    • The demo project is well-commented. Please use this as a guide.

Questions & Help

  • Review the FAQ.
  • Search issues for previous and current questions. Do not open duplicates.
  • See the StackOverflow tag, which is often the appropriate place for questions and help.
  • See the Migration Guide for migrating between major versions of the library.
  • Only ask questions that are specific to this library.
  • Please avoid emailing questions. I prefer to keep questions and their answers open-source.

Documentation

Read the docs, available here via @CocoaDocs.

Contribute

Please follow these sweet contribution guidelines.

Donate

Support the development of this free open-source library!

Donations made via Square Cash.

Send $5 Just saying thanks. Here's a coffee! ☕

Send $10 This library is great. Lunch is on me! 🍜

Send $25 This totally saved me time. Go get a nice dinner! 🍴

Send $50 I love this library. I want new features! 👏

Send $100 I really want to support this project! 🎉

>*You can also send donations via [PayPal](https://www.paypal.com/home). Message me on [twitter](https://twitter.com/jesse_squires).*

Credits

Created by @jesse_squires.

Maintained by @jesse_squires and @harlanhaskins.

About

I initially developed this library to use in Hemoglobe for private messages between users.

As it turns out, messaging is something that iOS devs and users really want. Messaging of any kind has turned out to be an increasingly popular mobile app feature in all sorts of contexts and for all sorts of reasons. Thus, I am supporting this project in my free time and have added features way beyond what Hemoglobe ever needed.

Feel free to read my blog and check out my work at Hexed Bits.

Apps using this library

According to CocoaPods stats, over 4,000 apps are using JSQMessagesViewController. Here are the ones that we know about. Please submit a pull request to add your app! 😄

License

JSQMessagesViewController is released under an MIT License. See LICENSE for details.

Copyright © 2013-present Jesse Squires.

Please provide attribution, it is greatly appreciated.