@aw-studio/vue-lit-image-next
TypeScript icon, indicating that this package has built-in type declarations

1.1.5 • Public • Published

vue-lit-image

what is this?

This version of the vue-lit-image was specifically written to support Vue 3 applications. If you're running Vue 2 you should check out https://github.com/aw-studio/vue-lit-image.

For normal websites built with blade in Laravel we already have the <x-lit-image /> as a component to handle all the annoying tasks for images like lazyloading but what if you have the same imageobjects in a vue application and want to use the same magic there? The vue-lit-image has you covered, it also takes the media object in the image property and does all the lazyloading, dynamic image sizing and it even sets the alt and title attributes for you.

installation

npm install @aw-studio/vue-lit-image-next

usage

In your app.js require the package and use the component. When using the component you have to specify the conversions according to your settings in the lit.php config file:

import { createApp } from 'vue';
import Test from './components/Test.vue';

import LitImage from '@aw-studio/vue-lit-image-next';

const app = createApp({
    components: {
        Test,
    },
});

app.use(LitImage, {
    conversions: {
        sm: 300,
        md: 500,
        lg: 900,
        xl: 1400,
    },
});

app.mount('#app');

Inside your Vue files when you want to use the vue-lit-image, you want to give the prop image the media object just like the blade component would:

<lit-image :image="image" />

You can also style it using the classes prop:

<lit-image :image="image" classes="w-full" />

Readme

Keywords

none

Package Sidebar

Install

npm i @aw-studio/vue-lit-image-next

Weekly Downloads

2

Version

1.1.5

License

ISC

Unpacked Size

26.9 kB

Total Files

14

Last publish

Collaborators

  • chrissle
  • jannescb