Skip to content
A highly configurable viewport/2D camera designed to work with pixi.js
JavaScript HTML
Branch: master
Clone or download
Latest commit 55e741c Aug 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
@types
dist updated test for contextmenu Aug 9, 2019
docs published 4.2.1 Aug 20, 2019
src breaking change; options.noOnContextMenu changed to options.disableOn… Aug 9, 2019
test updated test for contextmenu Aug 9, 2019
.gitignore adding docs Jun 21, 2019
.jsdoc.json fixed pixi.ticker issue Jun 5, 2019
LICENSE fixed double click issue Nov 7, 2017
README.md updated readme with npm information Jul 30, 2019
package.json published 4.2.1 Aug 20, 2019
rollup.config.js testing Jun 18, 2019
rollup.dev.js fixed dependency Jul 7, 2019
yarn.lock temporarily removed instanbul to remove lodash message Jul 21, 2019

README.md

pixi-viewport

A highly configurable viewport/2D camera designed to work with pixi.js.

Features include dragging, pinch-to-zoom, mouse wheel zooming, decelerated dragging, follow target, snap to point, snap to zoom, clamping, bouncing on edges, and move on mouse edges. See live example to try out all of these features.

All features are configurable and removable, so set up the viewport to be exactly what you need.

Migration from pixi-viewport v3 to v4

Viewport needs to be imported or required as follows:

import { Viewport } from 'pixi-viewport'

// or 

const Viewport = require('pixi-viewport').Viewport

Plugins have been moved to their own object:

// viewport.pausePlugin('drag')
viewport.plugins.pause('drag')

// viewport.resumePlugin('drag')
viewport.plugins.resume('drag')

// viewport.removePlugin('drag')
viewport.plugins.remove('drag')

// viewport.userPlugin('name', plugin, index)
viewport.plugins.add('name', plugin, index)

Simple Example

import * as PIXI from 'pixi.js'
import { Viewport } from 'pixi-viewport'

const app = new PIXI.Application()
document.body.appendChild(app.view)

// create viewport
const viewport = new Viewport({
    screenWidth: window.innerWidth,
    screenHeight: window.innerHeight,
    worldWidth: 1000,
    worldHeight: 1000,

    interaction: app.renderer.plugins.interaction // the interaction module is important for wheel to work properly when renderer.view is placed or scaled
})

// add the viewport to the stage
app.stage.addChild(viewport)

// activate plugins
viewport
    .drag()
    .pinch()
    .wheel()
    .decelerate()

// add a red box
const sprite = viewport.addChild(new PIXI.Sprite(PIXI.Texture.WHITE))
sprite.tint = 0xff0000
sprite.width = sprite.height = 100
sprite.position.set(100, 100)

Using commonjs:

const PIXI = require('pixi.js')
const Viewport = require('pixi-viewport').Viewport

// same code as above...

Live Example

https://davidfig.github.io/pixi-viewport/

API Documentation

https://davidfig.github.io/pixi-viewport/jsdoc/

Installation

yarn add pixi-viewport

or

npm i pixi-viewport

or grab the latest release and use it:

<script src="/directory-to-file/pixi.js"></script>
<script src="/directory-to-file/pixi-viewport.js"></script>
<!-- or <script type="module" src="/directory-to-file/pixi-viewport.es.js"></script> -->
<script>
    const Viewport = new Viewport.Viewport(options)
</script>

Build Examples

I've included a bunch of build examples in the docs/builds directory, including: browserify, rollup, standalone (e.g., cdn), standalone (pixi.js v4), and typescript. You can see the live demos at https://davidfig.github.io/pixi-viewport/builds/.

Tests

  1. Clone repository
  2. yarn install
  3. yarn test (for Mocha test code)
  4. yarn coverage (for Instanbul coverage)

Other Libraries

If you liked pixi-viewport, please try my other open source libraries:

  • pixi-scrollbox - pixi.js scrollbox: a masked box that can scroll vertically or horizontally with scrollbars (uses pixi-viewport)
  • pixi-ease - pixi.js animation library using easing functions
  • intersects - a simple collection of 2d collision/intersects functions. Supports points, circles, lines, axis-aligned boxes, and polygons

license

MIT License
(c) 2019 YOPEY YOPEY LLC by David Figatner

You can’t perform that action at this time.