Node

Primary canvas element. Configurable via props or by passing a custom node as children

The props interface for the Node component is available by importing the NodeConfig type

Description

A Node can be configured in two primary ways.

First, you can customize the default node by passing props to control color, border, size, position, etc.

Second, you can wrap your own custom components with our Node component and use the exposed actions, properties and events however you choose. Pass the entire component as a child of the Svelvet component to render it on the canvas.

+page.svelte

<script>
  import { Node, Svelvet } from 'svelvet';
  import MyNode from './MyNode.svelte';
</script>

<Svelvet>
	<MyNode />
	<Node id="alpha" bgColor="red" label="Default Node" />
</Svelvet>

When creating custom nodes, styling should be handled entirely within the context of your component. Passing props to the Node wrapper may not result in your intended styling. If you’d like the Node to be resizable, you can set initial dimensions via props, but set your CSS width and height to 100%

Props

position

{x: number, y: number}

default: "{x: 0, y: 0}"

The position of the Node. These correspond to pixel values at the default graph scale. This prop newly features two way data binding. Please report any issues on GitHub.

dimensions

{ width: number, height: number }

default: "{ width: 200, height: 100 }"

Initial dimensions of the node. Pixel value based on initial scale.

connections

Array<[nodeId, anchorId] | nodeId>

default: "[]"

Used to specify Node connections ahead of time. Array of tuples representing a node/anchor pair or of nodeIds themselves. IDs can be strings or numbers. When specifying nodeIds only, connections are spread evenly across the input anchors of the target.

id

number | string

default: "incrementing integer"

Identification for the node. If not passed, defaults to an incrementing integer. Used as the HTML id value for the element taking the form N-id.

edge

Edge Component

A custom Edge component to be used as the default Edge style for the Node. Can be overriden at the Anchor level.

inputs

number

default: "1"

Number of input anchors placed on the node.

outputs

number

default: "1"

Number of output anchors placed on the node.

drop

'cursor' | 'center'

default: "false"

When passed a value, the initial drop position of the Node is set to the current relative cursor position or the current viewport center.

useDefaults

boolean

default: "false"

When creating custom Nodes, pass the useDefaults prop to use Svelvet’s default Node styling.

bgColor

CSS Color String

default: "theme dependent"

The initial background color of the node. Default changes based on theme.

borderColor

CSS Color String

default: "theme dependent"

The initial border color of the node. Default changes based on theme.

rotation

number

default: "0"

Initial roation of node. Can be set dynamically when the Node is resizable.

borderWidth

number

default: "1"

Pixel value of the border at default scale.

textColor

CSS Color String

default: "theme dependent"

The initial text color of the node. Default changes based on theme.

selectionColor

CSS Color String

default: "theme dependent"

Color of the border when the node is selected.

label

string

default: ""

Label for the default node. Centered horizontally and vertically

TD

boolean

default: "false"

Controls the default direction of the canvas. When true, input anchors on top and output anchors on the bottom. If neither TD or LR are passed, node direction defaults to canvas direction.

LR

boolean

default: "false"

Controls the default direction of the canvas. When true, input anchors are placed on left and output anchors on the right. If neither TD or LR are passed, node direction defaults to canvas direction.

zIndex

number | Infinity | -Infinity

default: "1"

Initial stacking placement of the node. To force a node to the top or bottom at all times, pass Infinity or -Infinity.

editable

boolean

default: "true"

Determines whether the node properties can be edited via right click. Populates Editor which gives user the ability to delete selected node, edit label name and edit height and width via resize button. Resize input does not need unit, just the number - for example: 200.

locked

boolean

default: "false"

Prevents node from being moved. Can be set at the canvas level.

center

boolean

default: "false"

When true, the Node is mounted in the optical center of the viewport

dynamic

boolean

default: "false"

Enables dynamic Anchor positioning based on relative position of connected Nodes

Actions

let:grabHandle

Accessed via the let directive. Placed on an element (use:grabHandle) you would like to control movement and selection of the Node.

Events

on:nodeClicked

Fires when the node is clicked.

on:nodeReleased

Fires when when a mouse up event occurs on the Node. Does not fire if the Node has been dragged and then released.

on:duplicate

Fires whenever a Node is selected and the user triggers a modifier key command with the ‘D’ key pressed.

Properties

let:selected

boolean

Boolean representing whether or not the node is currently selected. Toggle classes by passing to an element using the class directive (class:selected).

let:node

object

The Node object from the Svelvet internal store.

Functions

let:connect

Use to programatically create connections from Nodes. Accepts a single Node ID or a [Node ID, Anchor ID] tuple.

let:disconnect

Use to programatically remove connections from Nodes. Accepts a single Node ID or a [Node ID, Anchor ID] tuple.