CompositionEvent: locale property

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The locale read-only property of the CompositionEvent interface returns the locale of current input method (for example, the keyboard layout locale if the composition is associated with an Input method editor).

Warning: Even for browsers supporting it, don't trust the value contained in this property. Even if technically it is accessible, the way to set it up when creating a CompositionEvent is not guaranteed to be coherent.

Value

A string representing the locale of current input method.

Specifications

This property was in early versions of different specifications. It is now only kept for compatibility purposes, and the way to set its value when creating a CompositionEvent is not well defined.

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
locale
Deprecated Non-standard
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge 12 – 18 (Release date: 2015-07-29)
footnote Removed in 79 and later
Firefox – No support
Firefox 9 – 142 (Release date: 2011-12-20)
footnote Removed in 143 and later
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Chrome Android – No support
Chrome Android
footnote No support
Firefox for Android – No support
Firefox for Android 9 – 142 (Release date: 2011-12-21)
footnote Removed in 143 and later
Opera Android – No support
Opera Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – No support
Samsung Internet
footnote No support
WebView Android – No support
WebView Android
footnote No support
WebView on iOS – No support
WebView on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Non-standard. Check cross-browser support before using.
Deprecated. Not for use in new websites.

See also