Documentation

UI/Datepicker/$.datepicker.formatDate

From jQuery JavaScript Library

Jump to: navigation, search


« Back to UI/Datepicker

$.datepicker.formatDate( format, date, [settings] )

Format a date into a string value with a specified format.
The format can be combinations of the following:
  • d - day of month (no leading zero)
  • dd - day of month (two digit)
  • D - day name short
  • DD - day name long
  • m - month of year (no leading zero)
  • mm - month of year (two digit)
  • M - month name short
  • MM - month name long
  • y - year (two digit)
  • yy - year (four digit)
  • @ - Unix timestamp (also known as epoch seconds or POSIX time) in milliseconds since 01/01/1970
  • '...' - literal text
  • '' - single quote
  • anything else - literal text

There are also a number of predefined standard date formats available from $.datepicker:

  • ATOM - 'yy-mm-dd' (Same as RFC 3339/ISO 8601)
  • COOKIE - 'D, dd M yy'
  • ISO_8601 - 'yy-mm-dd'
  • RFC_822 - 'D, d M y' (See RFC 822)
  • RFC_850 - 'DD, dd-M-y' (See RFC 850)
  • RFC_1036 - 'D, d M y' (See RFC 1036)
  • RFC_1123 - 'D, d M yy' (See RFC 1123)
  • RFC_2822 - 'D, d M yy' (See RFC 2822)
  • RSS - 'D, d M y' (Same as RFC 822)
  • TIMESTAMP - '@'
  • W3C - 'yy-mm-dd' (Same as ISO 8601)
Arguments:

formatString
The format to use in presenting the date.
dateDate
The date value to be displayed.
settings (Optional)Object
Additional parameters for formatting the date. All are optional and default to the datapicker defaults, which are usually standard English.

Attributes include:
dayNamesShort (String[7]) - the short names for the days of the week, starting at Sunday.
dayNames (String[7]) - the long names for the days of the week, starting at Sunday.
monthNamesShort (String[12]) - the short names for the months of the year.
monthNames (String[12]) - the long names for the months of the year.


Examples:
Display the date in ISO format. Produces '2007-01-26'.

$.datepicker.formatDate('yy-mm-dd', new Date(2007, 1 - 1, 26));

Display the date in RSS format.

$.datepicker.formatDate($.datepicker.RSS, new Date(2007, 1 - 1, 26));

Display the date in expanded French format. Produces 'Samedi, Juillet 14, 2007'.

$.datepicker.formatDate('DD, MM d, yy', new Date(2007, 7 - 1, 14), {dayNamesShort: $.datepicker.regional['fr'].dayNamesShort, dayNames: $.datepicker.regional['fr'].dayNames, monthNamesShort: $.datepicker.regional['fr'].monthNamesShort, monthNames: $.datepicker.regional['fr'].monthNames});

NameType