README
¶
Avatar: Generate Avatars for the web
Avatar is a package that allows you to create avatars for pictures and initials.
You can create square avatars, or round avatars.
Picture:
size := 200
fileBytes, _ := ioutil.ReadFile("./test_data/super_mascot.jpg")
newAvatar, _ := NewAvatarFromPic(fileBytes, &PictureOptions{
Size: size, // default 300
})
round, err := newAvatar.Circle()
roundFile, _ := os.Create("./output/round_super_mascot.png")
roundFile.Write(round)
square, err := newAvatar.Square()
squareFile, _ := os.Create("./output/square_super_mascot.png")
roundFile.Write(square)
Initials:
size := 200
newAvatar, err := NewAvatarFromInitials([]byte("John Smith"), &InitialsOptions{
FontPath: "./test_data/Arial.ttf", // Required
Size: size, // default 300
NInitials: 2, // default 1 - If 0, the whole text will be printed
TextColor: color.White, // Default White
BgColor: color.RGBA{0, 0, 255, 255}, // Default color.RGBA{215, 0, 255, 255} (purple)
})
square, _ := newAvatar.Square()
squareFile, _ := os.Create("./output/square_john_smith_initials.png")
defer squareFile.Close()
squareFile.Write(square)
round, _ := newAvatar.Circle()
roundFile, _ := os.Create("./output/round_john_smith_initials.png")
defer roundFile.Close()
roundFile.Write(round)
The input for initials can be any text, and the package identifies the best candidates for the initials.
If you give it an email address, it will try to identify the initials in the string preceding the @.
Not specifying NInitials in options would print the whole text as is.
And the font path is required, so maybe it should not be put in InitialsOptions, we'll see what the community thinks.
What you get:
From our original picture:
Our outputs
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AvatarOptions ¶
type AvatarOptions interface {
// contains filtered or unexported methods
}
type Circle ¶
type Circle struct {
// contains filtered or unexported fields
}
func (*Circle) ColorModel ¶
type Color ¶
type Color struct {
colorful.Color
}
func MustParseHex ¶
This is a very nice thing Golang forces you to do! It is necessary so that we can write out the literal of the colortable below.
type GradientTable ¶
This table contains the "keypoints" of the colorgradient you want to generate. The position of each keypoint has to live in the range [0,1]
type Initials ¶
type Initials struct {
// contains filtered or unexported fields
}
func NewAvatarFromInitials ¶
func NewAvatarFromInitials(text string, options *InitialsOptions) (*Initials, error)
type InitialsOptions ¶
type Picture ¶
type Picture struct {
// contains filtered or unexported fields
}
func NewAvatarFromPic ¶
func NewAvatarFromPic(pic []byte, options *PictureOptions) (*Picture, error)
Source Files