BoringAvatars.Props (Boring Avatars v0.1.1)

Copy Markdown View Source

Properties for generating avatars.

These properties control the appearance of the generated SVG avatar.

Fields

  • :colours - A list of colours to use for the avatar (defaults to ["#92A1C6", "#146A7C", "#F0AB3D", "#C271B4", "#C20D90"]).
  • :name - The name used to seed the avatar generation (defaults to "Clara Barton").
  • :title - The title text to include in the SVG, or false for no title (defaults to false).
  • :size - The size of the avatar SVG (defaults to "40px").
  • :square - Whether the avatar should fill the entire image instead of having a circular mask applied (defaults to false).

Summary

Types

t()

Types

t()

@type t() :: %BoringAvatars.Props{
  colours: [String.t()],
  name: String.t(),
  size: String.t() | integer(),
  square: boolean(),
  title: String.t() | false
}