Uniform Platform API

Home > @uniformdev/mesh-sdk-react > VariableNode

VariableNode class

Renders a variable reference node within a Lexical editor

Signature:

Extends: DecoratorNode<JSX.Element>

Constructors

Constructor

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

(constructor)(reference, state, key)

</td><td>

Constructs a new instance of the VariableNode class

</td></tr> </tbody></table>

Properties

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

reference

</td><td>

Readonly<string>

</td><td>

</td></tr> </tbody></table>

Methods

Method

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

clone(node)

</td><td>

static

</td><td>

</td></tr> <tr><td>

createDOM()

</td><td>

Creates the DOM wrapper that hosts the node

</td></tr> <tr><td>

decorate()

</td><td>

Render the variable node using React. NOTE: this is effectively an island of React, and you may not call hooks, rely on Context, etc in this renderer.

</td></tr> <tr><td>

exportJSON()

</td><td>

Serializes the node to JSON for editor initial state

</td></tr> <tr><td>

getState()

</td><td>

Gets the node's current state

</td></tr> <tr><td>

getTextContent()

</td><td>

Copy variable to clipboard in a format we will read back if pasted (albeit it won't get the fancy chip-node)

</td></tr> <tr><td>

getType()

</td><td>

static

</td><td>

</td></tr> <tr><td>

importJSON(serializedNode)

</td><td>

static

</td><td>

Imports the node from serialized JSON (i.e. the data provided to the editor's initial state)

</td></tr> <tr><td>

setState(state)

</td><td>

Updates the node's variables state so it knows its current validity, display name, etc The plugin updates this whenever the variables prop changes.

</td></tr> <tr><td>

updateDOM()

</td><td>

</td></tr> </tbody></table>