Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jndisrupter/jnavatarwithinitials
Avatar with initials
https://github.com/jndisrupter/jnavatarwithinitials
avatar cocoapods fullname initials initials-avatar placeholder-image swift uiimage xcode
Last synced: 6 days ago
JSON representation
Avatar with initials
- Host: GitHub
- URL: https://github.com/jndisrupter/jnavatarwithinitials
- Owner: JNDisrupter
- License: mit
- Created: 2017-10-15T16:26:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-09T11:51:13.000Z (about 5 years ago)
- Last Synced: 2024-10-10T10:17:52.588Z (about 1 month ago)
- Topics: avatar, cocoapods, fullname, initials, initials-avatar, placeholder-image, swift, uiimage, xcode
- Language: Swift
- Homepage:
- Size: 326 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JNAvatarWithInitials
[![Build Status](https://travis-ci.org/JNDisrupter/JNAvatarWithInitials.svg?branch=master)](https://travis-ci.org/JNDisrupter/JNAvatarWithInitials)
[![Version](https://img.shields.io/cocoapods/v/JNAvatarWithInitials.svg?style=flat)](http://cocoapods.org/pods/JNAvatarWithInitials)
[![License](https://img.shields.io/cocoapods/l/JNAvatarWithInitials.svg?style=flat)](http://cocoapods.org/pods/JNAvatarWithInitials)
[![Platform](https://img.shields.io/cocoapods/p/JNAvatarWithInitials.svg?style=flat)](http://cocoapods.org/pods/JNAvatarWithInitials)**JNAvatarWithInitials** is used to show single avatar image usign web url or UIImage object and have the option to show initials.
## Screenshots
![ScreenShot1](https://github.com/JNDisrupter/JNAvatarWithInitials/raw/master/Images/screenshot1.png)## 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 JNAvatarWithInitials into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
use_frameworks!
target '' do
pod 'JNAvatarWithInitials'
end
```Then, run the following command:
```bash
$ pod install
```
## Usage#### To add JNAvatarWithInitials in interface builder:
1. Put some UIView and change the class to "JNAvatarWithInitials"
2. Add refrence for it in the view controller.
3. Change Attributes:
* initialsFont : The font that is used for the initials.
* initialTextColor : The text color that is used for the initials.
* initialLabelInset : The insets that applied to the initials label.
4. Call setup method:
> Setup view using image url```swift
func setup(imageUrl : String , placeHolderImage : UIImage , fullName : String , showInitails)
```
##### parameters
* imageUrl : The image url to use for loading image.
* placeHolderImage : The placeholder image to use when failed.
* fullName : The full name to use for initials.
* showInitails : Flag to indicate if should show initials or not.
> Setup view using UIImage
```swift
func setup(image : UIImage? , placeHolderImage : UIImage , fullName : String , showInitails)
```
##### parameters
* image : The UIImage object to set.
* placeHolderImage : The placeholder image to use if the UIImage object is nil.
* fullName : The full name to use for initials.
* showInitails : Flag to indicate if should show initials or not.
5. Getter methods:
> Get Image View
```swift
func getImageView() -> UIImageView
```
## AuthorsJayel Zaghmoutt & Mohammad Nabulsi
## License
JNAvatarWithInitials is available under the MIT license. See the [LICENSE](https://github.com/JNDisrupter/JNAvatarWithInitials/blob/master/LICENSE) file for more info.