Newer Version Available

This content describes an older version of this product. View Latest

ui:inputCurrency

An input field for entering a currency.

A ui:inputCurrency component represents an input field for a number as a currency, which is rendered as an HTML input tag of type text. The browser's locale is used by default. To render the output from a ui:inputCurrency component, use the ui:outputCurrency component.

This is a basic set up of a ui:inputCurrency component, which renders an input field with the value $50.00 when the browser's currency locale is $.

1<ui:inputCurrency label="Amount" class="field" value="50"/>

This example results in the following HTML.

1<div class="uiInput uiInput--default uiInput--input">
2    <label class="uiLabel-left form-element__label uiLabel">
3        <span>Amount</span>
4    </label>
5    <input class="field input" max="99999999999999" step="1" type="text" min="-99999999999999">
6</div>

To override the browser's locale, set the new format on the v.format attribute of the ui:inputCurrency component. This example renders an input field with the value £50.00.

1var curr = component.find("amount");
2curr.set("v.format", '£#,###.00');

This example retrieves the value of a ui:inputCurrency component and displays it using ui:outputCurrency.

1<aura:component>
2    <ui:inputCurrency aura:id="amount" label="Amount" class="field" value="50"/>
3    <ui:button class="btn" label="Submit" press="{!c.setOutput}"/> 
4
5 <div aura:id="msg" class="hide">
6  You entered: <ui:outputCurrency aura:id="oCurrency" value=""/>
7 </div>
8</aura:component>
1({
2	 setOutput : function(component, event, helper) {
3		var cmpMsg = component.find("msg");
4	    $A.util.removeClass(cmpMsg, 'hide');
5	    	
6        var amount = component.find("amount").get("v.value");
7        var oCurrency = component.find("oCurrency");
8        oCurrency.set("v.value", amount);
9	 }
10})

Attributes

Attribute Name Attribute Type Description Required?
body Component[] The body of the component. In markup, this is everything in the body of the tag.
class String A CSS style to be attached to the component. This style is added in addition to base styles output by the component.
disabled Boolean Specifies whether the component should be displayed in a disabled state. Default value is "false".
format String The format of the number. For example, format=“.00” displays the number followed by two decimal places. If not specified, the Locale default format will be used.
label String The text of the label component
labelClass String The CSS class of the label component
maxlength Integer The maximum number of characters that can be typed into the input field. Corresponds to the maxlength attribute of the rendered HTML input element.
placeholder String Text that is displayed when the field is empty, to prompt the user for a valid entry.
required Boolean Specifies whether the input is required. Default value is "false".
requiredIndicatorClass String The CSS class of the required indicator component
size Integer The width of the input field, in characters. Corresponds to the size attribute of the rendered HTML input element.
updateOn String Updates the component's value binding if the updateOn attribute is set to the handled event. Default value is "change".
value BigDecimal The input value of the number.

Events

Event Name Event Type Description
dblclick COMPONENT Indicates that a component has been double-clicked.
mouseover COMPONENT Indicates that the user has moved the mouse pointer over the component.
mouseout COMPONENT Indicates that the user has moved the mouse pointer away from the component.
mouseup COMPONENT Indicates that the user has released the mouse button.
mousemove COMPONENT Indicates that the user has moved the mouse pointer.
click COMPONENT Indicates that a component has been clicked.
mousedown COMPONENT Indicates that the user has pressed a mouse key.
select COMPONENT Indicates that the user has made a selection.
blur COMPONENT Indicates that a component has been put out of focus.
focus COMPONENT Indicates that a component has been put on focus.
keypress COMPONENT Indicates that the user has pressed and held down a keyboard key.
keyup COMPONENT Indicates that the user has released a keyboard key.
keydown COMPONENT Indicates that the user has pressed and released a keyboard key.
cut COMPONENT Indicates that the user has cut content to the clipboard.
validationError COMPONENT Indicates that the component has validation error(s).
clearErrors COMPONENT Indicates that any validation error should be cleared.
change COMPONENT Indicates that the content of a component or the state has changed.
copy COMPONENT Indicates that the user has copied content to the clipboard.
paste COMPONENT Indicates that the user has pasted content from the clipboard.