https://github.com/captaincodeman/svelte-pan-zoom

Pan and Zoom for Svelte
https://github.com/captaincodeman/svelte-pan-zoom

gesture pan svelte touch zoom

Last synced: 3 months ago
JSON representation

Pan and Zoom for Svelte

• Host: GitHub
• URL: https://github.com/captaincodeman/svelte-pan-zoom
• Owner: CaptainCodeman
• Created: 2022-10-26T14:28:27.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T15:26:33.000Z (4 months ago)
• Last Synced: 2024-11-01T02:06:21.949Z (3 months ago)
• Topics: gesture, pan, svelte, touch, zoom
• Language: TypeScript
• Homepage: https://captaincodeman.github.io/svelte-pan-zoom/
• Size: 1.85 MB
• Stars: 18
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# svelte-pan-zoom

![minified](https://img.shields.io/bundlephobia/min/svelte-pan-zoom/0.0.11?style=for-the-badge)

![minified + zipped](https://img.shields.io/bundlephobia/minzip/svelte-pan-zoom/0.0.11?style=for-the-badge)

Canvas Pan and Zoom action for Svelte

[See Demo](https://captaincodeman.github.io/svelte-pan-zoom/)

[Multiple Instances](https://captaincodeman.github.io/svelte-pan-zoom/multi)

## 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`](https://www.npmjs.com/package/svelte-disable-preload) is applied to the canvas automatically, for smoother animations when used with SvelteKit.

## Example

```svelte

  import { panzoom, type Options } from 'svelte-pan-zoom'

  export let image: CanvasImageSource

  function render(ctx: CanvasRenderingContext2D, t: number) {

    ctx.drawImage(image, 0, 0)

  }

{#await promise then options}

  

{/await}

  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 */

  }

```