tiptap/docs/api/nodes/ordered-list.md
2021-10-01 22:57:27 +02:00

1.8 KiB

OrderedList

Version Downloads

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

# 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 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

Command Windows/Linux macOS
toggleOrderedList Control Shift 7 Cmd Shift 7

Source code

packages/extension-ordered-list/

Usage