Catppuccin.Flavor (catppuccin v0.1.2)

Module to retrieve information about flavors.

Summary

Types

t()

Data structure representing a flavor.

Functions

dark(arg)

Returns if the flavor is dark.

emoji(arg)

Returns the emoji of the flavor.

name(arg)

Returns the name of the flavor.

order(arg)

Returns the order of the flavor.

Types

t()

@type t() :: %Catppuccin.Flavor{
  colors: %{required(atom()) => Color.t()},
  dark: boolean(),
  emoji: String.t(),
  name: String.t(),
  order: integer()
}

Data structure representing a flavor.

Functions

dark(arg)

@spec dark({atom(), t()}) :: boolean()

Returns if the flavor is dark.

Examples

iex> Catppuccin.latte |> Catppuccin.Flavor.dark
false

iex> Catppuccin.frappe |> Catppuccin.Flavor.dark
true

emoji(arg)

@spec emoji({atom(), t()}) :: String.t()

Returns the emoji of the flavor.

Examples

iex> Catppuccin.latte |> Catppuccin.Flavor.emoji
"🌻"

name(arg)

@spec name({atom(), t()}) :: String.t()

Returns the name of the flavor.

Examples

iex> Catppuccin.latte |> Catppuccin.Flavor.name
"Latte"

order(arg)

@spec order({atom(), t()}) :: integer()

Returns the order of the flavor.

Examples

iex> Catppuccin.latte |> Catppuccin.Flavor.order
0