Cldr Calendars Format v0.4.0 Cldr.Calendar.Format View Source

Formatting functions for calendars

Link to this section Summary

Functions

default_calendar_css_class()

default_formatter_module()

formatter_module?(formatter)

invalid_date_error(date)

invalid_formatter_error(formatter)

month(year, month, options \\ [])

Format one calendar year and month

year(year, options \\ [])

Format one calendar year

Link to this section Functions

default_calendar_css_class()

default_formatter_module()

formatter_module?(formatter)

invalid_date_error(date)

invalid_formatter_error(formatter)

month(year, month, options \\ [])

month(
  Calendar.year(),
  Calendar.month(),
  Cldr.Calendar.Formatter.Options.t() | Keyword.t()
) :: any()

Format one calendar year and month

Arguments

year is the year of the calendar to be formatted
month is the month of the calendar to be formatted
options is a Cldr.Calendar.Formatter.Options struct or a Keyword.t list of options.

Returns

The result of the format_month/4 callback of the configured formatter

Examples

=> Cldr.Calendar.Format.month(2019, 4)

=> Cldr.Calendar.Format.month(2019, 4, formatter: Cldr.Calendar.Formatter.HTML.Basic)

=> Cldr.Calendar.Format.month(2019, 4, formatter: Cldr.Calendar.Formatter.Markdown, locale: "fr"

year(year, options \\ [])

year(Calendar.year(), Cldr.Calendar.Formatter.Options.t() | Keyword.t()) ::
  any()

Format one calendar year

Arguments

year is the year of the calendar to be formatted
options is a Cldr.Calendar.Formatter.Options struct or a Keyword.t list of options.

Returns

The result of the format_year/3 callback of the configured formatter

Examples

=> Cldr.Calendar.Format.year(2019)

=> Cldr.Calendar.Format.year(2019, formatter: Cldr.Calendar.Formatter.Markdown)

=> Cldr.Calendar.Format.year(2019, formatter: Cldr.Calendar.Formatter.Markdown, locale: "fr"