JavaScript String localeCompare() Method

## JavaScript Reference

Overview

## JavaScript Objects

JS Array JS Boolean JS Date JS Math JS Number JS String JS RegExp JS Global

## Browser Objects

Window Navigator Screen History Location

## HTML DOM Objects

DOM Document DOM Elements DOM Attributes DOM Events

## HTML Objects

DOM Anchor DOM Area DOM Base DOM Body DOM Button DOM Form DOM Frame/IFrame DOM Frameset DOM Image DOM Input Button DOM Input Checkbox DOM Input File DOM Input Hidden DOM Input Password DOM Input Radio DOM Input Reset DOM Input Submit DOM Input Text DOM Link DOM Meta DOM Object DOM Option DOM Select DOM Style DOM Table DOM td / th DOM tr DOM Textarea

# JavaScript String localeCompare() Method

JavaScript String Object

## 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 »

## 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

The localeCompare() method is supported in all major browsers.

## Syntax

string.localeCompare(compareString)

## Parameter Values

Parameter | Description
--- | ---
compareString | Required. The string to compare with

## Return Value

Type | Description
--- | ---

Number

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

## Technical Details

JavaScript Version: | 1.2

## 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 Object

## Your suggestion:

Your E-mail (optional):

Page address:

Description:

Close [X]

## Thank You For Helping Us!

Your message has been sent to W3Schools.

Close [X]
Search w3schools.com:

## WEB HOSTING

Best Web Hosting UK Reseller Hosting Wow! $5 SSD Hosting

## WEB BUILDING

Download XML Editor
FREE Website BUILDER FREE Website Creator

## WEB RESOURCES

Web Statistics Web Validation

## SHARE THIS PAGE