https://github.com/jndisrupter/jnhorizontalgroupavatarcollectionview
Horizontal Group Avatar Collection View
https://github.com/jndisrupter/jnhorizontalgroupavatarcollectionview
avatar collectionview group horizontal horizontal-scrolling swift user-profile
Last synced: 5 months ago
JSON representation
Horizontal Group Avatar Collection View
- Host: GitHub
- URL: https://github.com/jndisrupter/jnhorizontalgroupavatarcollectionview
- Owner: JNDisrupter
- License: mit
- Created: 2018-02-26T17:13:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-05T17:10:25.000Z (over 6 years ago)
- Last Synced: 2025-04-15T05:02:12.658Z (6 months ago)
- Topics: avatar, collectionview, group, horizontal, horizontal-scrolling, swift, user-profile
- Language: Swift
- Homepage:
- Size: 1.4 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JNHorizontalGroupAvatarCollectionView
[](http://cocoapods.org/pods/JNHorizontalGroupAvatarCollectionView)
[](http://cocoapods.org/pods/JNHorizontalGroupAvatarCollectionView)
[](http://cocoapods.org/pods/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](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate JNHorizontalGroupAvatarCollectionView into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
use_frameworks!
target '' do
pod 'JNHorizontalGroupAvatarCollectionView'
end
```
Then, run the following command:
```bash
$ pod install
```
## Usage
#### To add JNHorizontalGroupAvatarCollectionView in interface builder:
1. Put some UIView and change the class to "JNHorizontalGroupAvatarCollectionView"
2. Add refrence for it in the view controller.
3. Implement JNHorizontalGroupAvatarCollectionViewDelegate in your view controller and set delegate like the following:
```swift
/**
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()
```
4. Implement JNGroupAvatar In your items 'like users' class like the following:
```swift
/**
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](https://github.com/JNDisrupter/JNGroupAvatarImageView), check it for more info.
## Author
Jayel Zaghmoutt, Mohammad Nabulsi & Ali Hamad
## License
JNHorizontalGroupAvatarCollectionView is available under the MIT license. See the [LICENSE](https://github.com/JNDisrupter/JNHorizontalGroupAvatarCollectionView/blob/master/LICENSE) file for more info.