javascript
  1. javascript-localecompare
PreviousNext

JavaScript localeCompare()

The localeCompare() method in JavaScript compares two strings and returns a value indicating whether one string comes before, after, or is the same in order as the other string, based on the language settings of the user. This method is useful when sorting strings in different languages.

Syntax

string.localeCompare(compareString[, locales[, options]])
  • compareString: The string to compare with the base string.
  • locales: Optional. A string or an array of strings representing the locales to use for the comparison. If not specified, the default locale of the user is used.
  • options: Optional. An object containing additional options for the comparison, such as sensitivity, usage, and numeric.

Example

const str1 = "apple";
const str2 = "banana";

console.log(str1.localeCompare(str2));
// output: -1 (str1 comes before str2 in alphabetical order)

Output

The output of localeCompare() method is an integer that indicates the order of the string comparison. The return value can be one of these three possible values:

  • -1: The base string is sorted before the compare string.
  • 0: The base string and compare string are equivalent.
  • 1: The base string is sorted after the compare string.

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>JavaScript Output</title>
</head>
<body>

<!-- Your JavaScript code goes here -->
<script>
  const str1 = "apple";
  const str2 = "banana";

  // Using localeCompare method to compare the two strings
  let comparisonResult = str1.localeCompare(str2);

  // Displaying the result in the HTML document
  document.write('<p>' + comparisonResult + '</p>');
</script>

</body>
</html>
Try Playground

Explanation

The localeCompare() method compares two strings character by character, using the rules of the user's locale. It takes into account differences in character accents, case, and other regional characteristics. By default, the comparison is case-sensitive and accent-sensitive. For example, in most European languages, "ä" is considered a distinct letter and is sorted after "z".

Use

The localeCompare() method is commonly used for sorting strings in different languages. It is useful when building multilingual applications or when dealing with user-generated content. This method can also be used for string equality comparisons, case-insensitive searches, and other text-manipulation operations that depend on the language settings of the user.

Important Points

Here are some important points to keep in mind when using the localeCompare() method:

  • The localeCompare() method is supported in all major browsers.
  • The locales parameter accepts a string or an array of strings representing the locales to use. If an array of strings is provided, the method uses the first valid locale that it finds.
  • The options parameter allows for additional customization of the comparison, such as sensitivity to case and accents, and numeric sorting.
  • The method performs a character-by-character comparison, so it may not be suitable for comparing strings of significantly different lengths.
  • If the two strings have the same length but contain different characters, the comparison is based on the Unicode values of the characters.

Summary

The localeCompare() method in JavaScript is a powerful tool for sorting and comparing strings based on the language settings of the user. It compares two strings and returns an integer indicating their relative order in alphabetical or numerical sorting. With the ability to customize the comparison through the locales and options parameters, this method is a versatile and widely used feature in modern web development.

toLocaleUpperCase()padStart()
Published on: