https://github.com/kid-1912/tiptap-extension-ordered-list
Tiptap ordered list extension with custom list-style-type support.
https://github.com/kid-1912/tiptap-extension-ordered-list
extension list-style ordered-list tiptap
Last synced: 10 months ago
JSON representation
Tiptap ordered list extension with custom list-style-type support.
- Host: GitHub
- URL: https://github.com/kid-1912/tiptap-extension-ordered-list
- Owner: KID-1912
- Created: 2024-02-18T07:19:34.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T07:43:36.000Z (over 2 years ago)
- Last Synced: 2024-10-23T03:34:18.708Z (over 1 year ago)
- Topics: extension, list-style, ordered-list, tiptap
- Language: JavaScript
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tiptap-extension-ordered-list
Tiptap ordered list extension with custom list-style-type support.
---
## Install
```shell
npm install tiptap-extension-ordered-list -S
```
## Usage
```js
const listType = e.target.dataset.listType; // decimal lower-alpha lower-roman upper-alpha upper-roman
let chain = editor.chain().focus();
// 开启列表类型
if (!editor.isActive("orderedList")) {
chain.toggleOrderedList().updateAttributes("orderedList", { listStyleType });
}
// 切换列表类型
else if (editor.getAttributes("orderedList").listStyleType !== listStyleType) {
chain.updateAttributes("orderedList", { listStyleType });
}
// 关闭列表类型
else {
chain.toggleOrderedList();
}
```
## Options
Add `listStyleType` option, other options are same as `@tiptap/extension-ordered-list`
```js
import OrderedList from "tiptap-extension-ordered-list";
const editor = new Editor({
element: document.querySelector(".editor"),
extensions: [
StarterKit,
OrderedList.configure({
listStyleType: "decimal", // default decimal
HTMLAttributes: { class: "list-paddingleft-1" },
}),
],
});
```
## Relations
**@tiptap/extension-ordered-list:** https://github.com/ueberdosis/tiptap/tree/develop/packages/extension-ordered-list
**tiptap-appmsg-editor:** https://github.com/KID-1912/tiptap-appmsg-editor