API Reference LiveFlow v#0.3.2

Copy Markdown View Source

Modules

LiveFlow - A Phoenix LiveView library for building interactive node-based diagrams.

Edge change event types for LiveFlow.

Node change event types for LiveFlow.

Copy/paste clipboard for LiveFlow.

Real-time collaboration support for LiveFlow.

Represents a user in a collaborative flow session.

Edge function component for LiveFlow.

Main Flow LiveComponent for LiveFlow.

Handle function component for LiveFlow.

Dynamic SVG marker definitions for LiveFlow edges.

Node resizer component for LiveFlow.

A toolbar attached to a node (React Flow's <NodeToolbar />).

Node wrapper LiveComponent for LiveFlow.

Edge data structure for LiveFlow.

Server-side SVG rendering of a flow, without a browser.

Handle data structure for LiveFlow.

Undo/redo history stack for LiveFlow.

Layout helpers.

Node data structure for LiveFlow.

Bezier curve path calculation for edges.

Edge geometry: handle coordinates (fixed or floating) and the path of an edge between two nodes. Shared by LiveFlow.Components.Edge and LiveFlow.Export.

Behaviour for edge path calculations.

Smoothstep path calculation for edges.

Step/orthogonal path calculation for edges.

Straight line path calculation for edges.

Serializes and deserializes LiveFlow state to/from JSON.

Main state container for LiveFlow.

Type definitions for LiveFlow.

Connection validation functions for LiveFlow.

Helper to validate and create edges from lf:connect_end event params.

Viewport data structure for LiveFlow.

Server-side viewport culling for LiveFlow.

Mix Tasks

Adds ELK (elkjs) to your app's JavaScript, for the client-side auto layout (LiveFlow.Layout.prepare_layout_data/2 pushed as lf:layout_data, or JS.dispatch("lf:auto-layout")).