@teamnovu/vue-cloudinary-image
Vue-Cloudinary-Image
Responsive image component
Uses the image attributes srcSet and sizes to responsively display an an image from cloudinary.
Generates srcSet with a placeholder for lazyloading based on screen sizes passed in options and adjusts the sizes attribute depending on the screen size.
Installation
// yarn
yarn add @teamnovu/vue-cloudinary-image
// npm
npm i @teamnovu/vue-cloudinary-image
For vue2 use a version < v3.0.0
Setup
import CloudinaryImage from '@teamnovu/vue-cloudinary-image'
Vue.use(CloudinaryImage, {
cloudinaryBaseUrl: "https://res.cloudinary.com/<your-cloud-name>/image/upload/",
});
Usage
<CloudinaryImage src="/assets/image.jpg" />
Plugin Options
| Option | Default | Required | Type | Comment |
|---|---|---|---|---|
| cloudinaryBaseUrl | null | true | String | |
| screenSizes | default screen sizes | false | Object | |
| placeholderTransformation | null | false | String | Named Transformation used for the placeholder transformation |
Attributes
| Attribute | Default | Required | Type | Description |
|---|---|---|---|---|
| src | null | true | String | Relative path to image from cloudinaryAssetUrl |
| quality | 85 | false | Number | Cloudinary Option |
| blur | null | false | Number | Cloudinary Option |
| crop | null | false | String | Cloudinary Option |
| format | 'auto' | false | String | Cloudinary Option |
| fallbackWidth | null | false | Number | If srcSet and sizes are not supported in the clients browser, this will be the fixed width of the image itself (not css width) |
| aspectRatio | null | false | Number | If you set this attribute the component will ignore the placeholderDataUrl attribute and load the placeholder image from cloudinary because the aspect ratio would change between placeholder and the real image |
| placeholderDataUrl | null | false | String | If this attribute is set all other placeholder options are ignored and this url is used as the placeholder source |
| placeholderQuality | 30 | false | Number | Cloudinary Option |
| placeholderWidth | 300 | false | Number | Cloudinary Option |
| usePlaceholder | true | false | Boolean | If this attribute is set to false, no placeholder will be displayed and the original image will be rendered immediately |
| zoom | undefined | false | String, Number | Zoom level |
| sizes | undefined | false | String | Fixed sizes attribute for img tag |
| transforms | undefined | false | String, Object | Additional, raw transformations |
| loading | 'lazy' | false | String | Image loading property. Use loading="eager" to load the image immediately |
Example
<CloudinaryImage
src="/assets/image.jpg"
/>
Related Packages
@teamnovu/vue-cloudinary-image-statamic
Statamic Adapter for @teamnovu/vue-cloudinary-image and @teamnovu/nuxt-cloudinar...
4,843
0
@teamnovu/nuxt-image-module
Responsive image module for Nuxt 4 with provider-agnostic focal-point handling a...
1,124
Version History
| Version | Released | License |
|---|---|---|
| 4.0.1 | MIT | |
| 4.0.0 | MIT | |
| 3.0.4 | MIT | |
| 3.0.3 | MIT | |
| 3.0.2 | MIT | |
| 3.0.1 | MIT | |
| 3.0.0 | MIT | |
| 2.0.2 | MIT | |
| 2.0.1 | MIT | |
| 2.0.0 | MIT | |
| 1.1.1 | MIT | |
| 1.1.0 | MIT | |
| 1.0.1 | MIT | |
| 1.0.0 | MIT | |
| 0.0.17 | MIT | |
| 0.0.16 | MIT | |
| 0.0.15 | MIT | |
| 0.0.14 | MIT | |
| 0.0.13 | MIT | |
| 0.0.12 | MIT | |
| 0.0.11 | MIT | |
| 0.0.10 | MIT | |
| 0.0.9 | MIT | |
| 0.0.8 | MIT | |
| 0.0.7 | MIT | |
| 0.0.6 | MIT | |
| 0.0.5 | MIT | |
| 0.0.4 | MIT | |
| 0.0.3 |
Pre-releases (6)
| Version | Released | License |
|---|---|---|
| 5.0.0-beta.1 | MIT | |
| 3.0.2-dev.5 | MIT | |
| 3.0.2-dev.4 | MIT | |
| 3.0.2-dev.3 | MIT | |
| 3.0.2-dev.2 | MIT | |
| 3.0.2-dev.1 | MIT |