vue-image-viewer-mz
TypeScript icon, indicating that this package has built-in type declarations

1.0.12 • Public • Published

vue-image-viewer 🎉

live demo

brief intro

A image viewer for both vue2 and vue3 using medium-zoom

install

yarn add vue-image-viewer-mz
# or
npm i vue-image-viewer-mz

usage

main.ts

// entry point of your vue app
import { createApp } from "vue";
import App from "./App.vue";
import {
  createPlugin as createVueImageViewerPlugin,
  VueImageViewerPluginOptions
} from "vue-image-viewer-mz";

const options: VueImageViewerPluginOptions = {
  directiveName: "viewer"
};

createApp(App).use(createVueImageViewerPlugin(options)).mount("#app");

or in component directive

<template>
  <img v-viewer-in-component src="fake src" alt="fake name" />
</template>

<script>
  import { createDirective as createVueImageViewerDirective } from "vue-image-viewer-mz";
  import { defineComponent } from "vue";

  export default defineComponent({
    directives: {
      "viewer-in-component": createVueImageViewerDirective()
    }
  });
</script>

App.vue

<img v-viewer src="fake src" alt="fake name" />
<!-- or -->
<div v-viewer>
  <img src="fake src" alt="fake name" />
  <img src="fake src" alt="fake name" />
</div>

Composition API

Only works when you use as a plugin in your main.ts

useMediumZoom

import { nextTick } from "vue";
import { useMediumZoom } from "vue-image-viewer-mz";

export default {
  setup() {
    // ... do something to add new images in current page
    const zoom = useMediumZoom();
    // you can get the zoom instance here
  }
};

Package Sidebar

Install

npm i vue-image-viewer-mz

Weekly Downloads

0

Version

1.0.12

License

none

Unpacked Size

156 kB

Total Files

9

Last publish

Collaborators

  • guygubaby