Svelte Flow is still alpha! Check out the latest changes here.

Svelte Flow

LearnLearnReferenceReferenceExamplesExamples
GitHub (opens in a new tab)Support Us
  • API Reference
  • <SvelteFlow />
  • <SvelteFlowProvider />
  • Components
    • <Background />
    • <BaseEdge />
    • <ControlButton />
    • <Controls />
    • <EdgeLabelRenderer />
    • <Handle />
    • <MiniMap />
    • <NodeResizer />
    • <NodeResizeControl />
    • <NodeToolbar />
    • <Panel />
  • Hooks
    • useConnection()
    • useEdges()
    • useHandleConnections()
    • useNodes()
    • useNodesData()
    • useSvelteFlow()
    • useStore()
    • useUpdateNodeInternals()
  • Types
    • BackgroundVariant
    • ColorMode
    • Connection
    • ConnectionLineType
    • CoordinateExtent
    • DefaultEdgeOptions
    • Edge
    • EdgeMarker
    • EdgeProps
    • FitViewOptions
    • KeyDefinition
    • MarkerType
    • Node
    • NodeProps
    • NodeOrigin
    • PanelPosition
    • Position
    • SvelteFlowStore
    • Viewport
    • XYPosition
    • addEdge()
    • getBezierPath()
    • getConnectedEdges()
    • getIncomers()
    • getNodesBounds()
    • getOutgoers()
    • getSimpleBezierPath()
    • getSmoothStepPath()
    • getStraightPath()
    • getViewportForBounds()
    • isEdge()
    • isNode()
    • updateEdge()

On This Page

  • Fields
Question? Give us feedback → (opens in a new tab)Edit this pageWhat's new here?
Reference
Types
FitViewOptions

FitViewOptions

When calling fitView these options can be used to customize the behaviour. For example, the duration option can be used to transform the viewport smoothly over a given amount of time.

export type FitViewOptions = {
  padding?: number;
  includeHiddenNodes?: boolean;
  minZoom?: number;
  maxZoom?: number;
  duration?: number;
  nodes?: (Node | { id: Node['id'] })[];
};

Fields

NameType
#padding?
number
#includeHiddenNodes?
boolean
#minZoom?
number
#maxZoom?
number
#duration?
number
#nodes?
(Partial<Node> & { id: Node['id'] })[]
EdgePropsKeyDefinition

A project by the xyflow team

We are building and maintaining open source software for node-based UIs since 2019.

Svelte Flow

Quickstart GuideAPI ReferenceExamplesShowcaseSupport Us

Community

DiscordGithubMastodonBluesky

xyflow

BlogOpen SourceAboutContact

Legal

MIT LicenseCode of Conduct

info@xyflow.com — Copyright © 2024 webkid GmbH. All rights reserved — website design by Facu Montanaro