Skip to main content
Organize content with clean, structured bullet points. Type - , * , or + to start a list automatically. Create nested lists with Tab/Shift+Tab. Lists preserve perfectly through Word import/export.

OOXML Structure

<w:p>
  <w:pPr>
    <w:pStyle w:val="ListParagraph"/>
    <w:numPr>
      <w:ilvl w:val="0"/>
      <w:numId w:val="1"/>
    </w:numPr>
  </w:pPr>
  <w:r>
    <w:t>List item text</w:t>
  </w:r>
</w:p>

Use Case

  • Action items - Track tasks and responsibilities
  • Feature lists - Showcase product capabilities
  • Key points - Summarize important information
  • Requirements - Document specifications clearly

Options

Configure the extension behavior:
itemTypeName
string
default:"listItem"
Name of the list item node type
htmlAttributes
Object
HTML attributes for the ul element
keepAttributes
boolean
default:"false"
Whether to preserve attributes when splitting
keepMarks
boolean
default:"true"
Whether to preserve marks when splitting
Example:
const ConfiguredBulletList = BulletList.configure({
  itemTypeName: 'customItem',
  keepMarks: false
});

new SuperDoc({
  selector: '#editor',
  document: 'document.docx',
  editorExtensions: [ConfiguredBulletList]
});

Attributes

Node attributes that can be set and retrieved:
list-style-type
string
default:"bullet"
List style type for this list

Commands

toggleBulletList

Toggle a bullet list at the current selection
Converts selected paragraphs to list items or removes list formatting
Example:
// Toggle bullet list on selected text
editor.commands.toggleBulletList()

Keyboard Shortcuts

CommandShortcutDescription
toggleBulletList()⌘/Ctrl-Shift-8Toggle bullet list

Source Code

I