svelte-pan-zoom

svelte-pan-zoom

Canvas Pan and Zoom action for Svelte

See Demo Multiple Instances

Usage

Install using you package manager of choice:

pnpm i svelte-pan-zoom

Import action into page, create options and pass to action.

Options include:

• width & height in CSS pixels of item to render (will be centered and sized to fit canvas)
• render function to render to canvas (you're not limited to rendering a single image)
• padding (optional, default 0)
• maxZoom (optional, default 16)
• friction how much momentum will be continued (optional, default to 0.97)

NOTE: if you set friction to 1, any movement will never stop, so you'll have re-invented the DVD screen saver!

Your render function will be passed the canvas 2d render context and the animation timer plus the "focus" point (the point last zoomed or interacted with). It can return true if you want to reschedule another animation frame to be rendered. This is useful if what you are rendering is also itself being animated.

NOTE: svelte-disable-preload is applied to the canvas automatically, for smoother animations when used with SvelteKit.

Example

<script lang="ts">
  import { panzoom, type Options } from 'svelte-pan-zoom'

  export let image: CanvasImageSource

  function render(ctx: CanvasRenderingContext2D, t: number) {
    ctx.drawImage(image, 0, 0)
  }
</script>

{#await promise then options}
  <canvas use:panzoom={{ render, width: image.width, height: image.height }} />
{/await}

<style>
  canvas {
    box-sizing: border-box;
    width: 100%;
    height: 100%;
    user-select: none;
    touch-action: none;
    background-color: #ccc;
    overscroll-behavior: none;
    -webkit-user-select: none; /* disable selection/Copy of UIWebView */
    -webkit-touch-callout: none; /* disable the IOS popup when long-press on a link */
  }
</style>