Svelte Flow

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

On This Page

  • Fields
  • Notes
Question? Give us feedback →Edit this pageWhat's new here?
ReferenceTypes
Viewport

Viewport

Internally, Svelte Flow maintains a coordinate system that is independent of the rest of the page. The Viewport type tells you where in that system your flow is currently being display at and how zoomed in or out it is.

export type Viewport = {
  x: number;
  y: number;
  zoom: number;
};

Fields

NameType
#x
number
#y
number
#zoom
number

Notes

  • A Transform has the same properties as the viewport, but they represent different things. Make sure you don’t get them muddled up or things will start to look weird!
Types

A project by the xyflow team

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

Docs

Quickstart GuideAPI ReferenceExamplesShowcaseSupport Us

Social

DiscordGithubX / TwitterBluesky

xyflow

BlogOpen SourceAboutContact
Careers hiring

Legal

MIT LicenseCode of Conduct

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