@egjs/vue-imready

<p align="middle" ><img src="https://github.com/naver/egjs-imready/raw/main/demo/images/logo.png"/></p> <h2 align="middle">I'm Vue Ready</h2> <p align="middle"> <a href="https://www.npmjs.com/package/@egjs/vue-imready" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/vue-imready.svg?style=flat-square&color=007acc&label=version" alt="npm version" /></a> <img src="https://img.shields.io/badge/language-typescript-blue.svg?style=flat-square"/> <a href="https://github.com/naver/egjs-imready/actions/workflows/run-unit.yml" target="_blank"><img alt="Run tests" src="https://github.com/naver/egjs-imready/actions/workflows/run-unit.yml/badge.svg" /></a> <a href="https://github.com/naver/egjs-imready/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/naver/egjs-imready.svg?style=flat-square&label=license&color=08CE5D"/></a> <a href="https://github.com/naver/egjs-imready/tree/main/packages/vue-imready" target="_blank"><img alt="Vue" src="https://img.shields.io/static/v1.svg?label=&message=Vue&style=flat-square&color=61daeb"></a> </p> <p align="middle">I'm Vue Ready to check if the images or videos are loaded!</p> <p align="middle"> <a href="https://naver.github.io/egjs-imready" target="_blank"><strong>Demo</strong></a> / <a href="https://naver.github.io/egjs-imready/release/latest/doc/" target="_blank"><strong>API</strong></a> </p> <p align=center> ⚠️ If you're looking for ImReady for Vue 2, check out <a href="https://github.com/naver/egjs-imready/blob/master/packages/vue2-imready/README.md">@egjs/vue2-imready</a> </p> ## 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 - [Get Started and Demos](https://naver.github.io/egjs-imready/) - [API documentation](https://naver.github.io/egjs-imready/release/latest/doc/) ## Download and Installation Download dist files from repo directly or install it via npm. ```bash $ npm install @egjs/vue-imready ``` ## How to use ```tsx import { useImReady, useReady, useReadyElement, usePreReady, usePreReadyElement, } from "@egjs/vue-imready"; ``` * Use readyElement (useReadyElement: true, useReady: true, useError: true) ```html <template> <div v-bind:ref="im.register()"> <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/vue-imready"; export default { setup() { const im = useReadyElement({ selector: "img", }); return { im, } } } </script> ``` * Use ready (useReady: true) ```html <template> <div v-bind:ref="im.register()"> <h2>{{im.isReady ? "I'm Ready" : "Loading..."}}</h2> <img src=".." /> <img src=".." /> <img src=".." /> </div> </template> <script> import { useReady } from "@egjs/vue-imready"; export default { setup() { const im = useReady({ selector: "img", }); return { im, } } } </script> ``` * Use preReadyElement (usePreReadyElement: true, usePreReady: true) ```html <template> <div v-bind:ref="im.register()"> <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/vue-imready"; export default { setup() { const im = usePreReadyElement({ selector: "img", }); return { im, } } } </script> ``` * Use preReady (usePreReady: true) ```html <template> <div v-bind:ref="im.register()"> <h2>{{im.isPreReady ? "I'm PreReady" : "Loading..."}}</h2> <img src=".." /> <img src=".." /> <img src=".." /> </div> </template> <script> import { usePreReady } from "@egjs/vue-imready"; export default { setup() { const im = usePreReady({ selector: "img", }); return { im, } } } </script> ``` * Use useImReady (*: true) ```html <template> <div v-bind:ref="im.register()"> <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/vue-imready"; export default { setup() { const im = useImReady({ selector: "img", }); return { im, } } } </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. ```html <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. ```html <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. ```bash # Clone the repository. $ git clone https://github.com/naver/egjs-imready.git $ cd egjs-imready/packages/vue-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](https://github.com/naver/egjs-imready/issues) on GitHub. ## License egjs-imready is released under the [MIT license](http://naver.github.io/egjs/license.txt). ``` 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. ```  [badge-version]: https://img.shields.io/npm/v/@egjs/vue-imready.svg?style=flat [badge-build-status]: https://travis-ci.org/naver/egjs-imready.svg?branch=main [badge-coverage]: https://coveralls.io/repos/github/naver/egjs-imready/badge.svg?branch=main [badge-gk]: https://badges.greenkeeper.io/naver/egjs-imready.svg  [link-version]: https://www.npmjs.com/package/@egjs/vue-imready [link-build-status]: https://travis-ci.org/naver/egjs-imready [link-coverage]: https://coveralls.io/github/naver/egjs-imready?branch=main [link-gk]: https://greenkeeper.io/