1.3 KiB
1.3 KiB
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
# 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 | Parameters | Description |
|---|---|---|
| orderedList | — | Toggle a ordered list. |
Keyboard shortcuts
ControlShift9
Source code
packages/extension-ordered-list/