mirror of https://github.com/ueberdosis/tiptap.git synced 2025-01-23 18:03:08 +08:00

Hans Pagel 0edc57245c docs: add descriptions to all extensions

2021-10-14 00:13:50 +02:00

1.7 KiB

Raw Blame History

description
If a bullet list doesn’t look serious enough, put some numbers in front of it.

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

# 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

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

OrderedList.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

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/

1.7 KiB Raw Blame History Unescape Escape