百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
L

letter_avatar

> 编程语言
开源

Ruby gem 用于从用户名(或任何其他字符串 :-) )创建字母头像。

273 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

Ruby gem 用于从用户名(或任何其他字符串 :-) )创建字母头像。

LetterAvatar

Gem for creating letter avatar from user's name (or any other strong / character).

Code extracted from discourse source (thanks guys!) - I needed this functionality in three projects, so here's the gem! :-)

Examples

Google's Inbox Palette

Installation

System requirements

bash
$ sudo apt-get install -y imagemagick

Mac OS X

bash
$ brew install imagemagick ghostscript

Add this line to your application's Gemfile:

ruby
gem 'letter_avatar'

And then execute:

bash
$ bundle

Or install it yourself as:

bash
$ gem install letter_avatar

Configuration

ruby
LetterAvatar.setup do |config|
  config.fill_color        = 'rgba(255, 255, 255, 1)' # default is 'rgba(255, 255, 255, 0.65)'
  config.cache_base_path   = 'public/system/lets'     # default is 'public/system'
  config.colors_palette    = :iwanthue                # default is :google
  config.weight            = 500                      # default is 300
  config.annotate_position = '-0+10'                  # default is -0+5
  config.letters_count     = 2                        # default is 1
  config.pointsize         = 70                       # default is 140
end

Color palette

We have three color palettes implemented: iwanthue, google and custom.

Each of them have different colors, but the iwanthue also differently calculates the color for specified username.

The google selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but iwanthue will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.

Custom palette definition

You can define your own custom palette:

ruby
LetterAvatar.setup do |config|
  config.colors_palette = :custom
  config.custom_palette = [[120, 132, 205], [91, 149, 249], [72, 194, 249], [69, 208, 226]]
end
Custom font definition

You can define your own custom palette:

ruby
LetterAvatar.setup do |config|
  config.font = File.join(File.expand_path('../../', File.dirname(__FILE__)), 'app/assets/fonts', 'font_name.ext')
end

Usage

ruby
LetterAvatar.generate 'ksz2k', 200
=> "public/system/letter_avatars/2/K/87_178_230/200.png"

In your controllers / views

There's also helper for this. To use it, you need:

  • in your helper (eg. ApplicationHelper) or controller:

    ruby
    include LetterAvatar::AvatarHelper
  • and in your view:

    ruby
    letter_avatar_for('ksz2k', 200)
    => "public/system/letter_avatars/2/K/87_178_230/200.png"
    # or
    letter_avatar_url('ksz2k', 200)
    => "/system/letter_avatars/2/K/87_178_230/200.png"
    # or even
    letter_avatar_tag('ksz2k', 200, class: 'av')
    => ""

In your model

Say, you have a model User (which must have attribute or method name)

ruby
require 'letter_avatar/has_avatar'

class User
  include LetterAvatar::HasAvatar
  ...

  def name
    'ksz2k'
  end
end

Then, in your views you can use:

ruby
@user.avatar_path(200)
=> "public/system/letter_avatars/2/K/87_178_230/200.png"
# or
@user.avatar_url(200)
=> "/system/letter_avatars/2/K/87_178_230/200.png"

Way to support non [a-z0-9] charsets

rb
class User
  def username_for_avatar
    # Translate Chinese hanzi to pinyin
    # https://github.com/flyerhzm/chinese_pinyin
    Pinyin.t(self.username)
  end
end

Then you can get right avatar now:

rb
letter_avatar_for(user.username_for_avatar, 200)
# or
letter_avatar_tag(user.username_for_avatar, 200, class: 'av')

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Issues· 2 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Rubyletter-avatarruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言