模組: @lexical/markdown

類型別名

ElementTransformer

Ƭ ElementTransformer: Object

類型定義

名稱	類型
dependencies	Klass<LexicalNode>[]
export	(node: LexicalNode, traverseChildren: (node: ElementNode) => string) => string | null
regExp	RegExp
replace	(parentNode: ElementNode, children: LexicalNode[], match: string[], isImport: boolean) => void
type	"element"

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:46

---

TextFormatTransformer

Ƭ TextFormatTransformer: Readonly<{ format: ReadonlyArray<TextFormatType> ; intraword?: boolean ; tag: string ; type: "text-format" }>

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:63

---

TextMatchTransformer

Ƭ TextMatchTransformer: Readonly<{ dependencies: Klass<LexicalNode>[] ; export: (node: LexicalNode, exportChildren: (node: ElementNode) => string, exportFormat: (node: TextNode, textContent: string) => string) => string | null ; importRegExp: RegExp ; regExp: RegExp ; replace: (node: TextNode, match: RegExpMatchArray) => void ; trigger: string ; type: "text-match" }>

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:70

---

Transformer

Ƭ Transformer: ElementTransformer | TextFormatTransformer | TextMatchTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:41

變數

BOLD_ITALIC_STAR

• Const BOLD_ITALIC_STAR: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:308

---

BOLD_ITALIC_UNDERSCORE

• Const BOLD_ITALIC_UNDERSCORE: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:314

---

BOLD_STAR

• Const BOLD_STAR: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:321

---

BOLD_UNDERSCORE

• Const BOLD_UNDERSCORE: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:327

---

CHECK_LIST

• Const CHECK_LIST: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:276

---

CODE

• Const CODE: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:244

---

ELEMENT_TRANSFORMERS

• Const ELEMENT_TRANSFORMERS: ElementTransformer[]

定義於

packages/lexical-markdown/src/index.ts:39

---

HEADING

• Const HEADING: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:190

---

HIGHLIGHT

• Const HIGHLIGHT: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:302

---

INLINE_CODE

• Const INLINE_CODE: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:296

---

ITALIC_STAR

• Const ITALIC_STAR: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:340

---

ITALIC_UNDERSCORE

• Const ITALIC_UNDERSCORE: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:346

---

LINK

• Const LINK: TextMatchTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:357

---

ORDERED_LIST

• Const ORDERED_LIST: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:286

---

QUOTE

• Const QUOTE: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:207

---

STRIKETHROUGH

• Const STRIKETHROUGH: TextFormatTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:334

---

TEXT_FORMAT_TRANSFORMERS

• Const TEXT_FORMAT_TRANSFORMERS: TextFormatTransformer[]

定義於

packages/lexical-markdown/src/index.ts:51

---

TEXT_MATCH_TRANSFORMERS

• Const TEXT_MATCH_TRANSFORMERS: TextMatchTransformer[]

定義於

packages/lexical-markdown/src/index.ts:63

---

TRANSFORMERS

• Const TRANSFORMERS: Transformer[]

定義於

packages/lexical-markdown/src/index.ts:65

---

UNORDERED_LIST

• Const UNORDERED_LIST: ElementTransformer

定義於

packages/lexical-markdown/src/MarkdownTransformers.ts:266

函式

$convertFromMarkdownString

▸ $convertFromMarkdownString(markdown, transformers?, node?, shouldPreserveNewLines?): void

從字串渲染 Markdown。操作後，選擇會移到開始位置。

參數

名稱	類型	預設值
markdown	string	undefined
transformers	Transformer[]	TRANSFORMERS
node?	ElementNode	undefined
shouldPreserveNewLines	boolean	false

回傳

void

定義於

packages/lexical-markdown/src/index.ts:74

---

$convertToMarkdownString

▸ $convertToMarkdownString(transformers?, node?, shouldPreserveNewLines?): string

從 Markdown 渲染字串。操作後，選擇會移到開始位置。

參數

名稱	類型	預設值
transformers	Transformer[]	TRANSFORMERS
node?	ElementNode	undefined
shouldPreserveNewLines	boolean	false

回傳

string

定義於

packages/lexical-markdown/src/index.ts:90

---

registerMarkdownShortcuts

▸ registerMarkdownShortcuts(editor, transformers?): () => void

參數

名稱	類型	預設值
editor	LexicalEditor	undefined
transformers	Transformer[]	TRANSFORMERS

回傳

fn

▸ (): void

回傳

void

定義於

packages/lexical-markdown/src/MarkdownShortcuts.ts:323