ui:inputText | Lightning Components Developer’s Guide

A ui:inputText component represents a text input field, which is rendered as an HTML input tag of type text. To render the output from a ui:inputText component, use the ui:outputText component.

This is a basic set up of a text field.

1<ui:inputText label="Expense Name" value="My Expense" required="true"/>

This example results in the following HTML.

1<div class="uiInput uiInputText">
2  <label class="uiLabel-left uiLabel">
3    <span>Expense Name</span>
4    <span class="required">*</span>
5  </label>
6  <input required="required" class="uiInput uiInputText" type="text">
7</div>

This example retrieves the value of a ui:inputText component and displays it using ui:outputText.

1<aura:component>
2 <ui:inputText aura:id="name" label="Enter some text" class="field" value="My Text"/>
3    <ui:button class="btn" label="Submit" press="{!c.setOutput}"/> 
4
5 <div aura:id="msg" class="hide">
6  You entered: <ui:outputText aura:id="oName" value=""/> 
7 </div>
8</aura:component>

1swfobject.registerObject("clippy.codeblock-3", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17({
18	 setOutput : function(component, event, helper) {
19		var el = component.find("msg");
20	    $A.util.removeClass(el.getElement(), 'hide');
21	    
22        var name = component.find("name").get("v.value");
23        var oName = component.find("oName");
24        oName.set("v.value", name); 
25	 }
26})

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