57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
---
|
||
description: If a bullet list doesn’t look serious enough, put some numbers in front of it.
|
||
icon: list-ordered
|
||
---
|
||
|
||
# OrderedList
|
||
[](https://www.npmjs.com/package/@tiptap/extension-ordered-list)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-ordered-list?minimal=true)
|
||
|
||
This extension enables you to use ordered lists in the editor. They are rendered as `<ol>` HTML tags.
|
||
|
||
Type <code>1. </code> (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
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-ordered-list @tiptap/extension-list-item
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item
|
||
```
|
||
|
||
This extension requires the [`ListItem`](/api/nodes/list-item) node.
|
||
|
||
## Settings
|
||
|
||
### HTMLAttributes
|
||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||
|
||
```js
|
||
OrderedList.configure({
|
||
HTMLAttributes: {
|
||
class: 'my-custom-class',
|
||
},
|
||
})
|
||
```
|
||
|
||
## Commands
|
||
|
||
### toggleOrderedList()
|
||
Toggle an ordered list.
|
||
|
||
```js
|
||
editor.commands.toggleOrderedList()
|
||
```
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| ----------------- | ------------------------------- | --------------------------- |
|
||
| toggleOrderedList | `Control` `Shift` `7` | `Cmd` `Shift` `7` |
|
||
|
||
## Source code
|
||
[packages/extension-ordered-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-ordered-list/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Nodes/OrderedList"></tiptap-demo>
|