mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-21 07:18:05 +08:00

feat: #3540 Ability to preserve marks on lists (#3541 )

* feat: #3540 Ability to preserve marks on lists

* feat: preserveAttrs in list items

* `keepMarks` is working, but need help with `keepAttrs`

* fix: conflict

* avoid casting

2023-02-22 10:13:28 +01:00

2.1 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

npm install @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',
  },
})

itemTypeName

Specify the list item name.

Default: 'listItem'

BulletList.configure({
  itemTypeName: 'listItem',
})

keepMarks

Decides whether to keep the marks from a previous line after toggling the list either using inputRule or using the button

Default: false

BulletList.configure({
  keepMarks: true,
})

keepAttributes

Decides whether to keep the attributes from a previous line after toggling the list either using inputRule or using the button

Default: false

BulletList.configure({
  keepAttributes: true,
})

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/

Usage

https://embed.tiptap.dev/preview/Nodes/BulletList

2.1 KiB Raw Blame History