LetterAvatarKit

LetterAvatarKit

Requirements

Features

Installation

CocoaPods

pod "LetterAvatarKit"

Swift Package Manager

Usage

Swift

// Square avatar image
let avatarImage = LetterAvatarMaker()
    .setUsername("Letter Avatar")
    .build()
avatarImageView.image = avatarImage

// Circle avatar image with white border
let circleAvatarImage = LetterAvatarMaker()
    .setCircle(true)
    .setUsername("Letter Avatar")
    .setBorderWidth(1.0)
    .setBackgroundColors([ .red ])
    .build()
avatarImageView.image = circleAvatarImage

// Avatar image with explicit text instead of derived initials
let customTextAvatarImage = LetterAvatarMaker()
    .setUsername("+19")
    .setLetters("+19")
    .build()
avatarImageView.image = customTextAvatarImage

let avatarImage = LetterAvatarMaker()
    .build { c in
        c.username = "Letter Avatar"
    }
avatarImageView.image = avatarImage

let avatarImage = LetterAvatarMaker()
    .build { c in
        c.circle = true
        c.username = "Letter Avatar"
        c.borderWidth = 1.0
        c.backgroundColors = [ .red ]
    }
avatarImageView.image = avatarImage

let configuration = LetterAvatarBuilderConfiguration()
configuration.username = "Letter Avatar"
avatarImageView.image = UIImage.makeLetterAvatar(configuration: configuration)

avatarImageView.image = UIImage.makeLetterAvatar(username: "Letter Avatar")

Customization

/// The username.
open var username: String?

/// Letters that should be drawn instead of deriving them from the username.
open var letters: String?

/// The size of an avatar image.
open var size: CGSize = CGSize(width: 80, height: 80)

/// The flag that indicates of using single only one letter, otherwise,
/// as much as wil be possible to obtain. But no more than 3 letters.
open var useSingleLetter: Bool = false

/// The letters font.
open var lettersFont: UIFont?

/// The letters colors
open var lettersColor: UIColor = LKUIColorByRGB(red: 236, green: 240, blue: 241)

/// The background colors of an image.
open var backgroundColors: [UIColor] = UIColor.colors

/// The letters font attributes.
open var lettersFontAttributes: [NSAttributedString.Key: Any]?

/// Indicates whether to generate circle or square image.
open var circle: Bool = false

/// The border width of the image.
open var borderWidth: CGFloat = 0.0

/// The border color of the image.
open var borderColor: UIColor = UIColor.white

/// A Boolean flag indicating whether the avatar is opaque.
open var isOpaque: Bool = false

Community

Contacts

License