Use Viewport component

Common example:

<Viewport worldWidth="2000" worldHeight="2000" clamp={ {direction: 'all'} } />

Properties

You can use all properties from Display Object

Viewport Options

The Viewport component supports several options inherited from pixi-viewport:

Option	Type	Description
drag	boolean or object	Enable dragging the viewport
wheel	boolean or object	Enable mouse wheel scrolling
pinch	boolean or object	Enable pinch to zoom
decelerate	boolean or object	Enable deceleration (momentum) after dragging
clamp	object	Restrict viewport movement

Example with options:

<Viewport 
  worldWidth="2000" 
  worldHeight="2000" 
  drag={true}
  wheel={true}
  pinch={true}
  decelerate={true}
  clamp={ {direction: 'all'} } 
/>

Viewport Events

The Viewport component supports all events from pixi-viewport:

Event	Description
bounce-x-end	Fired when bounce on the x-axis ends
bounce-x-start	Fired when bounce on the x-axis starts
bounce-y-end	Fired when bounce on the y-axis ends
bounce-y-start	Fired when bounce on the y-axis starts
clicked	Fired when viewport is clicked
drag-end	Fired when drag ends
drag-start	Fired when drag starts
frame-end	Fired when frame ends
mouse-edge-end	Fired when mouse-edge ends
mouse-edge-start	Fired when mouse-edge starts
moved	Fired when viewport moves
moved-end	Fired when viewport stops moving
pinch-end	Fired when pinch ends
pinch-start	Fired when pinch starts
snap-end	Fired when snap ends
snap-start	Fired when snap starts
snap-zoom-end	Fired when snap-zoom ends
snap-zoom-start	Fired when snap-zoom starts
wheel-scroll	Fired when mouse wheel is scrolled
zoomed	Fired when viewport is zoomed
zoomed-end	Fired when viewport stops zooming

Example with event:

<Viewport 
  worldWidth="2000" 
  worldHeight="2000"
  drag-start={(event) => console.log('Drag started', event)}
/>

Viewport Follow Directive

The viewportFollow directive allows an element to be followed by the viewport. When applied, the viewport will automatically center on the element as it moves.

This directive must be used within a Viewport component context.

Usage

<Viewport worldWidth="2000" worldHeight="2000" clamp={ {direction: 'all'} }>
    <Rect viewportFollow x="0" y="0" width="100" height="100" color="red" />
</Viewport>

<script>
    const viewportFollow = true
</script>

In this example, the red rectangle will be followed by the viewport, keeping it centered in the view as it moves around within the 2000x2000 world space.

Usage with options

<Viewport worldWidth="2000" worldHeight="2000" clamp={ {direction: 'all'} }>
    <Rect viewportFollow x="0" y="0" width="100" height="100" color="red" />
</Viewport>

<script>
    const viewportFollow = {
        speed: 0.1,
        acceleration: 0.1,
        radius: 100
    }
</script>

• speed number 0 optional to follow in pixels/frame (0=teleport to location)
• acceleration number optional set acceleration to accelerate and decelerate at this rate; speed cannot be 0 to use acceleration
• radius number optional radius (in world coordinates) of center circle where movement is allowed without moving the viewport * @returns {Viewport} this

Requirements

• Must be used on an element that is a child of a Viewport component
• The parent Viewport component must have defined dimensions (worldWidth and worldHeight)

WARNING

Important: When an element has viewportFollow set to true, it will automatically disable the dragging functionality of the parent viewport. This is by design as viewport dragging would conflict with the following behavior.

Common Properties

Property	Type	Description
x	number	X-coordinate position of the display object.
y	number	Y-coordinate position of the display object.
width	number	Width of the display object.
height	number	Height of the display object.
scale	object	Scale of the display object.
anchor	object	Anchor point of the display object.
skew	object	Skew of the display object.
tint	number	Tint color of the display object.
rotation	number	Rotation of the display object in radians.
angle	number	Rotation of the display object in degrees.
zIndex	number	Z-index of the display object.
roundPixels	boolean	Whether to round pixel values.
cursor	string	Cursor style when hovering over the display object.
visible	boolean	Visibility of the display object.
alpha	number	Alpha transparency of the display object.
pivot	object	Pivot point of the display object.
flexDirection	string	Flex direction for layout. Possible values: 'row', 'column', 'row-reverse', 'column-reverse'.
flexWrap	string	Flex wrap for layout. Possible values: 'wrap', 'nowrap', 'wrap-reverse'.
justifyContent	string	Justify content for layout. Possible values: 'flex-start', 'flex-end', 'center', 'space-between', 'space-around'.
alignItems	string	Align items for layout. Possible values: 'auto', 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
alignContent	string	Align content for layout. Possible values: 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
alignSelf	string	Align self for layout. Possible values: 'auto', 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
margin	object	Margin for layout.
padding	object	Padding for layout.
gap	object	Gap for layout.
border	object	Border for layout.
positionType	string	Position type for layout.
filters	array	Filters applied to the display object.
maskOf	Element	Element that this display object masks.
blendMode	string	Blend mode for rendering.
filterArea	object	Filter area for rendering.

shadow

Property	Type	Description
Property	Type	Description
blur	number	Blur strength.
color	number	Color of the shadow.
offset	object	Offset of the shadow.
quality	number	Quality of the shadow.