npm

Need private packages and team management tools?Check out npm Orgs. »

vue-svg-pan-zoom

1.1.0 • Public • Published

vue-svg-pan-zoom : Vue component for SVG-Pan-Zoom

This module is a very simple Vue component providing the goodness of SVG-Pan-Zoom for SVG elements.

/!\ WARNING: the module is young, basic, probably will have its API change with no notice, and likely to have bugs. Use at your own risk, send patches for my eternal gratitude.

Basic Use

In a Single File Component:

<template>
    <SvgPanZoom 
        style="width: 500px; height: 500px; border:1px solid black;"
        :zoomEnabled="true"
        :controlIconsEnabled="true"
        :fit="false"
        :center="true"
    >
        <svg>
            <circle x="10" y="10" r="5" />
        </svg>
    </SvgPanZoom>`
</template>

<script>
    import SvgPanZoom from 'vue-svg-pan-zoom';

    export default {
        components: {  SvgPanZoom },
    };
</script>

Notes

Currently the SvgPanZoom component only works with a svg child -- embed won't work.

Props

SvgPanZoom accepts as props all svg-pan-zoom options:

| attribute                 | default                |
| ---------                 | --------               |
| zoomEnabled               | true                   |
| controlIconsEnabled       | false                  |
| fit                       | true                   |
| panEnabled                | true                   |
| dblClickZoomEnabled       | true                   |
| mouseWheelZoomEnabled     | true                   |
| preventMouseEventsDefault | true                   |
| contain                   | false                  |
| center                    | true                   |
| viewportSelector          | .svg-pan-zoom_viewport |
| zoomScaleSensitivity      | 0.2                    |
| minZoom                   | 0.5                    |
| maxZoom                   | 10                     |
| refreshRate               | auto                   |
| beforeZoom                |                        |
| onZoom                    |                        |
| beforePan                 |                        |
| onPan                     |                        |
| onUpdatedCTM              |                        |
| customEventsHandler       |                        |
| eventsListenerElement     |                        |

svgpanzoom object

To access the created svgpanzoom javascript object, you can listen to the svgpanzoom event on the SvgPanZoom component.

<template>
    <div>
        <input type="button" value="center me" @click="center" />
        <SvgPanZoom style="width: 500px; height: 500px; border:1px solid black;"
            :fit="false"
            @svgpanzoom="registerSvgPanZoom"
        >
            <RawTiger />
        </SvgPanZoom>
    </div>
</template>
 
<script>
import RawTiger from './RawTiger.vue';
import SvgPanZoom from 'vue-svg-pan-zoom';
 
export default {
    components: {  SvgPanZoom, RawTiger },
    data: () => ({ svgpanzoom: null }),
    methods: {
        registerSvgPanZoom(svgpanzoom) {
            this.svgpanzoom = svgpanzoom;
        },
        center() {
            if( !this.svgpanzoom ) return;
 
            this.svgpanzoom.center();
        }
    },
}
</script>

Use with thumbnails

In a Single File Component:

<template>
    <SvgPanZoom
        style="width: 300px; height: 500px; border:1px solid black; "
    >
        <svg> ... </svg>
        <svg slot="thumbnail"> ...  </svg>
    </SvgPanZoom>
</template>

<script>
    import SvgPanZoom from 'vue-svg-pan-zoom';

    export default {
        components: { SvgPanZoom },
    };

</script>

Just like the main SvgPanZoomcomponent, the thumbnail slot needs to be assigned to a svg node -- embed won't work.

Storybook demos

To run Storybook stories duplicating the demos of the main SVG-Pan-Zoom project, do

$ yarn install --dev
$ yarn storybook

Keywords

install

npm i vue-svg-pan-zoom

Downloadsweekly downloads

359

version

1.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability