X
HOME HTML5 CSS3 JAVASCRIPT SQL PHP5 JQUERY ANGULAR BOOTSTRAP3 XML MORE...
REFERENCES | EXAMPLES | FORUM | ABOUT

JavaScript String localeCompare() Method

JavaScript String Reference JavaScript String Reference

Example

Compare two strings in the current locale:

var str1 = "ab";
var str2 = "cd";
var n = str1.localeCompare(str2);

The result of n will be:

-1 // str1 is sorted before str2

Try it yourself »

More "Try it Yourself" examples below.


Definition and Usage

The localeCompare() method compares two strings in the current locale.

The locale is based on the language settings of the browser.

The localeCompare() method returns a number indicating whether the string comes before, after or is equal as the compareString in sort order.


Browser Support

Method
localeCompare() Yes Yes Yes Yes Yes


Syntax

string.localeCompare(compareString)

Parameter Values

Parameter Description
compareString Required. The string to compare with

Technical Details

Return Value: A Number, indicating whether the reference string comes before, after or is the same as the compareString in sort order. Returns one of three values:
  • -1 if the reference string is sorted before the compareString
  • 0 if the two strings are equal
  • 1 if the reference string is sorted after the compareString
JavaScript Version: 1.2


Examples

More Examples

Example

Compare two strings in the current locale:

var str1 = "cd";
var str2 = "ab";
var n = str1.localeCompare(str2);

The result of n will be:

1 // str1 is sorted after str2

Try it yourself »

Example

Compare two equal strings in the current locale:

var str1 = "ab";
var str2 = "ab";
var n = str1.localeCompare(str2);

The result of n will be:

0 // the two strings are equal

Try it yourself »


JavaScript String Reference JavaScript String Reference

Your suggestion:

Close [X]

Thank You For Helping Us!

Your message has been sent to W3Schools.

Close [X]
Search w3schools.com:

WEB HOSTING

UK Reseller Hosting

WEB BUILDING

Download XML Editor FREE Website BUILDER Free HTML5 Templates

SHARE THIS PAGE

facebook