mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-16 11:49:02 +08:00

Martin Kriegeskorte 0a5d4b6658 docs: add icons for extensions

2021-10-14 21:20:21 +02:00

1.7 KiB

Raw Blame History

description	icon
Everything looks more serious with a few bullet points.	list-unordered

BulletList

This extension enables you to use bullet lists in the editor. They are rendered as <ul> HTML tags.

Type * , - or + at the beginning of a new line and it will magically transform to a bullet list.

Installation

# with npm
npm install @tiptap/extension-bullet-list @tiptap/extension-list-item

# with Yarn
yarn add @tiptap/extension-bullet-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.

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

Commands

toggleBulletList()

Toggles a bullet list.

editor.commands.toggleBulletList()

Keyboard shortcuts

Command	Windows/Linux	macOS
toggleBulletList	`Control` `Shift` `8`	`Cmd` `Shift` `8`

Source code

packages/extension-bullet-list/

1.7 KiB Raw Blame History