CompositionEvent: locale property

{{deprecated_header}}{{APIRef("UI Events")}}{{Non-standard_header}}

The locale read-only property of the {{domxref("CompositionEvent")}} interface returns the locale of current input method (for example, the keyboard layout locale if the composition is associated with an {{glossary("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 {{domxref("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 {{domxref("CompositionEvent")}} is not well defined.

Browser compatibility

{{Compat}}

See also

• {{domxref("CompositionEvent")}}