Rich Text Editor

Rich Text Editor

Edit and format text content

What it solves

A Rich Text Editor pattern helps teams create a reliable way to let users create formatted text while keeping the editing surface understandable, accessible, and safe to submit. It is most useful when teams need knowledge-base authoring. Compared with adjacent patterns, this pattern should reduce friction without hiding the state, rules, or recovery paths people need to keep moving.

When to use

• Knowledge-base authoring
• Long-form content creation
• Formatted internal notes and descriptions

When to avoid

• Use a simpler native control when the value is binary, tiny, or fully constrained.
• Avoid custom behavior when a native browser input already solves the main job well.
• Do not add extra formatting or validation if the product does not benefit from it.

Implementation workflow

1. Confirm the pattern matches the problem and constraints before copying the example. 2. Start from the anatomy and examples in references/pattern.md, then choose the smallest viable variation. 3. Apply accessibility, performance, and interaction guardrails before layering visual polish. 4. Use the testing guidance to verify behavior across keyboard, screen reader, responsive, and failure scenarios.

Accessibility guardrails

Keyboard Interaction

• [ ] Verify that rich text editor can be completed using keyboard alone.
• [ ] Keep focus order logical when the pattern opens, updates, or reveals additional UI.
• [ ] Preserve a visible focus state that is still readable at high zoom.

Screen Reader Support

• [ ] Use semantic elements first, then add ARIA only where semantics alone are not enough.
• [ ] Announce state changes such as errors, loading, or completion in the right place and with the right politeness.
• [ ] Connect labels, hints, and status text with aria-describedby or structural headings when useful.

Visual Accessibility

• [ ] Do not rely on color alone to convey severity, completion, or selection state.

Common mistakes

Using the wrong validation moment

The Problem: Immediate validation on partial input makes the pattern feel punitive and noisy.

How to Fix It? Wait until the user has enough information in the field, then validate on blur, pause, or submit depending on the risk of the rule.

Separating labels, hints, and errors

The Problem: People cannot tell which message belongs to which control when the copy is visually detached.

How to Fix It? Keep labels, helper text, and validation messages tightly grouped and connected with aria-describedby where appropriate.

Forgetting touch and autofill behavior

The Problem: Desktop-only styling hides the fact that mobile keyboards, autofill, and paste flows behave differently.

How to Fix It? Test the control with autofill, paste, zoom, and on-screen keyboards before calling the pattern complete.

Related patterns

• https://uxpatterns.dev/patterns/forms/button
• https://uxpatterns.dev/patterns/forms/tag-input
• https://uxpatterns.dev/patterns/forms/textarea

---

For full implementation detail, examples, and testing notes, see references/pattern.md.

Pattern page: https://uxpatterns.dev/patterns/forms/rich-text-editor

Rich Text Editor

Create accessible rich text editors with text formatting tools and keyboard shortcuts.

URL: https://uxpatterns.dev/patterns/forms/rich-text-editor Source: apps/web/content/patterns/forms/rich-text-editor.mdx

---

Overview

A Rich Text Editor pattern helps teams create a reliable way to let users create formatted text while keeping the editing surface understandable, accessible, and safe to submit. It is most useful when teams need knowledge-base authoring.

Compared with adjacent patterns, this pattern should reduce friction without hiding the state, rules, or recovery paths people need to keep moving.

Use Cases

When to use:

• Knowledge-base authoring
• Long-form content creation
• Formatted internal notes and descriptions

When not to use:

• Use a simpler native control when the value is binary, tiny, or fully constrained.
• Avoid custom behavior when a native browser input already solves the main job well.
• Do not add extra formatting or validation if the product does not benefit from it.

Common scenarios and examples

• Knowledge-base authoring where users need a clear, repeatable interface model.
• Long-form content creation where users need a clear, repeatable interface model.
• Formatted internal notes and descriptions where users need a clear, repeatable interface model.

Benefits

• Clarifies how rich text editor should behave before implementation details begin to sprawl.
• Creates a reusable interaction model for teams who need to let users create formatted text while keeping the editing surface understandable, accessible, and safe to submit.
• Makes accessibility, edge cases, and recovery paths part of the design instead of post-launch cleanup.
• Gives product, design, and engineering a shared language for evaluating trade-offs.

Drawbacks

• It introduces more states to design and test than a plain text field.
• Validation timing can feel noisy when the pattern reacts too early.
• Mobile input modes and autofill behavior often need explicit tuning.
• If labels, hints, and errors drift apart, completion rates drop quickly.

Anatomy

flowchart TB
Root[Rich Text Editor] --> A[Toolbar]
Root --> B[Editing surface]
Root --> C[Formatting state]
Root --> D[Content guidance]
Root --> E[Preview or output state]

Component Structure

1. Toolbar

• Groups the formatting and insertion commands.

2. Editing surface

• Holds the formatted content.

3. Formatting state

• Shows which styles are active at the cursor position.

4. Content guidance

• Explains limits, supported features, or sanitization rules.

5. Preview or output state

• Shows how the content will appear after submission.

Summary of Components

Variations

Minimal editor

Supports a narrow set of common text styles.

When to use: Use for comments, notes, and short descriptions.

Document editor

Adds headings, media, and structural blocks.

When to use: Use for long-form content creation.

Structured editor

Restricts output to approved blocks or components.

When to use: Use when brand, schema, or publishing rules matter.

Examples

Live Preview

Basic Implementation

<div class="demo-shell card rte">
  <div class="toolbar">
    <button type="button" data-command="bold"><strong>B</strong></button>
    <button type="button" data-command="italic"><em>I</em></button>
    <button type="button" data-command="insertUnorderedList">• List</button>
  </div>
  <div class="editor" contenteditable="true">Start typing meeting notes here.</div>
  <p class="muted">Formatting is intentionally lightweight in this demo.</p>
</div>

What this example demonstrates

• A clear baseline implementation of rich text editor that can be reviewed without framework-specific noise.
• Visible state, spacing, and content hierarchy that mirror the implementation guidance above.
• A small enough surface to copy into a design review or prototype before scaling the pattern up.

Implementation Notes

• Start with semantic HTML and only add JavaScript where the interaction truly requires it.
• Keep styling tokens and spacing consistent with adjacent controls or layouts.
• If the live implementation introduces async behavior, mirror those states in the code example rather than documenting them only in prose.

Best Practices

Content

Do's ✅

• Lead with a clear label that tells users exactly what belongs in the field.
• Keep helper text short and move edge-case guidance into secondary copy.
• Use examples only when they remove real ambiguity for the person typing.

Don'ts ❌

• Do not rely on placeholder text as the only instruction.
• Do not stack multiple competing messages above and below the control.
• Do not hide required constraints until after submission if they are easy to explain upfront.

Accessibility

Do's ✅

• Verify that rich text editor can be completed using keyboard alone.
• Keep focus order logical when the pattern opens, updates, or reveals additional UI.
• Preserve a visible focus state that is still readable at high zoom.
• Use semantic elements first, then add ARIA only where semantics alone are not enough.
• Announce state changes such as errors, loading, or completion in the right place and with the right politeness.

Don'ts ❌

• Do not remove focus styles without a visible replacement.
• Do not depend on placeholder or helper text that disappears before the user can act on it.
• Do not assume pointer, touch, and assistive technologies will all interact with the pattern the same way.

Visual Design

Do's ✅

• Keep spacing consistent between label, control, helper text, and validation.
• Reserve space for error states so the layout does not jump.
• Use state colors as reinforcement, not as the only cue.

Don'ts ❌

• Do not use tiny hit targets for touch devices.
• Do not depend on subtle borders that disappear in low-contrast environments.
• Do not overload the field chrome with too many icons or badges.

Layout & Positioning

Do's ✅

• Align the control with the rest of the form so users can scan vertically.
• Support narrow mobile widths before adding side-by-side layouts.
• Keep primary actions close enough that users understand which field set they submit.

Don'ts ❌

• Do not move validation messages far from the field that caused them.
• Do not switch label position between breakpoints without a strong reason.
• Do not collapse key guidance into tooltips that are hard to revisit.

Common Mistakes & Anti-Patterns 🚫

Using the wrong validation moment

The Problem: Immediate validation on partial input makes the pattern feel punitive and noisy.

How to Fix It? Wait until the user has enough information in the field, then validate on blur, pause, or submit depending on the risk of the rule.

---

Separating labels, hints, and errors

The Problem: People cannot tell which message belongs to which control when the copy is visually detached.

How to Fix It? Keep labels, helper text, and validation messages tightly grouped and connected with aria-describedby where appropriate.

---

Forgetting touch and autofill behavior

The Problem: Desktop-only styling hides the fact that mobile keyboards, autofill, and paste flows behave differently.

How to Fix It? Test the control with autofill, paste, zoom, and on-screen keyboards before calling the pattern complete.

Accessibility

Keyboard Interaction

• [ ] Verify that rich text editor can be completed using keyboard alone.
• [ ] Keep focus order logical when the pattern opens, updates, or reveals additional UI.
• [ ] Preserve a visible focus state that is still readable at high zoom.

Screen Reader Support

• [ ] Use semantic elements first, then add ARIA only where semantics alone are not enough.
• [ ] Announce state changes such as errors, loading, or completion in the right place and with the right politeness.
• [ ] Connect labels, hints, and status text with aria-describedby or structural headings when useful.

Visual Accessibility

• [ ] Do not rely on color alone to convey severity, completion, or selection state.
• [ ] Test the pattern at 200% zoom and with reduced motion enabled.
• [ ] Ensure touch targets remain comfortable on mobile and coarse pointers.

Validation Rules

What to validate

• Validate the value against the rules users can act on inside rich text editor.
• Check required, format, and boundary constraints separately so messages stay specific.
• Run server-side validation again for any rule that affects security, billing, or data integrity.

When to validate

• Prefer quiet validation while the user is still composing, then stronger validation on blur or submit.
• Avoid showing an error before the user has entered enough characters to satisfy the rule fairly.
• Keep successful states subtle so the field does not become visually noisy.

Error Handling

• Preserve the entered value after an error so people can correct rather than retype.
• Explain the next step in the error copy instead of only naming the rule that failed.
• If a server-side rule fails after submit, return focus to the first affected control and summarize the issue near the action area.

Testing Guidelines

Functional Testing

• [ ] Verify the default, loading, error, and success states for rich text editor.
• [ ] Test the primary action and the obvious recovery action in the same run.
• [ ] Confirm that state survives refresh, navigation, or retry in the way users would expect.

Accessibility Testing

• [ ] Run keyboard-only checks and at least one screen reader pass on the final implementation.
• [ ] Validate headings, labels, and announcement behavior with real content rather than lorem ipsum.
• [ ] Check color contrast and focus visibility in both default and stressed states.

Edge Cases

• [ ] Test empty, long, duplicated, and unexpectedly formatted content.
• [ ] Check behavior on narrow screens, zoomed layouts, and slower networks.
• [ ] Verify that optimistic or asynchronous states reconcile correctly after a failure.

Design Tokens

These design tokens provide a starting point for implementing rich text editor in a systemized UI layer.

{
  "$schema": "https://design-tokens.org/schema.json",
  "richTextEditor": {
    "container": {
      "gap": {
        "value": "0.75rem",
        "type": "dimension"
      }
    },
    "label": {
      "color": {
        "value": "{color.gray.900}",
        "type": "color"
      },
      "fontWeight": {
        "value": "600",
        "type": "number"
      }
    },
    "control": {
      "borderRadius": {
        "value": "0.75rem",
        "type": "dimension"
      },
      "borderColor": {
        "value": "{color.gray.300}",
        "type": "color"
      },
      "paddingInline": {
        "value": "0.875rem",
        "type": "dimension"
      },
      "paddingBlock": {
        "value": "0.75rem",
        "type": "dimension"
      }
    },
    "helperText": {
      "color": {
        "value": "{color.gray.600}",
        "type": "color"
      },
      "fontSize": {
        "value": "0.875rem",
        "type": "dimension"
      }
    },
    "validation": {
      "successColor": {
        "value": "{color.green.700}",
        "type": "color"
      },
      "errorColor": {
        "value": "{color.red.700}",
        "type": "color"
      },
      "warningColor": {
        "value": "{color.amber.700}",
        "type": "color"
      }
    }
  }
}

Frequently Asked Questions

Related Patterns

Resources

References

• WCAG 2.2 - Accessibility baseline for keyboard support, focus management, and readable state changes.
• MDN contenteditable - Editing behavior, focus, selection, and browser considerations for rich text surfaces.

Guides

• MDN WAI-ARIA basics - Guidance on when to rely on native HTML and when to introduce ARIA roles and states.

Articles

• web.dev: Rendering on the Web - Rendering tradeoffs for data-rich pages, dashboards, and result-heavy views.

NPM Packages

• `@tiptap/react` - Extensible rich-text editor framework for structured editing experiences.
• `slate` - Composable editor framework for custom rich-text and block editors.
• `lexical` - Modern editor framework from Meta for extensible rich-text surfaces.