RichTextInputArea

Components/Form

Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/richtextinputarea

Overview

Copy

Rich text input areas let users insert and format long sections of text, and add lists and links.

Do

  • Let users add multiple sentences or paragraphs.
  • Let users format the text they write.

Don't

  • Don't use for text inputs that are a single line. Use <Input/> instead.

Feature examples

Height

Control the height of the text area (excluding the toolbar):

  • minHeight sets a minimum height in pixels.
  • maxHeight sets a maximum height in pixels. Once the maximum height is reached, an inner scroll appears.

If undefined, the text area height is dynamic and grows or shrinks based on the user input.

Copy

Status

Control this component's status by using a status prop.

  • error demonstrates that required input is missing something or the entry was invalid.
  • warning highlights an input value that might have a significant impact to a user.
  • loading shows that text is being saved.
Copy

Status message

Add text that explains the status or what action the user should take with the statusMessage prop.

Showing the status message inline, directly below the input area is preferred in all default cases.

  • To add an accessible inline message, wrap the component in a <FormField/> and add the statusMessage.
  • To add a status message in a tooltip that requires users to hover on the icon, use the statusMessage prop.

View more inline status message examples in <FormField/>.

Copy

Text format

This component supports the following formatting:

  • Bold
  • Italic
  • Underline
  • Link
  • Bullet list
  • Numbered list
Copy

Custom button labels

Customize the label for each of the formatting buttons by using a toolbarButtons prop.

Copy

Spell check

Enable standard browser spell check functionality with the spellCheck prop. This doesn't work on the IE browsers.

Copy

Disabled

You can disable the whole RichTextInputArea with disabled property

Copy

Common use case examples

Form

The rich text input area is often used when there are multiple paragraphs of text.

When content is longer than a sentence or two, text formatting greatly improves readability and allows people to scan easily.

Copy

Code

Copy

Props

NameTypeDefaultDescription
backgroundColorstring—Sets the background color of the editor. Accepts any CSS color value.
convertersRichTextInputAreaConverters—Extends how HTML is turned into editor content and back, so that markup the editor has no model for survives editing. Also applied to pasted HTML.
customButtons{ tooltipText?: string | undefined; icon?: ReactNode; onClick?: (() => void) | undefined; disabled?: boolean | undefined; active?: boolean | undefined; dataHook?: string | undefined; }[]—An array of custom toolbar button configs to append after the built-in buttons.
dataHookstring—Applies a data-hook HTML attribute that can be used in the tests.
disabledbooleanfalseWhether this specific button is disabled (toolbar-level disabled also applies)
hiddenActionsRichTextInputAreaAction[]—Sets which built-in toolbar actions to turn off, so that their buttons aren't rendered. Existing formatting in initialValue or in pasted content isn't affected.
initialValuestring'<p/>'Sets the initial value to be displayed in the editor. Read once, when the component mounts. To replace the value later, such as after an edit made elsewhere, hold a ref and call setValue.
maxHeightstring—Defines a maximum height for the editor (it grows by default)
minHeightstring—Defines a minimum height for the editor (it grows by default)
onChange(htmlText: string, params: { plainText: string; }) => void—Defines a standard callback function for changes: onChange(htmlText, { plainText })
onLinkRequest(currentLink: RichTextInputAreaLinkData | undefined, selection: { selectedText: string; }) => RichTextInputAreaLinkData | Promise<...> | null | undefined—Replaces the built-in link form with a flow of your own, such as a link picker panel. Receives the link at the selection, if there is one, and the text the selection covers — the same text the built-in form offers for editing. Resolve with link data to apply it — over the whole of a link the selection touches, over the selected text, or as text written at a caret — with null to detach, or with undefined to leave the content untouched. The data replaces the link's rather than adding to it.
placeholderstring—Sets a placeholder message to display.
size"small" | "large"'large'Sets the size of the toolbar icons.
spellCheckboolean—Enables browsers spell checking. Doesn't affect IE. In Safari, autocorrects by default.
status"error" | "warning" | "loading"—Specifies the status of a field.
statusMessageReactNode—Defines the message to display on status icon hover. If not given or empty, no tooltip is displayed.
textstexts—Defines text styles to be shown.

Testkit

No testkit for this component — it doesn't expose a unidriver testkit.

Changelog

  • 1.340.0 (2026-10-21) — maintenance release, no component-specific changes
  • 1.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.335.0 (2026-10-12) — maintenance release, no component-specific changes
  • 1.331.0 (2026-10-01) — maintenance release, no component-specific changes
  • 1.330.3 (2026-09-29) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.329.0 (2026-09-24) — maintenance release, no component-specific changes
  • 1.328.0 (2026-09-22) — maintenance release, no component-specific changes
  • 1.326.0 (2026-09-17) — fix: release the minimum width in a narrow container (#17088) — has visual changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.324.0 (2026-09-14) — maintenance release, no component-specific changes
  • 1.323.0 (2026-09-10) — maintenance release, no component-specific changes
  • 1.312.0 (2026-08-14) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.309.0 (2026-08-06) — feat: a new hiddenActions prop turns off built-in toolbar buttons — 'bold', 'italic', 'underline', 'link', 'bulletedList' and 'numberedList'. Formatting already present in initialValue or in pasted content is kept. (#16743) — has visual changes
  • 1.300.0 (2026-07-20) — feat: add size prop (#16573) — has visual changes
  • 1.295.0 (2026-07-03) — maintenance release, no component-specific changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.291.0 (2026-06-19) — maintenance release, no component-specific changes
  • 1.282.0 (2026-05-27) — fix: insert link popover behind modal (#16300) — has visual changes
  • 1.279.0 (2026-05-13) — maintenance release, no component-specific changes
  • 1.273.0 (2026-04-30) — maintenance release, no component-specific changes
  • 1.271.0 (2026-04-22) — maintenance release, no component-specific changes
  • 1.270.0 (2026-04-20) — fix: made more mobile friendly (#16158)
  • 1.266.0 (2026-04-07) — maintenance release, no component-specific changes
  • 1.261.0 (2026-03-24) — maintenance release, no component-specific changes
  • 1.260.0 (2026-03-17) — maintenance release, no component-specific changes
  • 1.258.0 (2026-02-23) — feat: allow to pass custom buttons to the toolbar (#15949)
  • 1.250.0 (2026-01-27) — fix: added focus box shadow (#15865)
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.241.0 (2025-12-17) — maintenance release, no component-specific changes
  • 1.220.0 (2025-09-29) — maintenance release, no component-specific changes
  • 1.212.0 (2025-08-11) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.129.0 (2024-09-25) — maintenance release, no component-specific changes
  • 1.127.0 (2024-09-12) — fix: do not prepend communication links with http (#14122)
  • 1.116.0 (2024-07-22) — feat: add focus/blur public API (#13971)
  • 1.115.0 (2024-07-17) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.93.0 (2024-02-08) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 22 October 2026

Did this help?