JavaScript toLocaleString()

The JavaScript toLocaleString() method is used to get the complete date using locale conventions. For example:

HTML with JavaScript Code

<!DOCTYPE html>
<html>
<body>
   
   <p id="xyz"></p>

   <script>
      const d = new Date();
      let dateLocale = d.toLocaleString();
      document.getElementById("xyz").innerHTML = dateLocale;
   </script>

</body>
</html>

Output

JavaScript toLocaleString() syntax

The syntax of the toLocaleString() method in JavaScript is:

x.toLocaleString(locales, options)

where x must be an object of the Date() constructor.

Please note: The locales and the options are both optional.

The locales parameter indicates a language-specific format. This parameter is used to print the local date in the specified language. For example:

HTML with JavaScript Code

<!DOCTYPE html>
<html>
<body>
   
   <p>Locale Date in "ar-SA" (Arabic) Format: <span id="a"></span></p>
   <p>Locale Date in "en-CA" (Canadian English) Format: <span id="b"></span></p>
   <p>Locale Date in "en-US" (US English) Format: <span id="c"></span></p>

   <script>
      const d = new Date();
      document.getElementById("a").innerHTML = d.toLocaleString("ar-SA");
      document.getElementById("b").innerHTML = d.toLocaleString("en-CA");
      document.getElementById("c").innerHTML = d.toLocaleString("en-US");
   </script>

</body>
</html>

Output

Locale Date in "ar-SA" (Arabic) Format:

Locale Date in "en-CA" (Canadian English) Format:

Locale Date in "en-US" (US English) Format:

I have only used the three locales to make you aware of how things work.

The options parameter is used when we need to set properties. For example:

HTML with JavaScript Code

<!DOCTYPE html>
<html>
<body>
   
   <p>Locale Date: <span id="a"></span></p>
   <p>UTC Date: <span id="b"></span></p>

   <script>
      const d = new Date();
      document.getElementById("a").innerHTML = d.toLocaleString("en-US");
      document.getElementById("b").innerHTML = d.toLocaleString("en-US", {timeZone: 'UTC'});
   </script>

</body>
</html>

Output

Locale Date:

UTC Date:

Please note: To get only the date portion, use toLocaleDateString(), and to get only the time portion, use toLocaleTimeString().

Please note: To display the date in the format dd-mm-yyyy, refer to its separate example.

Please note: To display time in the format hh:mm:ss, refer to its separate example.

Please note: To display time in the format hh:mm:ss AM/PM, refer to its separate example.

JavaScript Online Test

« Previous Tutorial Next Tutorial »

Liked this post? Share it!