Canvases
Canvas, node/edge type, and tag collections
Canvases
The
canvases feature requires Basic plan or above.canvases
Stores React Flow-based canvas data. Supports versioning (up to 25 versions, autosave).
| Field | Type | Description | Required |
|---|---|---|---|
title | text | Title | ✓ |
slug | text | URL slug (unique within tenant) | |
description | textarea | Description | |
canvas | json | React Flow canvas data (nodes, edges, viewport) | ✓ |
status | select | Status: draft, published (default: draft) | |
tags | relationship[] | Tags (canvas-tags, M:N) | |
metadata | json | Custom metadata |
Canvas Structure
{
nodes: [
{
id: 'node-1',
type: 'dynamic', // 'dynamic' | 'frame'
position: { x: 0, y: 0 },
data: {
nodeTypeSlug: 'text', // Node type slug
label: 'Node Name',
fields: { body: 'Content' } // Fields defined in node type
}
}
],
edges: [
{
id: 'edge-1',
source: 'node-1',
target: 'node-2',
edgeTypeSlug: 'default', // Edge type slug
fields: {} // Fields defined in edge type
}
],
viewport: { x: 0, y: 0, zoom: 1 }
}SDK Rendering
To render canvas data, use the SDK's CanvasRenderer component. See CanvasRenderer for details.
canvas-node-types
Defines custom node types for canvases. Managed independently per tenant.
| Field | Type | Description | Required |
|---|---|---|---|
title | text | Node type name | ✓ |
slug | text | Slug (unique within tenant) | |
color | text | Background color (hex or named color) | |
defaultSize | group | Default size: width (default: 200), height (default: 200) | |
transparentBackground | checkbox | Transparent background | |
fields | array | Custom field list |
Field Types
Available field types for node fields array (edges support all except image):
| Type | Description |
|---|---|
text | Text |
textarea | Long text |
number | Number |
url | URL |
color | Color |
image | Image |
select | Select (requires options list) |
toggle | Toggle |
Built-in Node Types
| Slug | Color | Fields |
|---|---|---|
text | #dbeafe | body (textarea) |
image | #fef3c7 | image (image), alt (text), caption (text) |
canvas-edge-types
Defines custom edge types for canvases.
| Field | Type | Description | Required |
|---|---|---|---|
title | text | Edge type name | ✓ |
slug | text | Slug (unique within tenant) | |
color | text | Line color (hex) | |
strokeWidth | number | Line width (1-10, default: 2) | |
animated | checkbox | Animated (default: true) | |
lineStyle | select | Line style: default, step, smoothstep, bezier | |
fields | array | Custom field list |
Built-in Edge Types
| Slug | Width | Animated | Style |
|---|---|---|---|
default | 2px | No | default |
canvas-tags
Stores canvas tags.
| Field | Type | Description | Required |
|---|---|---|---|
title | text | Tag name | ✓ |
slug | text | URL slug (auto-generated) | |
color | color | Badge color (hex) |
All images use the unified images collection. See Image Collections for details.