You can find our latest examples at https://github.com/imgly/pesdk-web-examples.

PhotoEditor SDK Vue.js wrapper

PhotoEditor SDK is a product of img.ly GmbH. In order to use PhotoEditor SDK inside one of your products, you will need a valid a license.

yarn add vue-pesdk photoeditorsdk react react-dom styled-components or npm i -D vue-pesdk photoeditorsdk react react-dom styled-components

react, react-dom and styled-components are peerDependencies and are needed to render the PhotoEditorSDK UI. In addition you need the PhotoEditor SDK assets. You can either get them here or copy it from your node_modules into your public asset folder. And set the assetBaseUrl prop to this folder.

cp -r node_modules/photoeditorsdk/assets/ ~/projects/your-project/public/assets

If needed, take a look at the official documentation for further information.

Import the PhotoEditor SDK css styles and the vue-sdk component.

<template> <PhotoEditor asset-path="/static" license='{"owner": ...}' image-path="/static/example.jpg" /> </template> <script> import PhotoEditor from 'vue-pesdk'; export default { components: { PhotoEditor } }; </script>

The idea behind this wrapper is to simplify the usage of the PhotoEditor SDK inside Vue. We try to minimize the configuration and maximize the possibilities. Because of that you have only 3 important and required props, license, imagePath and assetPath to get the editor running.

However, you have to either download or copy the PhotoEditor SDK assets to your public asset folder. You can either get them here or copy them from your node_modules.

If you need more configuration possibilities, you can pass all the mentioned options to the options prop.

Furthermore, the editor instance is saved as a Vue Instance Property so you can access the editor instance inside your parent component with this.$pesdk after the editor is mounted.

<template> <PhotoEditor :license="$options.license", asset-path="/assets" image-path="/assets/example.jpg" /> </template> <script> import PhotoEditor from 'vue-pesdk' import PesdkLicense from './myLicense.json' export default { components: { PhotoEditor }, license: JSON.stringify(PesdkLicense) }

You can listen to various events in the PhotoEditorSdk You can simply attach an .on() event to the editor instance.

<template> <PhotoEditor :license="$options.license" asset-path="/assets" image-path="/assets/example.jpg" /> </template> <script> import PhotoEditor from 'vue-pesdk' import PesdkLicense from './myLicense.json' export default { components: { PhotoEditor }, license: JSON.stringify(PesdkLicense), // This is optional way to store non-reactive data in vue. mounted () { this.$pesdk.on('export', (result) => { console.log('User clicked export, resulting image / dataurl:') console.log(result) }) } }

Like mentioned earlier you can pass in all configuration options like here.

<template> <PhotoEditor asset-path="/assets" :license="$options.license" :options="options" image-path="/assets/example.jpg" /> </template> <script> import PhotoEditor from 'vue-pesdk' import PesdkLicense from './myLicense.json' export default { components: { PhotoEditor }, license: JSON.strigify(PesdkLicense), // This is optional. data: () => ({ options: { controlsOptions: { focus: { availableModes: ['radial', 'mirrored', 'linear', 'gaussian'] } } } }) }

Details changes for each release are documented in the CHANGELOG.md.

# install dependencies npm install # serve with hot reload at localhost:8080 npm run dev # build for production with minification npm run build # run unit tests npm run unit # run e2e tests npm run e2e # run all tests npm test

For a detailed explanation on how things work, check out the guide and docs for vue-loader.

Please see LICENSE for licensing details.

Please see CONTRIBUTORS for licensing details.

For support requests, please use our Support Desk.