Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@toast-ui/vue-editor
Advanced tools
Readme
This is Vue component wrapping TOAST UI Editor.
Vue Wrapper of TOAST UI Editor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Editor 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
options when declare Vue Wrapper component.
const options = {
...
usageStatistics: false
}
npm install --save @toast-ui/vue-editor
You can use Toast UI Editor for Vue as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import toastui-editor.css
from @toast-ui/editor
in the script.
import '@toast-ui/editor/dist/toastui-editor.css';
import { Editor } from '@toast-ui/vue-editor';
require('@toast-ui/editor/dist/toastui-editor.css');
const { Editor } = require('@toast-ui/vue-editor');
First implement <editor/>
in the template.
<template>
<editor />
</template>
And then add Editor
to the components
in your component or Vue instance like this:
import '@toast-ui/editor/dist/toastui-editor.css';
import { Editor } from '@toast-ui/vue-editor';
export default {
components: {
editor: Editor
}
};
or
import '@toast-ui/editor/dist/toastui-editor.css';
import { Editor } from '@toast-ui/vue-editor';
new Vue({
el: '#app',
components: {
editor: Editor
}
});
Name | Type | Default | Description |
---|---|---|---|
initialValue | String | '' | Editor's initial value . |
initialEditType | String | 'markdown' | Initial editor type (markdown, wysiwyg). |
options | Object | following defaultOptions | Options of tui.editor. This is for initailize tui.editor. |
height | String | '300px' | This prop can control the height of the editor. |
previewStyle | String | 'vertical' | Markdown editor's preview style (tab, vertical). |
const defaultOptions = {
minHeight: '200px',
language: 'en-US',
useCommandShortcut: true,
usageStatistics: true,
hideModeSwitch: false,
toolbarItems: [
['heading', 'bold', 'italic', 'strike'],
['hr', 'quote'],
['ul', 'ol', 'task', 'indent', 'outdent'],
['table', 'image', 'link'],
['code', 'codeblock'],
['scrollSync'],
]
};
<template>
<editor
:initialValue="editorText"
:options="editorOptions"
height="500px"
initialEditType="wysiwyg"
previewStyle="vertical"
/>
</template>
<script>
import '@toast-ui/editor/dist/toastui-editor.css';
import { Editor } from '@toast-ui/vue-editor';
export default {
components: {
editor: Editor
},
data() {
return {
editorText: 'This is initialValue.',
editorOptions: {
hideModeSwitch: true
}
};
}
};
</script>
If you want to more manipulate the Editor, you can use invoke
method to call the method of toastui.editor. For more information of method, see instance methods of TOAST UI Editor.
First, you need to assign ref
attribute of <editor/>
and then you can use invoke
method through this.$refs
like this:
<template>
<editor ref="toastuiEditor" />
</template>
<script>
import '@toast-ui/editor/dist/toastui-editor.css';
import { Editor } from '@toast-ui/vue-editor';
export default {
components: {
editor: Editor
},
methods: {
scroll() {
this.$refs.toastuiEditor.invoke('setScrollTop', 10);
},
moveTop() {
this.$refs.toastuiEditor.invoke('moveCursorToStart');
},
getHTML() {
let html = this.$refs.toastuiEditor.invoke('getHTML');
}
}
};
</script>
<template>
<editor
@load="onEditorLoad"
@focus="onEditorFocus"
@blur="onEditorBlur"
@change="onEditorChange"
@caretChange="onEditorCaretChange"
/>
</template>
<script>
import { Editor } from '@toast-ui/vue-editor';
export default {
components: {
editor: Editor
},
methods: {
onEditorLoad() {
// implement your code
},
onEditorFocus() {
// implement your code
},
onEditorBlur() {
// implement your code
},
onEditorChange() {
// implement your code
},
onEditorCaretChange() {
// implement your code
}
}
};
</script>
import '@toast-ui/editor/dist/toastui-editor-viewer.css';
import { Viewer } from '@toast-ui/vue-editor';
require('@toast-ui/editor/dist/toastui-editor-viewer.css');
const { Viewer } = require('@toast-ui/vue-editor');
First implement <viewer />
in the template.
<template>
<viewer />
</template>
And then add Viewer
to the components
in your component or Vue instance like this:
import '@toast-ui/editor/dist/toastui-editor-viewer.css';
import { Viewer } from '@toast-ui/vue-editor';
export default {
components: {
viewer: Viewer
}
};
or
import '@toast-ui/editor/dist/toastui-editor-viewer.css';
import { Viewer } from '@toast-ui/vue-editor';
new Vue({
el: '#app',
components: {
viewer: Viewer
}
});
Name | Type | Default | Description |
---|---|---|---|
initialValue | String | '' | Viewer's initial value |
height | String | '300px' | This prop can control the height of the viewer. |
options | Object | above defaultOptions | Options of tui.editor. This is for initailize tui.editor. |
<template>
<viewer :initialValue="viewerText" height="500px" />
</template>
<script>
import '@toast-ui/editor/dist/toastui-editor-viewer.css';
import { Viewer } from '@toast-ui/vue-editor';
export default {
components: {
viewer: Viewer
},
data() {
return {
viewerText: '# This is Viewer.\n Hello World.'
};
}
};
</script>
FAQs
TOAST UI Editor for Vue
The npm package @toast-ui/vue-editor receives a total of 7,297 weekly downloads. As such, @toast-ui/vue-editor popularity was classified as popular.
We found that @toast-ui/vue-editor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.