Skip Navigation

Newer Version Available

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

ui:inputRichText

An input field for entering rich text. This component is not supported by LockerService.

We recommend that you use lightning:inputRichText instead of ui:inputRichText. ui:inputRichText is no longer supported when LockerService is activated.

Note

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.
`cols`	Integer	The width of the text area, which is defined by the number of characters to display in a single row at a time. Default value is “20”.
`disabled`	Boolean	Specifies whether the component should be displayed in a disabled state. Default value is "false".
`errors`	List	The list of errors to be displayed.
`height`	String	The height of the editing area (that includes the editor content). This can be an integer, for pixel sizes, or any CSS-defined length unit.
`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 textarea element.
`placeholder`	String	The text that is displayed by default.
`readonly`	Boolean	Specifies whether the text area should be rendered as read-only. Default value is “false”.
`required`	Boolean	Specifies whether the input is required. Default value is "false".
`requiredIndicatorClass`	String	The CSS class of the required indicator component
`resizable`	Boolean	Specifies whether or not the textarea should be resizable. Defaults to true.
`rows`	Integer	The height of the text area, which is defined by the number of rows to display at a time. Default value is “2”.
`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.
`width`	String	The editor UI outer width. This can be an integer, for pixel sizes, or any CSS-defined unit. If isRichText is set to false, use the cols attribute instead.

Events

Event Name	Event Type	Description
`dblclick`	COMPONENT	The event fired when the user double-clicks the component.
`mouseover`	COMPONENT	The event fired when the user moves the mouse pointer over the component.
`mouseout`	COMPONENT	The event fired when the user moves the mouse pointer away from the component.
`mouseup`	COMPONENT	The event fired when the user releases the mouse button over the component.
`mousemove`	COMPONENT	The event fired when the user moves the mouse pointer over the component.
`click`	COMPONENT	The event fired when the user clicks on the component.
`mousedown`	COMPONENT	The event fired when the user clicks a mouse button over the component.
`select`	COMPONENT	The event fired when the user selects some text.
`blur`	COMPONENT	The event fired when the user moves off from the component.
`focus`	COMPONENT	The event fired when the user focuses on the component.
`keypress`	COMPONENT	The event fired when the user presses or holds down a keyboard key on the component.
`keyup`	COMPONENT	The event fired when the user releases a keyboard key on the component.
`keydown`	COMPONENT	The event fired when the user presses a keyboard key on the component.
`cut`	COMPONENT	The event fired when the user cuts content to the clipboard.
`onError`	COMPONENT	The event fired when there are any validation errors on the component.
`onClearErrors`	COMPONENT	The event fired when any validation errors should be cleared.
`change`	COMPONENT	The event fired when the user changes the content of the input.
`copy`	COMPONENT	The event fired when the user copies content to the clipboard.
`paste`	COMPONENT	The event fired when the user pastes content from the clipboard.