https://github.com/thaycacac/vue-image-effect

💃A simple, highly customisable image effect component for Vue💃
https://github.com/thaycacac/vue-image-effect

image-effect image-effect-component vue vue-component vuejs

Last synced: about 6 hours ago
JSON representation

💃A simple, highly customisable image effect component for Vue💃

• Host: GitHub
• URL: https://github.com/thaycacac/vue-image-effect
• Owner: thaycacac
• Created: 2019-04-26T08:28:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-10T23:02:32.000Z (over 1 year ago)
• Last Synced: 2024-11-03T16:32:32.466Z (15 days ago)
• Topics: image-effect, image-effect-component, vue, vue-component, vuejs
• Language: Vue
• Homepage: https://vue-image-effect.netlify.com/
• Size: 729 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Image Effect Component

[![npm](https://img.shields.io/npm/dt/vue-image-effect.svg)](https://github.com/thaycacac/vue-image-effect)

[![Netlify Status](https://api.netlify.com/api/v1/badges/000b0d34-355b-44f4-8218-b762ca9233bf/deploy-status)](https://app.netlify.com/sites/vue-image-effect/deploys)

A simple, highly customisable image effect component for Vue.

## Screenshot

![star-rating.png](https://i.imgur.com/34qoigg.png)

## Features

- Customisable image.

- Customisable size image.

- Create and customisablee description image.

- Good SEO for image

## Usage

### Via NPM

Install via npm:

```sh

npm install vue-image-effect

```

Then require in your project:

```js

const VueImage = require('vue-image-effect')

```

or ES6 syntax:

```js

import VueImage from 'vue-image-effect'

```

Then you can register the component globally:

```js

Vue.component('vue-image-effect', VueImage)

```

Or in your `Vue component`:

```js

components: {

  VueImage

}

```

You can then use the following markup in your project:

```html

```

### Via CDN

You may also include `vue-image-effect` directly in to your webpage via Unpkg. Simply add the following script tag:

```html

```

You will need to register the component by doing:

```js

Vue.component('vue-image', VueImageEffect.default)

```

You may also register the component locally via the [components option](https://vuejs.org/v2/guide/components.html#Local-Registration).

## Development & Testing

Please check the [Contributing Guidelines](https://github.com/youngtailors/league-paradox/blob/master/CONTRIBUTING.md).

## Contribution

Issues and PRs are welcome !