BoringAvatars behaviour (Boring Avatars v0.1.1)

Copy Markdown View Source

Direct port of boring-avatars to Elixir.

Generates SVG avatars based on a given name and a color palette.

Usage

iex> BoringAvatars.beam(name: "Maria")

Options can be passed as a keyword list or as a %BoringAvatars.Props{} struct. See BoringAvatars.Props for all available options.

Summary

Callbacks

avatar(arg1)

Callback to implement for a custom avatar variant.

Functions

bauhaus(props \\ [])

Generates a Bauhaus variant avatar.

beam(props \\ [])

Generates a Beam variant avatar.

marble(props \\ [])

Generates a Marble variant avatar.

pixel(props \\ [])

Generates a Pixel variant avatar.

ring(props \\ [])

Generates a Ring variant avatar.

sunset(props \\ [])

Generates a Sunset variant avatar.

Callbacks

avatar(arg1)

@callback avatar(
  %BoringAvatars.Props{
    colours: term(),
    name: term(),
    size: term(),
    square: term(),
    title: term()
  }
  | keyword()
) :: iodata()

Callback to implement for a custom avatar variant.

Receives a %BoringAvatars.Props{} struct or a keyword list of options and should return iodata() representing the generated SVG.

Functions

bauhaus(props \\ [])

Generates a Bauhaus variant avatar.

beam(props \\ [])

Generates a Beam variant avatar.

marble(props \\ [])

Generates a Marble variant avatar.

pixel(props \\ [])

Generates a Pixel variant avatar.

ring(props \\ [])

Generates a Ring variant avatar.

sunset(props \\ [])

Generates a Sunset variant avatar.