dreamworkAPI
Ctrl K
GitHub
typeDocs / fluent / DateTimeOptions

fluent.DateTimeOptions

typesharedmenusource

The options of fluent.DateTime and DATETIME, a subset of Intl.DateTimeFormat options.

The component options pick the closest locale style:

  • weekday - "full" date;
  • month: "long" - "long" date;
  • month: "short" - "medium" date;
  • year, month or day - "short" date;
  • second - "medium" time;
  • hour or minute - "short" time.

timeZone can be set only from Lua, translators can not change it.

Fields

NameTypeDescription
dateStyle"full" | "long" | "medium" | "short" | nilThe date style.
timeStyle"full" | "long" | "medium" | "short" | nilThe time style, "long" and "full" are the same as "medium".
weekdaystring | nilShows the weekday.
yearstring | nilShows the year.
monthstring | nilShows the month.
daystring | nilShows the day.
hourstring | nilShows the hour.
minutestring | nilShows the minute.
secondstring | nilShows the second.
hour12boolean | "true" | "false" | nilOverrides the locale 12/24-hour clock.
timeZonestring | nil"UTC" formats the UTC time, any other value or nil formats the local time.
Generated from the dreamwork meta branch.