TOAST UI ImageEditor Vue Wrapper has been managed separately from the TOAST UI ImageEditor repository. As a result of the distribution of these issues, we decided to deprecate each wrapper repository and manage repository as a mono-repo from the TOAST UI ImageEditor repository.
From now on, please submit issues or contributing related to TOAST UI Vue Wrapper to TOAST UI ImageEditor repository. Thank you🙂.
This is Vue component wrapping TOAST UI Image Editor.
- Collect statistics on the use of open source
- Install
- Usage
- Pull Request Steps
- Documents
- Contributing
- License
TOAST UI ImageEditor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI ImageEditor is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following usageStatistics option when creating the instance.
const options = {
...
usageStatistics: false
}
const imageEditor = new tui.ImageEditor('#tui-image-editor-container', options);Or, include tui-code-snippet(v1.4.0 or later) and then immediately write the options as follows:
tui.usageStatistics = false;npm install --save @toast-ui/vue-image-editorIf you install other packages, you may lose dependency on fabric. You need to reinstall the fabric.
npm install --no-save --no-optional fabric@~1.6.7
-
Using namespace
const ImageEditor = toastui.ImageEditor;
-
Using module
// es modules import {ImageEditor} from '@toast-ui/vue-image-editor'; // commonjs require const {ImageEditor} = require('@toast-ui/vue-image-editor');
-
Using
<script>If you just add javascript file to your html, you use
toastui-vue-image-editor.jsdownloaded. Inserttoastui-vue-image-editor.jswithvuein your html like this:<script src="https://cdn.jsdelivr.net/npm/vue"></script> <script src="path/to/toastui-vue-image-editor.js"></script>
-
Using only Vue wrapper component (Single File Component)
toastui-vue-image-editor.jshas all of the tui.ImageEditor. If you only need vue wrapper component, you can use@toast-ui/vue-image-editor/src/ImageEditor.vuelike this:import ImageEditor from '@toast-ui/vue-image-editor/src/ImageEditor.vue'
First insert <tui-image-editor> in the template or html. includeUi and options props are required.
<tui-image-editor :include-ui="useDefaultUI" :options="options"></tui-image-editor>Load ImageEditor component and then add it to the components in your component or Vue instance.
import {ImageEditor} from '@toast-ui/vue-image-editor';
export default {
components: {
'tui-image-editor': ImageEditor
},
data() {
return {
useDefaultUI: true,
options: { // for tui-image-editor component's "options" prop
cssMaxWidth: 700,
cssMaxHeight: 500
}
};
}
}You can use includeUi and options props. Example of each props is in the Getting Started.
-
includeUiType Required Default Boolean X true This prop can contained the
includeUIprop in the option. You can see the default UI. -
optionsType Required Default Object X { cssMaxWidth: 700, cssMaxHeight: 500 } You can configurate your image editor using
optionsprop. For more information which properties can be set inoptions, see options of tui.image-editor.
- addText: The event when 'TEXT' drawing mode is enabled and click non-object area.
- mousedown: The mouse down event with position x, y on canvas
- objectActivated: The event when object is selected(aka activated).
- objectMoved: The event when object is moved.
- objectScaled: The event when scale factor is changed.
- redoStackChanged: Redo stack changed event
- textEditing: The event which starts to edit text object.
- undoStackChanged: Undo stack changed event
<tui-image-editor ...
@addText="onAddText"
@objectMoved="onObjectMoved">
</tui-image-editor>...
methods: {
onAddText(pos) {
...
},
onObjectMoved(props) {
...
}
}
...For more information such as the parameters of each event, see event of tui.image-editor.
For use method, first you need to assign ref attribute of element like this:
<tui-image-editor ref="tuiImageEditor" :options="options"></tui-image-editor>After then you can use methods through this.$refs. We provide getRootElement and invoke methods.
-
getRootElementYou can get root element of image editor using this method.
this.$refs.tuiImageEditor.getRootElement();
-
invokeIf you want to more manipulate the ImageEditor, you can use
invokemethod to call the method of tui.ImageEditor. First argument ofinvokeis name of the method and second argument is parameters of the method. To find out what kind of methods are available, see method of tui.ImageEditor.const drawingMode = this.$refs.tuiImageEditor.invoke('getDrawingMode'); this.$refs.tuiImageEditor.invoke('loadImageFromURL', './sampleImage.png', 'My sample image'); this.$refs.tuiImageEditor.invoke('startDrawingMode', 'FREE_DRAWING', { width: 10, color: 'rgba(255, 0, 0, 0.5)' });
TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.
Fork develop branch into your personal repository.
Clone it to local computer. Install node modules.
Before starting development, you should check to haveany errors.
$ git clone https://github.com/{your-personal-repo}/[[repo name]].git
$ cd [[repo name]]
$ npm installLet's start development!
Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!
For more information on PR's step, please see links of Contributing section.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent