ui:inputPhone | Lightning Components Developer's Guide

A ui:inputPhone component represents an input field for entering a phone number, which is rendered as an HTML input tag of type tel. To render the output from a ui:inputPhone component, use the ui:outputPhone component.

This example shows a phone field, which displays the specified phone number.

1<ui:inputPhone label="Phone" value="415-123-4567" />

The previous example results in the following HTML.

1<div class="uiInput uiInputPhone uiInput--default uiInput--input">
2    <label class="uiLabel-left form-element__label uiLabel">
3        <span>Phone</span>
4    </label>
5    <input class="input" type="tel">
6</div>

This example retrieves the value of a ui:inputPhone component and displays it using ui:outputPhone.

1<aura:component>
2    <ui:inputPhone aura:id="phone" label="Phone Number" class="field" value="415-123-4567" />
3    <ui:button class="btn" label="Submit" press="{!c.setOutput}"/> 
4
5 <div aura:id="msg" class="hide">
6  You entered: <ui:outputPhone aura:id="oPhone" value="" />
7 </div>
8</aura:component>

1({
2   
3    setOutput : function(component, event, helper) {
4    	var cmpMsg = component.find("msg");
5    	$A.util.removeClass(cmpMsg, 'hide');
6       
7        var phone = component.find("phone").get("v.value");
8        var oPhone = component.find("oPhone");
9        oPhone.set("v.value", phone);
10    }
11})

Attributes

Attribute Name	Attribute Type	Description
`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".
`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`	String	The value currently in the input field.

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.