@egjs/vue2-imready

I'm Vue2 Ready

I'm Vue2 Ready to check if the images or videos are loaded!

Demo / API

⚠️ If you're looking for ImReady for Vue 3, check out @egjs/vue-imready

Features

Check that all images and videos in the container are loaded.
If you know the size of the image or video in advance, you can skip loading and adjust the width and height automatically until the actual loading is completed.
Support Native Lazy Loading.

Documents

Download and Installation

Download dist files from repo directly or install it via npm.

$ npm install @egjs/vue2-imready

How to use

import Vue from "vue";
import VueCompositionAPI from '@vue/composition-api';

// @vue/composition-api is required to use vue2-imready.
Vue.use(VueCompositionAPI);

import {
    useImReady,
    useReady,
    useReadyElement,
    usePreReady,
    usePreReadyElement,
} from "@egjs/vue2-imready";

Use readyElement (useReadyElement: true, useReady: true, useError: true)

<template>
    <div v-bind:ref="container">
        <h2>{{im.isReady ? "I'm Ready" : "Loading..."}}</h2>
        <h2>{{im.readyCount}}/{{im.totalCount}}</h2>
        <img src=".." />
        <img src=".." />
        <img src=".." />
    </div>
</template>
<script>
import { useReadyElement } from "@egjs/vue2-imready";

export default {
    setup() {
        const im = useReadyElement({
            selector: "img",
        });
        return {
            im,
            // same ref name
            container: im.register(),
        };
    }
}
</script>

Use ready (useReady: true)

<template>
    <div v-bind:ref="container">
        <h2>{{im.isReady ? "I'm Ready" : "Loading..."}}</h2>
        <img src=".." />
        <img src=".." />
        <img src=".." />
    </div>
</template>
<script>
import { useReady } from "@egjs/vue2-imready";

export default {
    setup() {
        const im = useReady({
            selector: "img",
        });
        return {
            im,
            // same ref name
            container: im.register(),
        };
    }
}
</script>

Use preReadyElement (usePreReadyElement: true, usePreReady: true)

<template>
    <div v-bind:ref="container">
        <h2>{{im.isPreReady ? "I'm PreReady" : "Loading..."}}</h2>
        <h2>{{im.preReadyCount}}/{{im.totalCount}}</h2>
        <img src=".." />
        <img src=".." />
        <img src=".." />
    </div>
</template>
<script>
import { usePreReadyElement } from "@egjs/vue2-imready";

export default {
    setup() {
        const im = usePreReadyElement({
            selector: "img",
        });
        return {
            // same ref name
            container: im.register(),
        }
    }
}
</script>

Use preReady (usePreReady: true)

<template>
    <div v-bind:ref="container">
        <h2>{{im.isPreReady ? "I'm PreReady" : "Loading..."}}</h2>
        <img src=".." />
        <img src=".." />
        <img src=".." />
    </div>
</template>
<script>
import { usePreReady } from "@egjs/vue2-imready";

export default {
    setup() {
        const im = usePreReady({
            selector: "img",
        });
        return {
            im,
        }
    }
}
</script>

Use useImReady (*: true)

<template>
    <div v-bind:ref="container">
        <h2>{{im.isReady ? "I'm Ready" : "Loading..."}}</h2>
        <h2>{{im.readyCount}}/{{im.totalCount}}</h2>
        <h2>{{im.isPreReady ? "I'm PreReady" : "Loading..."}}</h2>
        <h2>{{im.preReadyCount}}/{{im.totalCount}}</h2>
        <img src=".." />
        <img src=".." />
        <img src=".." />
    </div>
</template>
<script>
import { useImReady } from "@egjs/vue2-imready";

export default {
    setup() {
        const im = useImReady({
            selector: "img",
        });
        return {
            // same ref name
            container: im.register(),
        };
    }
}
</script>

If you use data-width and data-height attributes, the size of self, child image, and video elements is automatically adjusted until loading is complete.

<div data-width="100" data-height="100">
   <img src="..." />
   <img src="..." />
   <img src="..." />
</div>

If you use data-skip="ture" attribute, you can omit it even if there are images in itself and child image, and video elements.

<div data-skip="true">
   <img src="..." />
   <img src="..." />
   <img src="..." />
</div>

Events

preReadyElement: An event occurs when the element is pre-ready (when the size is known)
preReady: An event occurs when all element are pre-ready (when the size is known)
readyElement: An event occurs when all element are ready
ready: An event occurs when all element are ready

Sequence of events

If there is no data size attribute or loading attribute

(preReadyElement => readyElement) x N => preReady => ready

If there is a data size attribute or a loading attribute

preReadyElement * N => (preReadyElement => readyElement) x M => preReady => readyElement(isPreReadyOver: true) x N => ready

How to start developing egjs-imready?

For anyone interested to develop egjs-imready, follow the instructions below.

Development Environment

1. Clone the repository

Clone the egjs-imready repository and install the dependency modules.

# Clone the repository.
$ git clone https://github.com/naver/egjs-imready.git
$ cd egjs-imready/packages/vue2-imready

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Bug Report

If you find a bug, please report to us opening a new Issues on GitHub.

License

egjs-imready is released under the MIT license.

Copyright (c) 2020-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.