Skip to main content

INode interface

📖 Description​

Interface that describes a node within the form definition.

tip

See the form definition interface for more information about nodes.

📃 Type declaration​

interface INode {
  id: string;Readonly
  name?: string;ReadonlyOptional
  nameVisible?: boolean;ReadonlyOptional
  disabled?: boolean;ReadonlyOptional
  placeholder?: string;ReadonlyOptional
  description?: string;ReadonlyOptional
  explanation?: string;ReadonlyOptional
  block?: {
    type: string;
    version: string;
  };ReadonlyOptional
  slots?: ISlot[];ReadonlyOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ block​

Specifies the block for the node. A node block implements the actual behavior of a node.

Type​

{
  /* Contains the node block type identifier. */
  type: string;

  /* Contains the version of the block. */
  version: string;
}
info

Besides the listed properties, node blocks may store additional properties in the block object.

🏷ī¸ description​

Specifies the description of the node (supports markdown).

Type​

string

🏷ī¸ disabled​

Specifies if the node is disabled. Disabled nodes are ignored by the runners as if they did not exist.

Type​

boolean

🏷ī¸ explanation​

Specifies the explanation of the node (supports markdown) which is an additional help text that runners can show along the node.

Type​

string

🏷ī¸ id​

Specifies the unique identifier of the node.

Type​

string

🏷ī¸ name​

Specifies the name of the node (supports markdown).

Type​

string

🏷ī¸ nameVisible​

Specifies if the name of the node should be visible in the runner.

Type​

boolean

🏷ī¸ placeholder​

Specifies the placeholder of the node.

Type​

string

info

Placeholders are usually used to identify a certain field. For example, a text input box for a city could have the placeholder Enter a city here.

🏷ī¸ slots​

Specifies the slots for the node. Slots serve as the data transporters for the form. Each node block defines the slots required for the data collection of that block.

Type​

ISlot[]