模組: @lexical/link

類別

• AutoLinkNode
• LinkNode

類型別名

AutoLinkAttributes

Ƭ AutoLinkAttributes: Partial<Spread<LinkAttributes, { isUnlinked?: boolean }>>

定義於

packages/lexical-link/src/index.ts:38

---

LinkAttributes

Ƭ LinkAttributes: Object

類型聲明

名稱	類型
rel?	null | string
target?	null | string
title?	null | string

定義於

packages/lexical-link/src/index.ts:32

---

SerializedAutoLinkNode

Ƭ SerializedAutoLinkNode: Spread<{ isUnlinked: boolean }, SerializedLinkNode>

定義於

packages/lexical-link/src/index.ts:330

---

SerializedLinkNode

Ƭ SerializedLinkNode: Spread<{ url: string }, Spread<LinkAttributes, SerializedElementNode>>

定義於

packages/lexical-link/src/index.ts:42

變數

TOGGLE_LINK_COMMAND

• Const TOGGLE_LINK_COMMAND: LexicalCommand<string | { url: string } & LinkAttributes | null>

定義於

packages/lexical-link/src/index.ts:472

函數

$createAutoLinkNode

▸ $createAutoLinkNode(url, attributes?): AutoLinkNode

接受一個 URL 並創建一個 AutoLinkNode。AutoLinkNodes 通常在輸入過程中自動生成，這在生成 LinkNode 的按鈕不實用時特別有用。

參數

名稱	類型	說明
url	string	LinkNode 應該指向的 URL。
attributes?	Partial<Spread<LinkAttributes, { isUnlinked?: boolean }>>	可選的 HTML a 標籤屬性。{ target, rel, title }

返回值

AutoLinkNode

• LinkNode。

定義於

packages/lexical-link/src/index.ts:454

---

$createLinkNode

▸ $createLinkNode(url, attributes?): LinkNode

接受一個 URL 並創建一個 LinkNode。

參數

名稱	類型	說明
url	string	LinkNode 應該指向的 URL。
attributes?	LinkAttributes	可選的 HTML a 標籤屬性{ target, rel, title }

返回值

LinkNode

• LinkNode。

定義於

packages/lexical-link/src/index.ts:312

---

$isAutoLinkNode

▸ $isAutoLinkNode(node): node is AutoLinkNode

確定節點是否為 AutoLinkNode。

參數

名稱	類型	說明
node	undefined | null | LexicalNode	要檢查的節點。

返回值

node is AutoLinkNode

如果節點是 AutoLinkNode，則返回 true，否則返回 false。

定義於

packages/lexical-link/src/index.ts:466

---

$isLinkNode

▸ $isLinkNode(node): node is LinkNode

確定節點是否為 LinkNode。

參數

名稱	類型	說明
node	undefined | null | LexicalNode	要檢查的節點。

返回值

node is LinkNode

如果節點是 LinkNode，則返回 true，否則返回 false。

定義於

packages/lexical-link/src/index.ts:324

---

$toggleLink

▸ $toggleLink(url, attributes?): void

生成或更新一個 LinkNode。如果 URL 為 null，也可以刪除 LinkNode，但會保存任何子節點並將它們提升到父節點。

參數

名稱	類型	說明
url	null | string	連結指向的 URL。
attributes	LinkAttributes	可選的 HTML a 標籤屬性。{ target, rel, title }

返回值

void

定義於

packages/lexical-link/src/index.ts:482

---

toggleLink

▸ toggleLink(url, attributes?): void

參數

名稱	類型
url	null | string
attributes	LinkAttributes

返回值

void

已過時

被 @lexical/eslint-plugin rules-of-lexical 重命名為 $toggleLink

定義於

packages/lexical-link/src/index.ts:599