vue-resized-image

A Vue JS component that dynamically resizes, crops, and displays images

Table of contents

• Installation
• Usage
• Example

Installation

npm install --save vue-resized-image

Default import

import Vue from 'vue'
import { VueResizedImage } from 'vue-resized-image'

Vue.component('resized-image', VueResizedImage)

Distribution import

import { VueResizedImage } from 'vue-resized-image/dist/vue-resized-image.common'

Vue.component('resized-image', VueResizedImage)

Browser

<script src="vue.js"></script>
<script src="vue-resized-image/dist/vue-resized-image.browser.js"></script>

The plugin should be auto-installed. If not, you can install it manually with the instructions below.

Install all the components:

Vue.use(VueResizedImage)

Source import

Install all the components:

import Vue from 'vue'
import VueResizedImage from 'vue-resized-image/src'

Vue.use(VueResizedImage)

⚠️ You need to configure your bundler to compile .vue files. More info in the official documentation.

Usage

This component wraps an img tag to display an image dynamically resized in the browser making use of the canvas API. The width and height of the resized image can be defined. If the crop option is set to true the image is automatically centered within the defined dimensions and the original image aspect ratio is retained.

Example

In app.js

import { VueResizedImage } 'vue-resized-image';
Vue.component('resized-image', VueResizedImage);

Use in another component:

<template>
	<div id="single">
		<h1 v-html="title"></h1>
				<figure>
	                <resized-image :crop="true" :width="800" :height="400" :src="featured_image" :alt="title"/>
	            </figure>
	            <article v-html="content"></article>
			</div>
		</div>
	</div>
</template>

Plugin Development

Installation

The first time you create or clone your plugin, you need to install the default dependencies:

npm install

Watch and compile

This will run webpack in watching mode and output the compiled files in the dist folder.

npm run dev

Use it in another project

While developping, you can follow the install instructions of your plugin and link it into the project that uses it.

In the plugin folder:

npm link

In the other project folder:

npm link vue-resized-image

This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.

Manual build

This will build the plugin into the dist folder in production mode.

npm run build

License

MIT