Setting up Doka Image Editor with Vue

For a quick start use the Vue example project included in the product package as a guideline. It includes a normal, modal, and overlay editor example as well as an integration of vue-filepond and Doka Image Editor.

We can install the doka and vue-doka with npm by copying both of the dependencies to the 'local_modules' folder in the root of our Vue project and running the following command to install them locally.

npm install --save ./local_modules/vue-doka ./local_modules/doka

Now we can import the modules like we normally would and use the Vue <DokaImageEditor>, <DokaImageEditorModal>, and <DokaImageEditorOverlay> components.

To listen for DOM events we can use the Vue v-on directive. Please note that just as with the Doka Image Editor Custom Element events are prefixed with doka:, so instead of listen for load we listen for doka:load.

<DokaImageEditor @doka:load="handleImageLoad($event)"></DokaImageEditor>

Properties can be used as we would with the normal JavaScript version of the editor but should be prefixed with a colon ':', so src needs to be set as :src

<DokaImageEditor :src="image.jpeg"></DokaImageEditor>

Configuring the instance

With the editor logic installed we now need to load the plugins, the locale to use, and set the imageReader which is used to load images. Without these properties the editor won't load.

Doka Image Editor doesn't set any default values or labels, while this helps keep the library size as small as possible, it also means that we have to supply the default values and properties ourselves.

Let's start with registering the plugins using the setPlugins function. We'll then load the locale objects, finally we'll set the imageReader and the default plugin properties.

Registering plugins

Doka Image Editor uses plugins to render each util view. To get started we'll load the crop plugin, the finetune plugin, and the annotate plugin.

<template>
    <div></div>
</template>
<script>
    // Import functionalities from `doka`
    import {
        // The method used to register the plugins
        setPlugins,

        // The plugins we want to use
        plugin_crop,
        plugin_finetune,
        plugin_annotate,
    } from 'doka';

    // This registers the plugins with Doka Image Editor
    setPlugins(plugin_crop, plugin_finetune, plugin_annotate);

    export default {
        name: 'App',
    };
</script>
<style>
    @import '../node_modules/doka/doka.css';
</style>

Setting the locale object

Now we need to tell Doka Image Editor what labels and icons to use for all its UI controls. To do this we can import the English locale objects and assign them to the locale prop.

The Doka Image Editor module exports a core language file and a language file for each plugin. Currently only the English locale files are available in the package.

You can override the language files to show labels in a different language.

<template>
    <div>
        <div style="height: 480px">
            <DokaImageEditor :src="src" :locale="locale"> </DokaImageEditor>
        </div>
    </div>
</template>
<script>
    // Import functionalities from `doka`
    import {
        // The method used to register the plugins
        setPlugins,

        // The plugins we want to use
        plugin_crop,
        plugin_finetune,
        plugin_annotate,

        // The main UI and plugin locale objects
        locale_en_gb,
        plugin_crop_locale_en_gb,
        plugin_finetune_locale_en_gb,
        plugin_annotate_locale_en_gb,

        // Because we use the annotate plugin we also need
        // to import the markup editor locale
        markup_editor_locale_en_gb,
    } from 'doka';

    // Import the component from `vue-doka`
    import { DokaImageEditor } from 'vue-doka';

    // This registers the plugins with Doka Image Editor
    setPlugins(plugin_crop, plugin_finetune, plugin_annotate);

    export default {
        name: 'App',
        components: {
            DokaImageEditor,
        },
        data() {
            return {
                // set locale
                locale: {
                    ...locale_en_gb,
                    ...plugin_crop_locale_en_gb,
                    ...plugin_finetune_locale_en_gb,
                    ...plugin_annotate_locale_en_gb,
                    ...markup_editor_locale_en_gb,
                },

                // inline state
                src: 'my-image.jpeg',
            };
        },
    };
</script>
<style>
    @import '../node_modules/doka/doka.css';
</style>

Changing labels can be done by updating existing locale properties or by creating a custom locale object.

// Merge all the locale objects
const myLocale = {
    ...locale_en_gb,
    ...plugin_crop_locale_en_gb,
    ...plugin_finetune_locale_en_gb,
    ...plugin_annotate_locale_en_gb,
    ...markup_editor_locale_en_gb,
};

// Change label of export button to 'Save'
myLocale.labelButtonExport = 'Save';

Setting the imageReader

The imageReader property expects a list of instructions that tells Doka Image Editor how to load images.

A default image reader is exported by the JavaScript module. It can read resources of type File, Blob, Data URL, URL, HTMLCanvasElement, and HTMLImageElement. It will also automatically correct mobile photo orientation when needed.

By default Doka Image Editor can read images that are supported by the clients browser. In general these image formats are supported by all major browsers.

  • image/gif
  • image/png
  • image/jpeg
  • image/webp
  • image/bmp
  • image/svg

If needed we can use the preprocessImageFile hook to extend the default image reader and load more image formats (for example HEIC).

Let's set the default imageReader property.

<template>
    <div>
        <div style="height: 480px">
            <DokaImageEditor
                :src="src"
                :locale="locale"
                :imageReader="imageReader"
                @doka:load="handleLoad($event)"
            ></DokaImageEditor>
        </div>
    </div>
</template>
<script>
    // Import functionalities from `doka`
    import {
        // The method used to register the plugins
        setPlugins,

        // The plugins we want to use
        plugin_crop,
        plugin_finetune,
        plugin_annotate,

        // Import the default image reader
        createDefaultImageReader,

        // The main UI and plugin locale objects
        locale_en_gb,
        plugin_crop_locale_en_gb,
        plugin_finetune_locale_en_gb,
        plugin_annotate_locale_en_gb,

        // Because we use the annotate plugin we also need
        // to import the markup editor locale
        markup_editor_locale_en_gb,
    } from 'doka';

    // Import the component from `vue-doka`
    import { DokaImageEditor } from 'vue-doka';

    // This registers the plugins with Doka Image Editor
    setPlugins(plugin_crop, plugin_finetune, plugin_annotate);

    export default {
        name: 'App',
        components: {
            DokaImageEditor,
        },
        methods: {
            handleLoad: function (event) {
                console.log('load', event.detail);
            },
        },
        data() {
            return {
                // set default image reader
                imageReader: createDefaultImageReader(),

                // set locale
                locale: {
                    ...locale_en_gb,
                    ...plugin_crop_locale_en_gb,
                    ...plugin_finetune_locale_en_gb,
                    ...plugin_annotate_locale_en_gb,
                    ...markup_editor_locale_en_gb,
                },

                // inline state
                src: 'my-image.jpeg',
            };
        },
    };
</script>
<style>
    @import '../node_modules/doka/doka.css';
</style>

Doka Image Editor can now load images and render the user interface.

To show the default tools in the annotate view, and the finetune controls in the Finetune plugin we need to import the default properties.

Setting default plugin properties

The controls for the Finetune util as well as the Annotate util are still missing. That's because we have to set these manually.

We need to import markup_editor_defaults because the Annotate plugin uses the Markup Editor. And we import plugin_finetune_defaults to set the default color adjustment controls in the Finetune plugin.

Below we import both and assign the objects to the appendEditor options argument.

<template>
    <div>
        <div style="height: 480px">
            <DokaImageEditor
                v-bind="editorDefaultProps"
                :src="src"
                :locale="locale"
                :imageReader="imageReader"
                @doka:load="handleLoad($event)"
            ></DokaImageEditor>
        </div>
    </div>
</template>
<script>
    // Import functionalities from `doka`
    import {
        // The method used to register the plugins
        setPlugins,

        // The plugins we want to use
        plugin_crop,
        plugin_finetune,
        plugin_annotate,

        // Import the default image reader
        createDefaultImageReader,

        // The main UI and plugin locale objects
        locale_en_gb,
        plugin_crop_locale_en_gb,
        plugin_finetune_locale_en_gb,
        plugin_annotate_locale_en_gb,

        // Because we use the annotate plugin we also need
        // to import the markup editor locale
        markup_editor_locale_en_gb,

        // Import the default properties
        markup_editor_defaults,
        plugin_finetune_defaults,
    } from 'doka';

    // Import the component from `vue-doka`
    import { DokaImageEditor } from 'vue-doka';

    // This registers the plugins with Doka Image Editor
    setPlugins(plugin_crop, plugin_finetune, plugin_annotate);

    export default {
        name: 'App',
        components: {
            DokaImageEditor,
        },
        methods: {
            handleLoad: function (event) {
                console.log('load', event.detail);
            },
        },
        data() {
            return {
                // image
                src: 'my-image.jpeg',

                // default image reader
                imageReader: createDefaultImageReader(),

                // set locale
                locale: {
                    ...locale_en_gb,
                    ...plugin_crop_locale_en_gb,
                    ...plugin_finetune_locale_en_gb,
                    ...plugin_annotate_locale_en_gb,
                    ...markup_editor_locale_en_gb,
                },

                // set default props
                editorDefaultProps: {
                    // Set Markup Editor defaults
                    ...markup_editor_defaults,

                    // Set Finetune plugin defaults
                    ...plugin_finetune_defaults,
                },
            };
        },
    };
</script>
<style>
    @import '../node_modules/doka/doka.css';
</style>

Next steps

With the editor set up, we can continue to configure the editor to our liking with the available instance properties