Skip to main content
Apply background colors to emphasize important text. Color-coded highlighting for review, categorization, and emphasis.

ā€‹
OOXML Structure

<w:r>
  <w:rPr>
    <w:highlight w:val="yellow"/>
  </w:rPr>
  <w:t>Highlighted text</w:t>
</w:r>

ā€‹
Use Case

  • Document review - Color-code feedback
  • Study notes - Highlight key concepts
  • Status tracking - Visual progress indicators
  • Multi-reviewer - Each person uses different color
  • Categorization - Group related content by color

ā€‹
Options

Configure the extension behavior:
ā€‹
htmlAttributes
Object
default:"{}"
HTML attributes for highlight elements

ā€‹
Attributes

Node attributes that can be set and retrieved:
ā€‹
color
string
Background color (CSS color value)

ā€‹
Commands

ā€‹
setHighlight

Apply highlight with specified color Example: 
editor.commands.setHighlight('#FFEB3B')
editor.commands.setHighlight('rgba(255, 235, 59, 0.5)')
Parameters:
ā€‹
color
string
required
CSS color value

ā€‹
unsetHighlight

Remove highlight formatting Example: 
editor.commands.unsetHighlight()

ā€‹
toggleHighlight

Toggle highlight formatting Example: 
editor.commands.toggleHighlight()

ā€‹
Keyboard Shortcuts

CommandShortcutDescription
toggleHighlight()āŒ˜/Ctrl-Shift-hToggle highlighted formatting

ā€‹
Source Code