# @tranxuanthang/vue-progressive-img

> ** This is branch and documentation for vue 2. Visit the [main](https://github.com/sun-asterisk-research/vue-progressive-img/tree/legacy) branch for vue 3.**

Latest version **1.0.0-alpha.5** (published 2022-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tranxuanthang/vue-progressive-img
pnpm add @tranxuanthang/vue-progressive-img
yarn add @tranxuanthang/vue-progressive-img
bun add @tranxuanthang/vue-progressive-img
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.5 |
| Published | 2022-01-20 |
| First published | 2021-11-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tranxuanthang |

## Links

- npm: https://www.npmjs.com/package/@tranxuanthang/vue-progressive-img
- npm.io page: https://npm.io/package/@tranxuanthang/vue-progressive-img

## Recent versions

- 1.0.0-alpha.5 (latest) — 2022-01-20
- 1.0.0-alpha.3 (legacy) — 2022-01-10
- 1.0.0-alpha.4 — 2022-01-14
- 1.0.0-alpha.2 — 2022-01-10
- 1.0.0-alpha.1 — 2022-01-10
- 2.0.0-alpha.1 — 2022-01-10
- 0.0.1 — 2021-11-23

## README

# vue-progressive-img

** This is branch and documentation for vue 2. Visit the [main](https://github.com/sun-asterisk-research/vue-progressive-img/tree/legacy) branch for vue 3.**

![Peek 2021-11-23 00-06](https://user-images.githubusercontent.com/15942946/142904401-28c22329-2e7f-45f8-9655-307f0aef4be2.gif)

Progressive Image Loading plugin for Vue 3

## Example/Demo
- https://github.com/tranxuanthang/cat-pics-pil
- https://awesome-shirley-c6c0a7.netlify.app/

## Installation
Install the package:


```shell
# npm
npm install --save vue-progressive-img

# yarn
yarn add vue-progressive-img
```

Initialize the plugin:

```diff
  import Vue from 'vue'
  import App from './App.vue'
+ import { ProgressiveImgPlugin } from 'vue-progressive-img'
+ import 'vue-progressive-img/src/styles.css'

+ Vue.use(ProgressiveImgPlugin)

  new Vue({
    render: function (h) { return h(App) }
  }).$mount('#app')
```

## Usage

Use `ProgressiveImg` component:

```vue
<template>
  <progressive-img
    tiny-src="60px-width-image.jpg"
    src="full-image.jpg"
    width="1280"
    height="720"
    alt="Image description"
    ...
  />
</template>
```

Or use directive:
```vue
<template>
  <span class="block flex justify-center mb-6 mx-auto max-h-[50vh]"
    v-for="(image, index) in images"
    :key="index"
  >
    <img
      :data-tiny-src="image.tinyUrl"
      :data-full-src="image.fullUrl"
      :width="image.width"
      :height="image.height"
      :alt="image.description"
    />
  </span>
</template>
```

---
_Source: https://npm.io/package/@tranxuanthang/vue-progressive-img · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._