La méthode toLocaleDateString()
renvoie une chaine de caractères correspondant à la date (le fragment de l'objet qui correspond à la date : jour, mois, année) exprimée selon une locale. Les arguments locales
et options
permettent aux applications de définir le langage utilisé pour les conventions de format et permettent de personnaliser le comportement de la fonction. Les anciennes implémentations ignorent ces arguments, la locale utilisée et le format de la chaine dépendent uniquement de l'implémentation.
Le code source de cet exemple interactif est disponible dans un dépôt GitHub. Si vous souhaitez contribuez à ces exemples, n'hésitez pas à cloner https://github.com/mdn/interactive-examples et à envoyer une pull request !
Syntaxe
dateObj.toLocaleDateString([locales [, options]])
Paramètres
Voir le tableau de compatibilité des navigateurs afin de déterminer quels navigateurs respectent les arguments locales
et options
ainsi que l'exemple Vérifier le support des arguments locales et options qui permet de détecter cette fonctionnalité.
locales
Facultatif-
Ce paramètre optionnel est une chaine de caractères avec un identifiant de langue BCP 47, ou un tableau de ce type de chaine de caractères. Pour utiliser la locale par défaut du navigateur, on pourra omettre cet argument (ou passer la valeur
undefined
). Pour le format général et l'interprétation de l'argumentlocales
, voir la pageIntl
. Les clefs d'extensions Unicode suivantes sont autorisées :- nu
- Système de numérotation. Les valeurs possibles incluent :
"arab", "arabext", "bali", "beng", "deva", "fullwide", "gujr", "guru", "hanidec", "khmr", "knda", "laoo", "latn", "limb", "mlym", "mong", "mymr", "orya", "tamldec", "telu", "thai", "tibt"
. - ca
- Calendrier. Les valeurs possibles incluent :
"buddhist", "chinese", "coptic", "ethiopia", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamicc", "iso8601", "japanese", "persian", "roc"
. hc
- Le type de cycle horaire à utiliser. Les valeurs possibles sont
"h11"
,"h12"
,"h23"
,"h24"
.
options
-
Un objet avec certaines ou toutes les propriétés suivantes :
localeMatcher
- L'algorithme de correspondance à utiliser pour la locale. Les valeurs possibles sont
"lookup"
et"best fit"
; le défaut est"best fit"
. Pour des informations sur cette option, voir la pageIntl
timeZone
- Le fuseau horaire à utiliser. La seule valeur que doivent reconnaitre les implémentations est "UTC" ; la valeur par défaut est le fuseau horaire du moteur JavaScript. Les implémentations peuvent aussi reconnaitre les noms de fuseau horaire de la base de données IANA de fuseaux horaires, tel que
"Asia/Shanghai"
,"Asia/Kolkata"
,"America/New_York"
. hour12
- S'il faut utiliser le format horaire sur 12 heures (au lieu de celui-ci sur 24 heures). Les valeurs possibles sont
true
etfalse
; la valeur par défaut dépend de la locale. Cette option surcharge l'étiquettehc
et/ou l'optionhourCycle
. hourCycle
- Le cycle horaire à utiliser. Les valeurs possibles sont
"h11"
,"h12"
,"h23"
,"h24"
. Cette option surcharge l'étiquettehc
mais sera remplacée parhour12
si cette dernière est présente. formatMatcher
- L'algorithme de correspondance à utiliser pour le formattage. Les valeurs possibles sont
"basic"
et"best fit"
; par défaut"best fit"
. Voir les paragraphes suivants pour des informations concernant l'usage de cette propriété.
Les propriétés suivantes décrivent les composants date-heure à utiliser pour le formattage de la sortie. Les implémentations ont pour obligation de supporter au minimum les ensembles suivants :
weekday, year, month, day, hour, minute, second
weekday, year, month, day
year, month, day
year, month
month, day
hour, minute, second
hour, minute
Les implémentations peuvent supporter d'autres sous-ensembles, et les demandes seront évaluées face à toutes les combinaisons de sous-ensembles disponibles pour trouver la meilleure correspondance. Deux algorithmes sont disponibles pour cette évaluation et choisis par la propriété
formatMatcher
: un algorithme "basic" complètement spécifié et un algorithme"best fit"
dépendant de l'implémentation.weekday
- La représentation du jour de la semaine. Les valeurs possibles sont :
"long"
(par exempleThursday
)"short"
(par exempleThu
)"narrow"
(par exempleT
). Deux jours de la semaines pourront partager la même représentation dans certaines locales (par exemple, en anglaisTuesday
sera également représenté avecT
en notation étroite).
era
- La représentation de l'ère. Les valeurs possibles sont :
"long"
(par exempleAnno Domini
)"short"
(par exempleAD
)"narrow"
(par exempleA
)
year
- La représentation de l'année. Les valeurs possibles sont :
"numeric"
(par exemple2012
)"2-digit"
(par exemple12
)
month
- La représentation du mois. Les valeurs possibles sont :
"numeric"
(par exemple2
)"2-digit"
(par exemple02
)"long"
(par exempleMarch
)"short"
(par exempleMar
)"narrow"
(par exempleM
). Dans certaines locales, deux mois pourront partager la même représentation avec le style étroit (par exemple,May
en anglais, sera également représenté avecM
).
day
- La représentation du jour. Les valeurs possibles sont :
"numeric"
(par exemple1
)"2-digit"
(par exemple01
)
hour
- La représentation de l'heure. Les valeurs possibles sont :
"numeric"
(par exemple1
)"2-digit"
(par exemple01
)
minute
- La représentation des minutes. Les valeurs possibles sont :
"numeric"
(par exemple1
)"2-digit"
(par exemple01
)
second
- La représentation des secondes. Les valeurs possibles sont :
"numeric"
(par exemple1
)"2-digit"
(par exemple01
)
timeZoneName
- La représentation du fuseau horaire. Les valeurs possibles sont :
"long"
(par exempleBritish Summer Time
)"short"
(par exempleGMT+1
)
La valeur par défaut de chacun des composants de la date vaut undefined
, si les propriétés weekday
, year
, month
, day
sont toutes undefined
, on suppose alors que year
, month
, et day
sont « numériques ».
Valeur de retour
Une chaîne de caractères qui représente le jour de la date indiquée selon des options de locales.
Exemples
Utiliser toLocaleDateString()
Voici un usage simple qui ne définit pas de locale : une chaine de caractères dans une locale et avec des options par défaut est renvoyée.
var date = new Date(Date.UTC(2012, 11, 12, 3, 0, 0)); // toLocaleDateString() sans argument, on utilise donc // les valeurs par défaut (de l'implémentation) // pour la locale, et le fuseau horaire date.toLocaleDateString(); // → "12/12/2012" si exécuté dans une locale fr et le fuseau horaire CEST
Vérifier le support des arguments locales
et options
Les arguments locales
et options
ne sont pas encore supportés par tous les navigateurs. Afin de vérifier si l'implementation utilisée les supporte, vous pouvez utiliser le pré-requis suivant : les locales incorrectes sont rejetées avec une exception RangeError
:
function toLocaleDateStringSupportsLocales() { try { new Date().toLocaleDateString("i"); } catch (e) { return e.name === "RangeError"; } return false; }
Utiliser l'argument locales
Cet exemple montre quelques variations dues aux formats de dates localisés. Afin d'obtenir le langage utilisé au sein de l'interface utilisateur de votre application, vérifiez de bien fournir ce langage (et éventuellement des locales de recours) en utilisant l'argument locales
:
var date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// les formats qui suivent se basent sur le
// fuseau horaire CEST
// l'anglais américain utilise l'ordre mois-jour-année
alert(date.toLocaleDateString("en-US"));
// → "12/20/2012"
// l'anglais britannique utilise l'ordre jour-mois-année
alert(date.toLocaleDateString("en-GB"));
// → "20/12/2012"
// le coréen utilise l'ordre année-mois-jour
alert(date.toLocaleDateString("ko-KR"));
// → "2012. 12. 20."
// l'arabe, dans la plupart des pays arabophones, utilise les chiffres arabes
alert(date.toLocaleDateString("ar-EG"));
// → "٢٠/١٢/٢٠١٢"
// en ce qui concerne le japonais, les applications peuvent
// souhaiter utiliser le calendrier japonais
// pour lequel 2012 était l'année 24 de l'ère Heisei
alert(date.toLocaleDateString("ja-JP-u-ca-japanese"));
// → "24/12/20"
// quand un langage non support est demandé (ex : le balinais)
// il est possible de fournir un langage de recours (ici l'indonésien)
alert(date.toLocaleDateString(["ban", "id"]));
// → "20/12/2012"
Utiliser l'argument options
Les résultats fournis par toLocaleDateString()
peuvent être personnalisés grâce à l'argument options
:
var date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0)); // fournir le jour de la semaine avec une date longe var options = {weekday: "long", year: "numeric", month: "long", day: "numeric"}; alert(date.toLocaleDateString("de-DE", options)); // → "Donnerstag, 20. Dezember 2012" // une application peut vouloir utiliser // UTC et l'afficher options.timeZone = "UTC"; options.timeZoneName = "short"; alert(date.toLocaleDateString("en-US", options)); // → "Thursday, December 20, 2012, GMT"
Performance
Lorsque des grands nombres ou de grandes dates sont formatés, il est préférable de créer un objet Intl.DateTimeFormat
et d'utiliser la fonction fournie par sa propriété format
.
Spécifications
Spécification | État | Commentaires |
---|---|---|
ECMAScript 3rd Edition (ECMA-262) | Standard | Définition initiale. Implémentée avec JavaScript 1.0. |
ECMAScript 5.1 (ECMA-262) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Standard | |
ECMAScript 2015 (6th Edition, ECMA-262) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Standard | |
ECMAScript Latest Draft (ECMA-262) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Projet | |
ECMAScript Internationalization API 1.0 (ECMA-402) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Standard | Définition des arguments locales et options . |
ECMAScript Internationalization API 2.0 (ECMA-402) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Standard | |
ECMAScript Internationalization API 4.0 (ECMA-402) La définition de 'Date.prototype.toLocaleDateString' dans cette spécification. |
Projet |
Compatibilité des navigateurs
Le tableau de compatibilité de cette page a été généré à partir de données structurées. Si vous souhaitez contribuer à ces données, n'hésitez pas à envoyer une pull request sur https://github.com/mdn/browser-compat-data.
Ordinateur | Mobile | Serveur | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
toLocaleDateString | Chrome Support complet 1 | Edge Support complet 12 | Firefox Support complet 1 | IE Support complet 5.5 | Opera Support complet Oui | Safari Support complet Oui | WebView Android Support complet 1 | Chrome Android Support complet 18 | Firefox Android Support complet 4 | Opera Android Support complet Oui | Safari iOS Support complet Oui | Samsung Internet Android Support complet 1.0 | nodejs Support complet Oui |
IANA time zone names in timeZone option | Chrome Support complet 24 | Edge Support complet 14 | Firefox Support complet 52 | IE Aucun support Non | Opera Support complet 15 | Safari ? | WebView Android Support complet 37 | Chrome Android Support complet 25 | Firefox Android Aucun support Non | Opera Android ? | Safari iOS ? | Samsung Internet Android Support complet 1.5 | nodejs Support complet Oui |
locales | Chrome Support complet 24 | Edge Support complet 12 | Firefox Support complet 29 | IE Support complet 11 | Opera Support complet 15 | Safari Support complet 10 | WebView Android Aucun support Non | Chrome Android Support complet 26 | Firefox Android Support complet 56 | Opera Android Aucun support Non | Safari iOS Support complet 10 | Samsung Internet Android Support complet 1.5 | nodejs
Support complet
0.12
|
options | Chrome Support complet 24 | Edge Support complet 12 | Firefox Support complet 29 | IE Support complet 11 | Opera Support complet 15 | Safari Support complet 10 | WebView Android Aucun support Non | Chrome Android Support complet 26 | Firefox Android Support complet 56 | Opera Android Aucun support Non | Safari iOS Support complet 10 | Samsung Internet Android Support complet 1.5 | nodejs Support complet Oui |
Légende
- Support complet
- Support complet
- Aucun support
- Aucun support
- Compatibilité inconnue
- Compatibilité inconnue
- Voir les notes d'implémentation.
- Voir les notes d'implémentation.