View Source ExTeal.Cards.Greeting behaviour (ExTeal v0.28.1)

Not the thing you get the mail, but a card that appears on the dashboard.

Summary

link()

Each link should be a map with the following keys

avatar_url(t)

64px x 64px image url to display next to the greeting

greeting()

Greeting for a user viewing the card. Defaults to 'Welcome back,'

helper_text(t)

Potentially HTML Rich text to display below the users title. Beware any unescaped / unsanitary HTML.

links(t)

A list of links to display on a greeting card.

user_name(t)

The name to greet the user by, use the conn to pull the currently authorized user.

user_title(t)

The users title, useful in applications with RBAC or permissions

@type link() :: %{
  optional(:button_classes) => String.t() | nil,
  label: String.t(),
  url: String.t()
}

Each link should be a map with the following keys:

Buttons default to a btn btn-default btn-secondary class definition if an override is not provided

@callback avatar_url(Plug.Conn.t()) :: String.t() | nil