Logo

AueraUI

Docs

Components

Utilities

Format Date

Formats a date into a readable string using the specified format.

Logo

Supported Formats

FormatOutput Example (for new Date(2025, 2, 15))
yyyy-mm-dd2025-03-15
mm-yyyy03-2025
dd-mmm15 Mar
mmm-ddMar 15
ddd-mmm-ddSat Mar 15
yyyy/mm/dd2025/03/15
dd-mm-yyyy15-03-2025
mmm-yyyyMar 2025
fullSaturday, March 15, 2025

Parameters

date

Type:

Date

The date object to be formatted.

Default:

format

Type:

"yyyy-mm-dd" | "mm-yyyy" | "dd-mmm" | "ddd-mmm-dd" | "yyyy/mm/dd" | "dd-mm-yyyy" | "mmm-yyyy" | "full"

The format pattern for the output date.

Default:

yyyy-mm-dd
locale

Type:

"en-US" | "en-GB" | "en-CA" | "en-AU" | "en-IN" | "en-NZ" | "en-ZA" | "fr-FR" | "fr-CA" | "de-DE" | "es-ES" | "es-MX" | "it-IT" | "nl-NL" | "pt-PT" | "pt-BR" | "ru-RU" | "pl-PL" | "zh-CN" | "zh-TW" | "ja-JP" | "ko-KR" | "hi-IN" | "th-TH" | "vi-VN" | "ar-SA" | "he-IL" | "tr-TR" | "fa-IR"

The locale for formatting.

Default:

en-US
replaceFormat

Type:

"" | "-" | "/" | " " | "," | ":"

A string to replace default separators

Default:

timeZone

Type:

"UTC" | "PST" | "EST" | "CST" | "MST" | "IST" | "GMT" | "CET" | "EET" | "JST" | "AEST" | "AKST" | "HST" | "AST" | "NST" | "SST" | "CHST" | "BST" | "WET" | "EAT" | "MSK" | "SAMT" | "PKT" | "ICT" | "SGT" | "CST-China" | "KST" | "AEDT" | "NZST" | "FJT" | "HKT"

The time zone to use for formatting.

Default: