Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guastallaigor/vue-image-kit
Vue.js Image Kit Component with Lazy Load built in and Responsive Images
https://github.com/guastallaigor/vue-image-kit
component image image-kit kit lazy-load lazy-load-img vue vuejs
Last synced: 4 months ago
JSON representation
Vue.js Image Kit Component with Lazy Load built in and Responsive Images
- Host: GitHub
- URL: https://github.com/guastallaigor/vue-image-kit
- Owner: guastallaigor
- License: mit
- Created: 2019-12-12T15:15:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T20:06:47.000Z (about 2 years ago)
- Last Synced: 2024-04-25T03:02:55.618Z (10 months ago)
- Topics: component, image, image-kit, kit, lazy-load, lazy-load-img, vue, vuejs
- Language: JavaScript
- Homepage: https://vue-image-kit.netlify.app
- Size: 2 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Vue Image Kit
Vue.js Image Kit Component with Lazy Load built in and Responsive Images
The inspiration comes from this and a talk from @derevandal in @femug
> **Note:**
> This is an unofficial project.
> I do not work or am I affiliated with Image Kit
## Demo
[](https://codesandbox.io/s/vue-image-kit-keeh1)
## Storybook
Go to https://vue-image-kit.netlify.app
## How does it work
This component uses the [Image Kit Real-time URL-based image transformation](https://imagekit.io/features/image-resize-smart-crop-responsive-dpr-client-hints), so you will need to have your images over [Image Kit](https://imagekit.io/) for it to work
For more informations about [Image Kit](https://imagekit.io/), consult their website
## How to install
### npm
```bash
$ npm install vue-image-kit --save
```
### yarn (recommended)
```bash
$ yarn add vue-image-kit
```
## Quick start
### Vue.js
You can import in your `main.js` file
```js
import Vue from "vue";
import VueImageKit from "vue-image-kit";
Vue.use(VueImageKit);
```
Or locally in any component
```js
import { VueImageKit } from "vue-image-kit";
// In v0.2+ you don't need the brackets above
export default {
components: {
VueImageKit,
},
};
```
### Nuxt.js
You can import as a Nuxt.js plugin
`~/plugins/vue-image-kit.js`
```js
import Vue from "vue";
import VueImageKit from "vue-image-kit";
Vue.use(VueImageKit);
```
and then import it in your `nuxt.config.js` file
```js
plugins: [{ src: "~/plugins/vue-image-kit", mode: "client" }];
```
## Basic usage
```html
```
## Props
| Property name | Type | Default | Required | Description |
| --------------- | ------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hash | String | null | true | Images hash. Example: Take this image -> https://ik.imagekit.io/6xhf1gnexgdgk/lion_BllLvaqVn.jpg, the hash is '6xhf1gnexgdgk' |
| src | String | null | true | Images source. Example: Take this image -> https://ik.imagekit.io/6xhf1gnexgdgk/lion_BllLvaqVn.jpg, the source is 'lion_BllLvaqVn.jpg' |
| placeholder | String | '' | false | Images placeholder. Here you can pass a link |
| backgroundColor | String | '' | false | Background color of the images placeholder |
| srcset | Array | [320, 480, 800] | false | Array of numbers that will define the images srcset attribute. Each number correspond to one of the images width |
| sizes | Array | [] | false | Array of numbers that will define the images sizes attribute. Each number correspond to one of the images max-width. Empty by default, which gets each of the images srcset prop |
| defaultSize | Number | 1080 | true | Images default size. Must be larger than the largest srcset and sizes |
| customTransform | String | '' | false | Use this to append any extra image kit transform that you want |
| width | Number | null | false | Images width. Width number in pixels. It will be set with inline style |
| height | Number | null | false | Images height. Height number in pixels. It will be set with inline style |
| alt | String | '' | false | Images alt attribute |
| lazyLoad | Boolean | true | false | If you don't want to use the built in lazy load, you can set this to false, then the image will not be lazy loaded, and you can setup your own lazy load |
## Development
[](https://github.com/guastallaigor/vue-image-kit/issues)
> **Note**: Contributions are very welcomed, however is very important to open a new issue using the issue template **before** you start working on anything, so we can discuss it before hand
Fork the project and enter this commands in your terminal
```sh
git clone https://github.com/YOUR_GITHUB_USERNAME/vue-image-kit.git
cd vue-image-kit
yarn
```
### Storybook
For visual testing, this project contains storybook which you can run by doing the next command
```sh
$ yarn storybook
```
### Jest
Before making the PR, if you changed something that needs to be tested, please make the tests inside the `tests/unit` folder
To run the tests, you can use the next command
```sh
$ yarn test:unit
```
### Commitlint
This project follows the [commitlint](https://github.com/conventional-changelog/commitlint) guidelines, with minor changes
You can commit using `npm run commit` to help you with that
There's a `pre-push` hook that runs all the unit tests before you can push it
If an error occurs, you can use the `npm run commit:retry` command that runs the previous `npm run commit` that you already filled
[](https://ko-fi.com/C1C63QCB8)
## License
MIT © [guastallaigor](https://github.com/guastallaigor/vue-image-kit/blob/master/LICENSE)