mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-05 04:19:07 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
2f15a11572
tiptap/docs/api/nodes/ordered-list.md
Philipp Kühn 2f15a11572 remove gridsome
2021-09-16 14:41:25 +02:00

1.6 KiB
Raw Blame History

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

  • Windows/Linux: Control Shift 7
  • macOS: Cmd Shift 7

Source code

packages/extension-ordered-list/

Usage