@lexical/clipboard
Interfaces
LexicalClipboardData
Defined in: packages/lexical-clipboard/src/clipboard.ts:39
Properties
application/x-lexical-editor?
optionalapplication/x-lexical-editor:string
Defined in: packages/lexical-clipboard/src/clipboard.ts:41
text/html?
optionaltext/html:string
Defined in: packages/lexical-clipboard/src/clipboard.ts:40
text/plain
text/plain:
string
Defined in: packages/lexical-clipboard/src/clipboard.ts:42
Functions
$generateJSONFromSelectedNodes()
$generateJSONFromSelectedNodes<
SerializedNode>(editor,selection):object
Defined in: packages/lexical-clipboard/src/clipboard.ts:392
Gets the Lexical JSON of the nodes inside the provided Selection.
Type Parameters
SerializedNode
SerializedNode extends BaseSerializedNode
Parameters
editor
LexicalEditor to get the JSON content from.
selection
Selection to get the JSON content from.
null | BaseSelection
Returns
object
an object with the editor namespace and a list of serializable nodes as JavaScript objects.
namespace
namespace:
string
nodes
nodes:
SerializedNode[]
$generateNodesFromSerializedNodes()
$generateNodesFromSerializedNodes(
serializedNodes):LexicalNode[]
Defined in: packages/lexical-clipboard/src/clipboard.ts:422
This method takes an array of objects conforming to the BaseSerializedNode interface and returns an Array containing instances of the corresponding LexicalNode classes registered on the editor. Normally, you'd get an Array of BaseSerialized nodes from $generateJSONFromSelectedNodes
Parameters
serializedNodes
BaseSerializedNode[]
an Array of objects conforming to the BaseSerializedNode interface.
Returns
an Array of Lexical Node objects.
$getClipboardDataFromSelection()
$getClipboardDataFromSelection(
selection):LexicalClipboardData
Defined in: packages/lexical-clipboard/src/clipboard.ts:562
Serialize the content of the current selection to strings in text/plain, text/html, and application/x-lexical-editor (Lexical JSON) formats (as available).
Parameters
selection
the selection to serialize (defaults to $getSelection())
null | BaseSelection
Returns
LexicalClipboardData
$getHtmlContent()
$getHtmlContent(
editor,selection):string
Defined in: packages/lexical-clipboard/src/clipboard.ts:55
Returns the currently selected Lexical content as an HTML string, relying on the logic defined in the exportDOM methods on the LexicalNode classes. Note that this will not return the HTML content of the entire editor (unless all the content is included in the current selection).
Parameters
editor
LexicalEditor instance to get HTML content from
selection
The selection to use (default is $getSelection())
null | BaseSelection
Returns
string
a string of HTML content
$getLexicalContent()
$getLexicalContent(
editor,selection):null|string
Defined in: packages/lexical-clipboard/src/clipboard.ts:84
Returns the currently selected Lexical content as a JSON string, relying on the logic defined in the exportJSON methods on the LexicalNode classes. Note that this will not return the JSON content of the entire editor (unless all the content is included in the current selection).
Parameters
editor
LexicalEditor instance to get the JSON content from
selection
The selection to use (default is $getSelection())
null | BaseSelection
Returns
null | string
$insertDataTransferForPlainText()
$insertDataTransferForPlainText(
dataTransfer,selection):void
Defined in: packages/lexical-clipboard/src/clipboard.ts:111
Attempts to insert content of the mime-types text/plain or text/uri-list from the provided DataTransfer object into the editor at the provided selection. text/uri-list is only used if text/plain is not also provided.
Parameters
dataTransfer
DataTransfer
an object conforming to the [DataTransfer interface] (https://html.spec.whatwg.org/multipage/dnd.html#the-datatransfer-interface)
selection
the selection to use as the insertion point for the content in the DataTransfer object
Returns
void
$insertDataTransferForRichText()
$insertDataTransferForRichText(
dataTransfer,selection,editor):void
Defined in: packages/lexical-clipboard/src/clipboard.ts:132
Attempts to insert content of the mime-types application/x-lexical-editor, text/html, text/plain, or text/uri-list (in descending order of priority) from the provided DataTransfer object into the editor at the provided selection.
Parameters
dataTransfer
DataTransfer
an object conforming to the [DataTransfer interface] (https://html.spec.whatwg.org/multipage/dnd.html#the-datatransfer-interface)
selection
the selection to use as the insertion point for the content in the DataTransfer object
editor
the LexicalEditor the content is being inserted into.
Returns
void
$insertGeneratedNodes()
$insertGeneratedNodes(
editor,nodes,selection):void
Defined in: packages/lexical-clipboard/src/clipboard.ts:223
Inserts Lexical nodes into the editor using different strategies depending on some simple selection-based heuristics. If you're looking for a generic way to to insert nodes into the editor at a specific selection point, you probably want lexical.$insertNodes
Parameters
editor
LexicalEditor instance to insert the nodes into.
nodes
The nodes to insert.
selection
The selection to insert the nodes into.
Returns
void
copyToClipboard()
copyToClipboard(
editor,event,data?):Promise<boolean>
Defined in: packages/lexical-clipboard/src/clipboard.ts:451
Copies the content of the current selection to the clipboard in text/plain, text/html, and application/x-lexical-editor (Lexical JSON) formats.
Parameters
editor
the LexicalEditor instance to copy content from
event
the native browser ClipboardEvent to add the content to.
null | ClipboardEvent
data?
Returns
Promise<boolean>
setLexicalClipboardDataTransfer()
setLexicalClipboardDataTransfer(
clipboardData,data):void
Defined in: packages/lexical-clipboard/src/clipboard.ts:587
Call setData on the given clipboardData for each MIME type present in the given data (from $getClipboardDataFromSelection)
Parameters
clipboardData
DataTransfer
the event.clipboardData to populate from data
data
The lexical data
Returns
void