vue-3-fullscreen-image-directive-plugin

Vue 3 Fullscreen Image Directive Plugin

A lightweight Vue.js plugin for creating a fullscreen image modal with customizable options.

Installation

Install the package using npm:

npm install vue-3-fullscreen-image-directive-plugin
yarn add vue-3-fullscreen-image-directive-plugin

Usage

Register the Plugin

import { createApp } from 'vue'
import App from './App.vue'
import { fullscreenImagePlugin } from './fullscreen-image-plugin'

createApp(App).use(fullscreenImagePlugin).mount('#app')

Use the Directive

Add the v-fullscreen-image directive to any element you want to trigger the fullscreen image modal on click.

<template>
  <img v-fullscreen-image="{
    imageUrl: 'https://placehold.co/2000x4000',
    withDownload: false,
    animation: 'blur'
  }"
  src="https://placehold.co/200x400"
  />
</template>

Directive Options

Name	Type	Description
imageUrl	(string, required)	The URL of the image to display
animation	(string, optional, default: 'fade')	Animation type ('fade', 'blur', 'none').
imageAlt	(string, optional)	Alt text for the image.
withDownload	(boolean, optional, default: true)	Show the download button.
withClose	(boolean, optional, default: true)	Show the close button.
withFocusOnClose	(boolean, optional, default: true)	Automatically focus on the close button when the modal opens.
withCloseOnEscape	(boolean, optional, default: true)	Close the modal when the 'Escape' key is pressed.
closeOnClickOutside	(boolean, optional, default: true)	Close the modal when clicking outside the image.
maxHeight	(string, optional, default: '80vh')	Maximum height of the image container.
maxWidth	(string, optional, default: '80vw')	Maximum width of the image container.