Lavatar

Create letter avatars from user initials.

Installation

Add this line to your application's Gemfile:

gem 'lavatar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lavatar

Configuration

You can override default configuration, for example in config/initializers/lavatar.rb:

Lavatar.configure do |config|
  config.saturation  = 0.4 # from 0 to 1
  config.lightness   = 0.5 # from 0 to 1
  config.font_size   = 48  
  config.font_weight = 700
  config.font_color  = "#ffffff"  
end

Usage

lavatar_tag("JK", 24, {  # (required) letters and size (width and height)
  key:        123,       # user identifier to pick a color (ID, email, ...)  
  color:      "#9e5555", # forced background color  
  font_color: "#ffffff", # font color  
  class:      "my-class" # SVG element classes
)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jkostolansky/lavatar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Lavatar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

lavatar