Extension documentation

[Leecason]

documentation for extensions

TODO: in README or docs site

• Doc, Paragraph, Text
• Heading
• Bold
• Italic
• Underline
• Strike
• Code
• CodeBlock
• Blockquote
• Link
• Image
• BulletList, OrderedList, ListItem
• TodoList, TodoItem
• Iframe
• Table, TableHeader, TableRow, TableCell
• TextAlign
• LineHeight
• Indent
• HorizontalRule, HardBreak, TrailingNode
• History
• TextColor, TextHighlight
• FormatClear
• FontType, FontSize
• Preview, Print, Fullscreen, SelectAll
• CodeView

[Leecason]

Necessary extensions

Doc

Must be introduced in the first

Usage

new Doc({
  title: true,
})

options

title

Whether the title mode is enabled. Default to false, if true, needs to introduce Title extension.

Paragraph

Usage

new Paragraph()

Text

Usage

new Text()

[Leecason]

Heading

Usage

new Heading({
  level: 5
});

options

level

the max level of heading

[Leecason]

Bold

Usage

new Bold()

[Leecason]

Italic

Usage

new Italic()

[Leecason]

Underline

Usage

new Underline()

[Leecason]

Strike

Usage

new Strike()

[Leecason]

Code

Usage

new Code()

[Leecason]

CodeBlock

Usage

new CodeBlock()

[Leecason]

Blockquote

Usage

new Blockquote()

[Leecason]

Link

Usage

new Link()

[Leecason]

Image

Usage

new Image({
  urlPattern: 
  uploadRequest:
})

options

urlPattern

check image url valid when insert external image.

Default:

/(https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|www\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9]+\.[^\s]{2,}|www\.[a-zA-Z0-9]+\.[^\s]{2,})/

uploadRequest

custom image upload method, the method should return Promise<url>.

default value is a method that return base64 data of image

[Leecason]

BulletList(use with ListItem)

Usage

new BulletList()

OrdererList(use with ListItem)

Usage

new OrderedList()

ListItem

Usage

new ListItem()