Skip to content

Flow Plugin System

Flow provides a standardized plugin interface (FlowPlugin / PluginManager) for extending capabilities like Minimap, Controls, Grid, Snap, and Export.

Using Plugins

Plugins can be registered using the usePlugin method. Most built-in features have been migrated to the plugin system.

Plugin System Demo
Built-in Plugins
Basic Plugin Usage

Built-in Plugins

Plugin NameFactory FunctionDescription
MinimapcreateMiniMapPlugin(options)Shows a minimap of the flow chart, supports click-to-pan
ControlscreateControlsPlugin(options)Provides a toolbar for zooming, fitting view, and locking
GridcreateGridPlugin(options)Provides dots or grid background styles
SnapcreateSnapPlugin(options)Enables node snapping and alignment guide lines
ExportcreateExportPlugin(options)Provides methods to export the flow as JSON or Image

Custom Plugins

You can develop custom plugins by implementing the FlowPlugin interface. Plugins can listen to events, modify state, or even provide their own UI components.

Custom Plugin (Click Me)
Custom Plugin

Next

Released under the MIT License.