Skip to main content
Version: v11.6.0

Select Locale


Localization refers to the tools, techniques, and steps taken to enable your application to run in other languages. WaveMaker allows you to create a  dictionary of localized messages so that users can change the language of the application to experience the application in their language.

There are three ways that Localization comes into effect:

  1. WaveMaker automatically detects the user's preferred locales (from the browser) and renders the application with the locale of the user's preference if the application supports. If not, displays the application in the default language configured in application settings.
  2. The user can be given a choice to select the language using the Select Locale widget.
  3. You can also choose to trigger the language switch through user events like button click from JavaScript, the following snippet changes language to English:
App.changeLocale({'datavalue': 'en'})

Properties

PropertyDescription
NameThe name is a unique identifier for Select Locale widget.
PlaceholderA placeholder is text to show in the editor when there is no value. A common use of this is a search box that says in faint gray italicized text "Search..." which disappears as soon as the user starts to edit the text box. This is a useful alternative to a caption if you are constrained in space and asking for something simple of the user.
Accessibility
HintAny text or an HTML you enter for this property will be shown as a tooltip if the mouse hovers over this widget for 1.5 seconds.
Tab indexThe tab index attribute specifies the tab order of an element. You can use this property to change the default tabbing order for widget access using the tab key. The value can range from 0 to 32767. The default is 0 and -1 makes the element non-focusable. NOTE: In Safari browsers, by default, Tab highlights only text fields. To enable Tab functionality, in Safari Browser from Preferences -> Advanced -> Accessibility set the option "Press Tab to highlight each item on a webpage".
Shortcut keyThe shortcut key property specifies a shortcut key to activate/focus an element. (*See below for details)
Layout
WidthThe width of your widget can be specified in px or % (i.e 50px, 75%).
HeightThe height of your widget can be specified in px or % (i.e 50px, 75%).
Default Value
ValueThis is the default value to display value for an editor widget. Note that the display value is just what the user sees initially, and is not always the dataValue returned by the widget.
Dataset
ValueSet this property to a variable to populate the list of values to display. By default, it is bound to the supportedLocale variable which gets created when Localization is enabled.
Data fieldThis property sets the dataValue to be returned by a select editor when the list is populated using the dataSet property.
Display fieldThis property sets the displayValue to show in the select editor when the list is populated using the dataSet property.
Display ExpressionThis is an advanced property that gives more control over what is displayed in the drop-down select list. A Display Expression uses a Javascript expression to format exactly what is shown.
Order byThis allows for multiple selections for ordering the display of rows based on fields in asc or desc order - up arrow for asc and down arrow for desc
Validation
RequiredA required editor in wm.LiveForm may refuse to save without a required field.
Behavior
Auto FocusThis property makes the element get focused automatically when the page loads.
Read OnlySelecting this checkbox property prevents the user from being able to change the data value of a widget.
MultipleEnable/Disable to switch between Multiple/Single File Upload Widget.
ShowShowing determines whether or not a component is visible. It is a bindable property.
Load on Demand (visible only when show property is bound to a variable)When this property is set and show property is bound, the initialization of the widget will be deferred till the widget becomes visible. This behavior improves the load time. Use this feature with caution, as it has a downside (as we will not be able to interact with the widget through script until the widget is initialized). When show property is not bound the widget will be initialized immediately.
DisabledIf the disabled property is true (checked) the value of the editor cannot change. The widget becomes display-only.

Events

EventDescription
ChangeThis event handler is called each time your element's value changes. By default, it is set to invoke 1. changeAppLocale which would change the language rendered in the application; and 2. reloadApp event which will reload the app to enable rendering. If you do not want the app to reload whenever the locale changes remove the reloadApp event.
On focusThis event handler is called each time your element is focused.
On blurThis event handler is called each time your focus leaves your element.
Mouse Events
On clickThis event handler is called whenever the click event is triggered on a widget.
On mouse enterThis event handler is called whenever the mouse enters the widget.
On mouse leaveThis event handler is called whenever the mouse leaves the widget.
Touch Events
On tapThis event handler is called whenever the tap event is triggered on a widget.
Keyboard Events
On key downThis event handler is called whenever a key is pressed down.
On key pressThis event handler is called whenever a key is pressed.
On key upThis event handler is called whenever a key is released.

Shortcut key: The shortcut key property specifies a shortcut key to click the button. The way of accessing the shortcut key is varying in different browsers:

BrowserShortcut key Trigger
Internet Explorer[Alt] + shortcut key
Chrome[Alt] + shortcut key (Windows/Linux)
[Control][Alt] + shortcut key (MAC)
Firefox[Alt][Shift] + shortcut key (Windows/Linux)
[Control][Alt] + shortcut key (MAC)

See Also

Simple Usage Scenario
Localization of Error Messages