mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-26 02:37:49 +08:00
1.7 KiB
1.7 KiB
| description | icon |
|---|---|
| If a bullet list doesn’t look serious enough, put some numbers in front of it. | list-ordered |
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
npm install @tiptap/extension-ordered-list @tiptap/extension-list-item
This extension requires the ListItem node.
Settings
HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
OrderedList.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
itemTypeName
Specify the list item name.
Default: 'listItem'
OrderedList.configure({
itemTypeName: 'listItem',
})
Commands
toggleOrderedList()
Toggle an ordered list.
editor.commands.toggleOrderedList()
Keyboard shortcuts
| Command | Windows/Linux | macOS |
|---|---|---|
| toggleOrderedList | Control Shift 7 |
Cmd Shift 7 |
Source code
packages/extension-ordered-list/