Vue.js image clipping components

vuejs-clipper

Vue.js image clipping components using Vue-Rx.

• Add image clipping components to your Vue application in nothing flat.
• Touch devices supported and fully responsive.

Version Released

• 0.2.7
  • fixed build scripts.
• 0.2.6
  • clipper-fixed has new prop: round.
  • clipper-upload will still emit input when uploading the same file.
  • update examples at the homepage.
• 0.2.5
  • Clipper-upload will call URL.revokeObjectURL to release memory.
  • Fixed clipper-range two way binding.
• 0.2.4
  • Fixed clipper-basic initial clip area size over the container.
  • Update readme (imgRatio).
• 0.2.3
  • update package.json
• 0.2.2
  • Fixed clipper-fixed bug: load event not call
• 0.2.1
  • new component clipper-upload
  • add error/load event to clipper-basic/clipper-fixed
  • correct and update readme
• 0.1.1
  • add license
  • use travis-ci build
  • delete some unused-vars
• 0.1.0
  • First Released

Notice

Before using the plugin & components, here's something you should know :

• It's based on vue-rx.
• Use vuejs-clipper plugin also add vue-rx plugin to vue.
• Components are responsive base on width instead of height.
• You can clip your own images (local uploaded images or images served on your site), but you cannot clip a cross-origin image.
• Components' input is an image URL, output is a canvas element, they only help you clip images to canvas, you need to handle other things like transform file input to image URL or transform output canvas to image by yourself.

Installation

NPM & ESM

install vuejs-clipper

$npm install vuejs-clipper --save

need sass-loader, if you haven't installed :

$npm install -D sass-loader node-sass

(1) use vuejs-clipper plugin

use vuejs-clipper plugin also add vue-rx plugin to Vue.

register all components to Vue global scope

import Vue from 'vue'
import VuejsClipper from 'vuejs-clipper'
// install
Vue.use(VuejsClipper)

register some components to global with default component name

Vue.use(VuejsClipper ,{
    components: {
        clipperBasic: true,
        clipperPreview: true
    }
})

with customized component name

Vue.use(VuejsClipper ,{
    components: {
        clipperBasic: 'image-clipper-basic',
        clipperPreview: 'my-preview'
    }
})

not register any components, but with some plugin options

Vue.use(VuejsClipper ,{
    parentPropName: 'myCustomerName',
    components: null
})

(2) separately import components

install vue-rx and it's peer dependency rxjs

$npm install --save vue-rx rx-js

use vue-rx

import Vue from 'vue'
import VueRx from 'vue-rx'
// install vue-rx
Vue.use(VueRx)

then import in your components (SFC)

import { clipperBasic, clipperPreview } from 'vuejs-clipper'

export default {
    components: {
      clipperBasic,
      clipperPreview
    }
}

Script

Include vuejs-clipper umd script after Vue.js.

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/vue.js"></script>
<script src="./dist/vuejs-clipper.umd.min.js"></script>
<link rel="stylesheet" href="./dist/vuejs-clipper.css">

Use in html/template

<clipper-basic src="example.jpg"></clipper-basic>

Components

See detail examples.

clipper-basic

a image clipping component

import { clipperBasic } from 'vuejs-clipper'

• Props

• Methods

set ref to use component methods

<clipper-basic ref="clipper"></clipper-basic>

in your Vue instance methods

const canvas = this.$refs.clipper.clip()

• Event

usage :

<clipper-basic @error="errorCb" @load="loadCb"></clipper-basic>

• Data

usage :

this.$refs.clipper.imgRatio

• Slot

<clipper-basic src="">
  <div slot="placeholder">No image</div>
</clipper-basic>

clipper-fixed

an image clipping component

import { clipperFixed } from 'vuejs-clipper'

• Props

• Method

• Event

• Data

• Slot

clipper-preview

preview clipping result

import { clipperPreview } from 'vuejs-clipper'

• Props

• Slot

clipper-range

a simple input range component

import { clipperPreview } from 'vuejs-clipper'

use v-model binding data with clipper-range

• Props

clipper-upload

a new component in 0.2.0

an upload button that transform image files to URL

import { clipperUpload } from 'vuejs-clipper'

use v-model binding data with clipper-upload

• Props

GitHub