medium-zoom

Integrate medium-zoom into VuePress, which can provide the ability to zoom images.

This plugin has been integrated into the default theme.

Usage

npm i -D @vuepress/plugin-medium-zoom@next

import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'

export default {
  plugins: [
    mediumZoomPlugin({
      // options
    }),
  ],
}

Options

selector

• Type: string

• Default: '[vp-content] > img, [vp-content] :not(a) > img'

• Details:

  Selector of zoomable images.

  By default this plugin will make all images zoomable except those inside <a> tags.

delay

• Type: number

• Default: 500

• Details:

  Delay in milliseconds.

  After navigating to a new page, this plugin will make images zoomable with a delay.

zoomOptions

• Type: Object

• Details:

  Options for medium-zoom.

• Also see:

  • medium-zoom > Options

Styles

You can customize most of the zoom styles via zoomOptions, while this plugin also provides some CSS variables for additional customization:

:root {
  --medium-zoom-z-index: 100;
  --medium-zoom-c-bg: var(--vp-c-bg-elv, #fff);
  --medium-zoom-opacity: 1;
}

Composition API

useMediumZoom

• Details:

  Returns the Zoom instance that used by this plugin, so that you can use the instance methods directly.

  This plugin will make images zoomable after navigating to current page. But if you are going to add new images dynamically, you may need this method to make those new images zoomable, too.

  This plugin adds an extra refresh method on the Zoom instance, which will call zoom.detach() then zoom.attach() with the selector as the default parameter. It will help you to refresh the zoomable images for current page.

• Example:

import { useMediumZoom } from '@vuepress/plugin-medium-zoom/client'
import { nextTick } from 'vue'

export default {
  setup(): void {
    const zoom = useMediumZoom()

    // ... do something to add new images in current page

    // then you may need to call `refresh` manually to make those new images zoomable
    nextTick(() => {
      zoom.refresh()
    })
  },
}