JNHorizontalGroupAvatarCollectionView

JNHorizontalGroupAvatarCollectionView is used to show a collection of avatar images with the option to show initials, it shows as much as the phone screen can present with a horizontal scrolling to see more.

Screenshots

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

iOS 9.0+ / macOS 10.10+
Xcode 9.0+
Swift 4+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate JNHorizontalGroupAvatarCollectionView into your Xcode project using CocoaPods, specify it in your Podfile:

use_frameworks!

target '<Your Target Name>' do
pod 'JNHorizontalGroupAvatarCollectionView'
end

Then, run the following command:

$ pod install

Usage

To add JNHorizontalGroupAvatarCollectionView in interface builder:

Put some UIView and change the class to "JNHorizontalGroupAvatarCollectionView"
Add refrence for it in the view controller.
Implement JNHorizontalGroupAvatarCollectionViewDelegate in your view controller and set delegate like the following:

/**
Number of items
- Returns: The number of items in collection view
*/
func horizontalGroupAvatarCollectionViewNumberOfItems() -> Int

/**
Data for item at index
- Parameter index: The item index
- Returns: The data for the item
*/
func horizontalGroupAvatarCollectionView(dataForItemAt index: Int) -> [JNGroupAvatar]

/**
Did clear data
*/
func horizontalGroupAvatarCollectionViewDidClearData()

Implement JNGroupAvatar In your items 'like users' class like the following:

/**
Get display name which will be used for the initials.
- Returns: The display name for the avatar
*/
func getGroupAvatarDisplayName() -> String

/**
Get Avatar image url which will be used as avatar url
- Returns: The image url
*/
func getGroupAvatarImageUrl() -> String

/**
Get Avatar image which will be used as avatar
- Returns: The image
*/
func getGroupAvatarImage() -> UIImage

cellPadding : The padding between each avatars image.
avatars : Array fo JNGroupAvatar which will be used to draw .
imagesLayoutDirection : The image layout direction to use (right to left or left to right).
avatarsMargin : The margin between avatars (separator with or height).
separatorColor : The separator color to use.
placeHolderImage : The placeholder to use if the image failed to load.
showInitails : Show initials if the image failed to load or not, if false then set placeholder image.
initialsFont : The font to use for the initials.
initialTextColor : The text color to use for the initials.

The libarary is dependant on JNGroupAvatarImageView, check it for more info.

Author

Jayel Zaghmoutt, Mohammad Nabulsi & Ali Hamad

License

JNHorizontalGroupAvatarCollectionView is available under the MIT license. See the LICENSE file for more info.

JNDisrupter/JNHorizontalGroupAvatarCollectionView