Input Rich Text (Deprecated)

ui:inputRichText

Deprecated as of API version 47.0. We recommend migrating to Lightning Web Components and using the lightning-input-rich-text component.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App

Deprecation Guidelines 

This component is not supported by Lightning Locker. We recommend using Lightning Web Components whenever possible. When migrating to Lightning Web Components, use lightning-input-rich-text.

For more information, see Aura Components in the ui Namespace Are Deprecated.

Attributes 

NameDescriptionTypeDefaultRequired
bodyThe body of the component. In markup, this is everything in the body of the tag.Aura.Component[]
classA CSS style to be attached to the component. This style is added in addition to base styles output by the component.String
colsThe 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”.Integer20
disabledSpecifies whether the component should be displayed in a disabled state. Default value is "false".Booleanfalse
errorsThe list of errors to be displayed.Object[]
heightThe height of the editing area (that includes the editor content). This can be an integer, for pixel sizes, or any CSS-defined length unit.String200
labelThe text of the label componentString
labelClassThe CSS class of the label componentString
maxlengthThe maximum number of characters that can be typed into the input field. Corresponds to the maxlength attribute of the rendered HTML textarea element.Integer
placeholderThe text that is displayed by default.String
readonlySpecifies whether the text area should be rendered as read-only. Default value is “false”.Booleanfalse
requiredSpecifies whether the input is required. Default value is "false".Booleanfalse
requiredIndicatorClassThe CSS class of the required indicator componentString
resizableSpecifies whether or not the textarea should be resizable. Defaults to true.Booleantrue
rowsThe height of the text area, which is defined by the number of rows to display at a time. Default value is “2”.Integer2
updateOnUpdates the component's value binding if the updateOn attribute is set to the handled event. Default value is "change".Stringchange
valueThe value currently in the input field.String
widthThe 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.String