39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
# 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
|
|
| Option | Type | Default | Description |
|
|
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
|
|
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
|
|
|
## Commands
|
|
| Command | Parameters | Description |
|
|
| ----------- | ---------- | ----------------------- |
|
|
| orderedList | — | Toggle an ordered list. |
|
|
|
|
## Keyboard shortcuts
|
|
* Windows/Linux: `Control` `Shift` `7`
|
|
* macOS: `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>
|