tiptap/docs/src/docPages/api/extensions/ordered-list.md

OrderedList

This extension enables you to use ordered lists in the editor. They are rendered as <ol> HTML tags,

Type 1.  (or any other number followed by a dot) at the beginning of a new line and it will magically transform to a ordered list.

Installation

::: warning Use with ListItem The OrderedList extension is intended to be used with the ListItem extension. Make sure to import that one too, otherwise you’ll get a SyntaxError. :::

# With npm
npm install @tiptap/extension-ordered-list @tiptap/extension-list-item

# Or: With Yarn
yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item

Settings

Option	Type	Default	Description
class	string	–	Add a custom class to the rendered HTML tag.

Commands

Command	Options	Description
ordered_list	—	Toggle a ordered list.

Keyboard shortcuts

• Control Shift 9

Source code

packages/extension-ordered-list/

Usage